com.exalead.indexing.analysis.v10

Class CategoryContentTarget

java.lang.Object

com.exalead.indexing.analysis.v10.Target

com.exalead.indexing.analysis.v10.ContentTarget

com.exalead.indexing.analysis.v10.CategoryContentTarget

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

DateCategoryContentTarget

public class CategoryContentTarget
extends ContentTarget
implements com.exalead.util.Checkable, java.io.Serializable

CategoryContentTarget is used to map a DocumentChunk to a category.
A Category Path is created for each DocumentChunk processed.
The textual content of the DocumentChunk is used to build a Category Path.
'indexField' should be a category field (usually called 'categories' or 'security').

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	appendContextNameToRoot
boolean	categoryAppend
java.lang.String	categoryRoot
boolean	cleanupContent
static boolean	DEFAULT_APPEND_CONTEXT_NAME_TO_ROOT
static boolean	DEFAULT_CATEGORY_APPEND
static boolean	DEFAULT_CLEANUP_CONTENT
static boolean	DEFAULT_DETECT_TITLE
static java.lang.String	DEFAULT_FORM
static boolean	DEFAULT_RETRIEVABLE
boolean	detectTitle
java.lang.String	form
boolean	retrievable

Fields inherited from class com.exalead.indexing.analysis.v10.ContentTarget

DEFAULT_RANK_BOOST, forcedRank, indexField, rankBoost

Constructor Summary

Constructors

Constructor and Description
CategoryContentTarget()
CategoryContentTarget(CategoryContentTarget o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CategoryContentTarget.
static CategoryContentTarget	fromString(java.lang.String s) String representation of this CategoryContentTarget.
java.lang.String	getCategoryRoot() Builds the category path.
java.lang.String	getForm() The form of the word to be used to build the category path. enum(exact,normalized)
boolean	isAppendContextNameToRoot() Appends the context name between the root and the value.
boolean	isCategoryAppend() Appends the textual content of the DocumentChunk to the category root. If false, only the category root will be used.
boolean	isCleanupContent() If true: Removes trailing and leading unicode-spaces. Replaces all sequences of unicode-space characters by a single 'space' character. Does not map to the category in append mode if the DocumentChunk does not contain at least one unicode alpha-numerical character.
boolean	isDetectTitle() Detect words set after # in path and use them as title
boolean	isRetrievable() Stores the category path, which enables display and navigation by category path. If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks).
CategoryContentTarget	makeCopy() Creates and returns a deep copy of this CategoryContentTarget.
static CategoryContentTarget	readFrom(java.io.InputStream is) Read this CategoryContentTarget from an XML fragment.
void	setAppendContextNameToRoot(boolean appendContextNameToRoot) Appends the context name between the root and the value.
void	setCategoryAppend(boolean categoryAppend) Appends the textual content of the DocumentChunk to the category root. If false, only the category root will be used.
void	setCategoryRoot(java.lang.String categoryRoot) Builds the category path.
void	setCleanupContent(boolean cleanupContent) If true: Removes trailing and leading unicode-spaces. Replaces all sequences of unicode-space characters by a single 'space' character. Does not map to the category in append mode if the DocumentChunk does not contain at least one unicode alpha-numerical character.
void	setDetectTitle(boolean detectTitle) Detect words set after # in path and use them as title
void	setForm(java.lang.String form) The form of the word to be used to build the category path. enum(exact,normalized)
void	setRetrievable(boolean retrievable) Stores the category path, which enables display and navigation by category path. If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks).
java.lang.String	toString() String representation of this CategoryContentTarget.
CategoryContentTarget	withAppendContextNameToRoot(boolean appendContextNameToRoot)
CategoryContentTarget	withAppendContextNameToRoot(java.lang.Boolean appendContextNameToRoot)
CategoryContentTarget	withCategoryAppend(boolean categoryAppend)
CategoryContentTarget	withCategoryAppend(java.lang.Boolean categoryAppend)
CategoryContentTarget	withCategoryRoot(java.lang.String categoryRoot)
CategoryContentTarget	withCleanupContent(boolean cleanupContent)
CategoryContentTarget	withCleanupContent(java.lang.Boolean cleanupContent)
CategoryContentTarget	withDetectTitle(boolean detectTitle)
CategoryContentTarget	withDetectTitle(java.lang.Boolean detectTitle)
CategoryContentTarget	withForcedRank(long forcedRank)
CategoryContentTarget	withForcedRank(java.lang.Long forcedRank)
CategoryContentTarget	withForm(java.lang.String form)
CategoryContentTarget	withIndexField(java.lang.String indexField)
CategoryContentTarget	withRankBoost(long rankBoost)
CategoryContentTarget	withRankBoost(java.lang.Long rankBoost)
CategoryContentTarget	withRetrievable(boolean retrievable)
CategoryContentTarget	withRetrievable(java.lang.Boolean retrievable)
void	writeTo(java.io.OutputStream os) Write this CategoryContentTarget as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.ContentTarget

getForcedRank, getIndexField, getRankBoost, setForcedRank, setIndexField, setRankBoost

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

categoryRoot

public java.lang.String categoryRoot

categoryAppend

public boolean categoryAppend

DEFAULT_CATEGORY_APPEND

public static final boolean DEFAULT_CATEGORY_APPEND

See Also:

Constant Field Values

appendContextNameToRoot

public boolean appendContextNameToRoot

DEFAULT_APPEND_CONTEXT_NAME_TO_ROOT

public static final boolean DEFAULT_APPEND_CONTEXT_NAME_TO_ROOT

See Also:

Constant Field Values

form

public java.lang.String form

DEFAULT_FORM

public static final java.lang.String DEFAULT_FORM

See Also:

Constant Field Values

retrievable

public boolean retrievable

DEFAULT_RETRIEVABLE

public static final boolean DEFAULT_RETRIEVABLE

See Also:

Constant Field Values

cleanupContent

public boolean cleanupContent

DEFAULT_CLEANUP_CONTENT

public static final boolean DEFAULT_CLEANUP_CONTENT

See Also:

Constant Field Values

detectTitle

public boolean detectTitle

DEFAULT_DETECT_TITLE

public static final boolean DEFAULT_DETECT_TITLE

See Also:

Constant Field Values

Constructor Detail

CategoryContentTarget

public CategoryContentTarget()

CategoryContentTarget

public CategoryContentTarget(CategoryContentTarget o)

Copy constructor

Method Detail

withIndexField

public CategoryContentTarget withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class ContentTarget

withForcedRank

public CategoryContentTarget withForcedRank(long forcedRank)

Overrides:

withForcedRank in class ContentTarget

withForcedRank

public CategoryContentTarget withForcedRank(java.lang.Long forcedRank)

Overrides:

withForcedRank in class ContentTarget

withRankBoost

public CategoryContentTarget withRankBoost(long rankBoost)

Overrides:

withRankBoost in class ContentTarget

withRankBoost

public CategoryContentTarget withRankBoost(java.lang.Long rankBoost)

Overrides:

withRankBoost in class ContentTarget

setCategoryRoot

public void setCategoryRoot(java.lang.String categoryRoot)

Builds the category path.

getCategoryRoot

public java.lang.String getCategoryRoot()

Builds the category path.

withCategoryRoot

public CategoryContentTarget withCategoryRoot(java.lang.String categoryRoot)

setCategoryAppend

public void setCategoryAppend(boolean categoryAppend)

Appends the textual content of the DocumentChunk to the category root.
If false, only the category root will be used.

isCategoryAppend

public boolean isCategoryAppend()

Appends the textual content of the DocumentChunk to the category root.
If false, only the category root will be used.

withCategoryAppend

public CategoryContentTarget withCategoryAppend(boolean categoryAppend)

withCategoryAppend

public CategoryContentTarget withCategoryAppend(java.lang.Boolean categoryAppend)

setAppendContextNameToRoot

public void setAppendContextNameToRoot(boolean appendContextNameToRoot)

Appends the context name between the root and the value.

isAppendContextNameToRoot

public boolean isAppendContextNameToRoot()

Appends the context name between the root and the value.

withAppendContextNameToRoot

public CategoryContentTarget withAppendContextNameToRoot(boolean appendContextNameToRoot)

withAppendContextNameToRoot

public CategoryContentTarget withAppendContextNameToRoot(java.lang.Boolean appendContextNameToRoot)

setForm

public void setForm(java.lang.String form)

The form of the word to be used to build the category path.
enum(exact,normalized)

getForm

public java.lang.String getForm()

The form of the word to be used to build the category path.
enum(exact,normalized)

withForm

public CategoryContentTarget withForm(java.lang.String form)

setRetrievable

public void setRetrievable(boolean retrievable)

Stores the category path, which enables display and navigation by category path.
If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks).

isRetrievable

public boolean isRetrievable()

Stores the category path, which enables display and navigation by category path.
If false, we only index the SemanticAnnotation (Advanced usage - langdate hacks).

withRetrievable

public CategoryContentTarget withRetrievable(boolean retrievable)

withRetrievable

public CategoryContentTarget withRetrievable(java.lang.Boolean retrievable)

setCleanupContent

public void setCleanupContent(boolean cleanupContent)

If true:

• Removes trailing and leading unicode-spaces.
• Replaces all sequences of unicode-space characters by a single 'space' character.
• Does not map to the category in append mode if the DocumentChunk does not contain at least one unicode alpha-numerical character.

isCleanupContent

public boolean isCleanupContent()

If true:

• Removes trailing and leading unicode-spaces.
• Replaces all sequences of unicode-space characters by a single 'space' character.
• Does not map to the category in append mode if the DocumentChunk does not contain at least one unicode alpha-numerical character.

withCleanupContent

public CategoryContentTarget withCleanupContent(boolean cleanupContent)

withCleanupContent

public CategoryContentTarget withCleanupContent(java.lang.Boolean cleanupContent)

setDetectTitle

public void setDetectTitle(boolean detectTitle)

Detect words set after # in path and use them as title

isDetectTitle

public boolean isDetectTitle()

Detect words set after # in path and use them as title

withDetectTitle

public CategoryContentTarget withDetectTitle(boolean detectTitle)

withDetectTitle

public CategoryContentTarget withDetectTitle(java.lang.Boolean detectTitle)

makeCopy

public CategoryContentTarget makeCopy()

Creates and returns a deep copy of this CategoryContentTarget.

Overrides:

makeCopy in class ContentTarget

readFrom

public static CategoryContentTarget readFrom(java.io.InputStream is)
                                      throws javax.xml.bind.JAXBException

Read this CategoryContentTarget from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this CategoryContentTarget as an XML fragment

Overrides:

writeTo in class ContentTarget

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static CategoryContentTarget fromString(java.lang.String s)
                                        throws javax.xml.bind.JAXBException,
                                               java.io.UnsupportedEncodingException

String representation of this CategoryContentTarget.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CategoryContentTarget.

Overrides:

toString in class ContentTarget

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this CategoryContentTarget.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ContentTarget

Throws:

com.exalead.util.TypedException