StandardContentTarget (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.indexing.analysis.v10.Target
- - com.exalead.indexing.analysis.v10.ContentTarget
  - - com.exalead.indexing.analysis.v10.StandardContentTarget

All Implemented Interfaces:

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

Direct Known Subclasses:

DateContentTarget
```
public class StandardContentTarget
extends ContentTarget
implements com.exalead.util.Checkable, java.io.Serializable
```
A StandardContentTarget is used to populate a textual, numerical or date index field, with the content of a DocumentChunk.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`addBreakBetweenChunks`
`boolean`	`addStartEnd`
`java.util.List<DecreaseRankOnAnnotation>`	`decreaseRankOnAnnotation`
`static boolean`	`DEFAULT_ADD_BREAK_BETWEEN_CHUNKS`
`static boolean`	`DEFAULT_ADD_START_END`
`static boolean`	`DEFAULT_INDEX_EXACT`
`static boolean`	`DEFAULT_INDEX_LOWERCASE`
`static boolean`	`DEFAULT_INDEX_NORMALIZED`
`static boolean`	`DEFAULT_INDEX_PREFIXES`
`static boolean`	`DEFAULT_INDEX_SEPARATORS`
`static boolean`	`DEFAULT_INDEX_SUBSTRINGS`
`static boolean`	`DEFAULT_INDEX_SUFFIXES`
`static int`	`DEFAULT_MAX_PREFIX_LENGTH`
`static int`	`DEFAULT_MAX_SUFFIX_LENGTH`
`static boolean`	`DEFAULT_PREFIX_WITH_CONTEXT`
`static int`	`DEFAULT_PREFIXES_SCORE`
`static boolean`	`DEFAULT_RETRIEVABLE`
`static boolean`	`DEFAULT_SEARCHABLE`
`static int`	`DEFAULT_SUBSTRINGS_SCORE`
`static int`	`DEFAULT_SUFFIXES_SCORE`
`java.util.List<IncreaseRankOnAnnotation>`	`increaseRankOnAnnotation`
`boolean`	`indexExact`
`boolean`	`indexLowercase`
`boolean`	`indexNormalized`
`boolean`	`indexPrefixes`
`boolean`	`indexSeparators`
`boolean`	`indexSubstrings`
`boolean`	`indexSuffixes`
`int`	`maxPrefixLength`
`int`	`maxSuffixLength`
`int`	`prefixesScore`
`boolean`	`prefixWithContext`
`java.util.List<RankOnAnnotation>`	`rankOnAnnotation`
`boolean`	`retrievable`
`java.lang.String`	`retrieveField`
`boolean`	`searchable`
`int`	`substringsScore`
`int`	`suffixesScore`

Fields inherited from class com.exalead.indexing.analysis.v10.ContentTarget
DEFAULT_RANK_BOOST, forcedRank, indexField, rankBoost

Constructor Summary

Constructors
Constructor and Description

StandardContentTarget()

StandardContentTarget(StandardContentTarget o)
Copy constructor

Constructors
Constructor and Description
`StandardContentTarget()`
`StandardContentTarget(StandardContentTarget o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this StandardContentTarget.
`static StandardContentTarget`	`fromString(java.lang.String s)` String representation of this StandardContentTarget.
`java.util.List<DecreaseRankOnAnnotation>`	`getDecreaseRankOnAnnotation()` List of DecreaseRankOnAnnotation
`java.util.List<IncreaseRankOnAnnotation>`	`getIncreaseRankOnAnnotation()` List of IncreaseRankOnAnnotation
`int`	`getMaxPrefixLength()` Maximum length of the extracted prefixes.
`int`	`getMaxSuffixLength()` Maximum length of the extracted suffixes.
`int`	`getPrefixesScore()` Score given to words' prefixes.
`java.util.List<RankOnAnnotation>`	`getRankOnAnnotation()` List of RankOnAnnotation
`java.lang.String`	`getRetrieveField()` The index field in which the content will be stored. If null, the content will be put in 'indexField'.
`int`	`getSubstringsScore()` Score given to extracted substrings.
`int`	`getSuffixesScore()` Score given to words' prefixes.
`boolean`	`isAddBreakBetweenChunks()` Enables the introduction of a break between document chunks by the indexer. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
`boolean`	`isAddStartEnd()` Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content. Only valid if Chunk is mapped with semantic=true. This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__)
`boolean`	`isIndexExact()` Enables the indexing of the exact (non-normalized) form of each token.
`boolean`	`isIndexLowercase()` Enables the indexing of the lowercase (non-normalized) form of each token.
`boolean`	`isIndexNormalized()` Enables the indexing of the normalized form of the word.
`boolean`	`isIndexPrefixes()` Enables the indexing of all prefixes for each word with a score = prefixScore. The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig.
`boolean`	`isIndexSeparators()` Enables the indexing of the index standard separators. Indexed standard separators are: paragraph, sentence and page. Standard separators indexing is required for the SPLIT operator to work with these separators.
`boolean`	`isIndexSubstrings()` Enables the indexing of all substrings for each word with a score = substringScore. The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig.
`boolean`	`isIndexSuffixes()` Enables the indexing of all suffixes for each word with a score = suffixScore. The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig.
`boolean`	`isPrefixWithContext()` Enables prefixing of all words in inverted lists by 'contextName#'.
`boolean`	`isRetrievable()` Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved. For numerical values, retrievability allows you to sort results by field.
`boolean`	`isSearchable()` Marks the content of the DocumentChunk as indexed and searchable.
`StandardContentTarget`	`makeCopy()` Creates and returns a deep copy of this StandardContentTarget.
`static StandardContentTarget`	`readFrom(java.io.InputStream is)` Read this StandardContentTarget from an XML fragment.
`void`	`setAddBreakBetweenChunks(boolean addBreakBetweenChunks)` Enables the introduction of a break between document chunks by the indexer. This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator. For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
`void`	`setAddStartEnd(boolean addStartEnd)` Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content. Only valid if Chunk is mapped with semantic=true. This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__)
`void`	`setIndexExact(boolean indexExact)` Enables the indexing of the exact (non-normalized) form of each token.
`void`	`setIndexLowercase(boolean indexLowercase)` Enables the indexing of the lowercase (non-normalized) form of each token.
`void`	`setIndexNormalized(boolean indexNormalized)` Enables the indexing of the normalized form of the word.
`void`	`setIndexPrefixes(boolean indexPrefixes)` Enables the indexing of all prefixes for each word with a score = prefixScore. The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig.
`void`	`setIndexSeparators(boolean indexSeparators)` Enables the indexing of the index standard separators. Indexed standard separators are: paragraph, sentence and page. Standard separators indexing is required for the SPLIT operator to work with these separators.
`void`	`setIndexSubstrings(boolean indexSubstrings)` Enables the indexing of all substrings for each word with a score = substringScore. The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig.
`void`	`setIndexSuffixes(boolean indexSuffixes)` Enables the indexing of all suffixes for each word with a score = suffixScore. The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig.
`void`	`setMaxPrefixLength(int maxPrefixLength)` Maximum length of the extracted prefixes.
`void`	`setMaxSuffixLength(int maxSuffixLength)` Maximum length of the extracted suffixes.
`void`	`setPrefixesScore(int prefixesScore)` Score given to words' prefixes.
`void`	`setPrefixWithContext(boolean prefixWithContext)` Enables prefixing of all words in inverted lists by 'contextName#'.
`void`	`setRetrievable(boolean retrievable)` Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved. For numerical values, retrievability allows you to sort results by field.
`void`	`setRetrieveField(java.lang.String retrieveField)` The index field in which the content will be stored. If null, the content will be put in 'indexField'.
`void`	`setSearchable(boolean searchable)` Marks the content of the DocumentChunk as indexed and searchable.
`void`	`setSubstringsScore(int substringsScore)` Score given to extracted substrings.
`void`	`setSuffixesScore(int suffixesScore)` Score given to words' prefixes.
`java.lang.String`	`toString()` String representation of this StandardContentTarget.
`StandardContentTarget`	`withAddBreakBetweenChunks(boolean addBreakBetweenChunks)`
`StandardContentTarget`	`withAddBreakBetweenChunks(java.lang.Boolean addBreakBetweenChunks)`
`StandardContentTarget`	`withAddStartEnd(boolean addStartEnd)`
`StandardContentTarget`	`withAddStartEnd(java.lang.Boolean addStartEnd)`
`StandardContentTarget`	`withDecreaseRankOnAnnotation(java.util.Collection<DecreaseRankOnAnnotation> __values)`
`StandardContentTarget`	`withDecreaseRankOnAnnotation(DecreaseRankOnAnnotation... __values)` List of DecreaseRankOnAnnotation
`StandardContentTarget`	`withForcedRank(long forcedRank)`
`StandardContentTarget`	`withForcedRank(java.lang.Long forcedRank)`
`StandardContentTarget`	`withIncreaseRankOnAnnotation(java.util.Collection<IncreaseRankOnAnnotation> __values)`
`StandardContentTarget`	`withIncreaseRankOnAnnotation(IncreaseRankOnAnnotation... __values)` List of IncreaseRankOnAnnotation
`StandardContentTarget`	`withIndexExact(boolean indexExact)`
`StandardContentTarget`	`withIndexExact(java.lang.Boolean indexExact)`
`StandardContentTarget`	`withIndexField(java.lang.String indexField)`
`StandardContentTarget`	`withIndexLowercase(boolean indexLowercase)`
`StandardContentTarget`	`withIndexLowercase(java.lang.Boolean indexLowercase)`
`StandardContentTarget`	`withIndexNormalized(boolean indexNormalized)`
`StandardContentTarget`	`withIndexNormalized(java.lang.Boolean indexNormalized)`
`StandardContentTarget`	`withIndexPrefixes(boolean indexPrefixes)`
`StandardContentTarget`	`withIndexPrefixes(java.lang.Boolean indexPrefixes)`
`StandardContentTarget`	`withIndexSeparators(boolean indexSeparators)`
`StandardContentTarget`	`withIndexSeparators(java.lang.Boolean indexSeparators)`
`StandardContentTarget`	`withIndexSubstrings(boolean indexSubstrings)`
`StandardContentTarget`	`withIndexSubstrings(java.lang.Boolean indexSubstrings)`
`StandardContentTarget`	`withIndexSuffixes(boolean indexSuffixes)`
`StandardContentTarget`	`withIndexSuffixes(java.lang.Boolean indexSuffixes)`
`StandardContentTarget`	`withMaxPrefixLength(int maxPrefixLength)`
`StandardContentTarget`	`withMaxPrefixLength(java.lang.Integer maxPrefixLength)`
`StandardContentTarget`	`withMaxSuffixLength(int maxSuffixLength)`
`StandardContentTarget`	`withMaxSuffixLength(java.lang.Integer maxSuffixLength)`
`StandardContentTarget`	`withPrefixesScore(int prefixesScore)`
`StandardContentTarget`	`withPrefixesScore(java.lang.Integer prefixesScore)`
`StandardContentTarget`	`withPrefixWithContext(boolean prefixWithContext)`
`StandardContentTarget`	`withPrefixWithContext(java.lang.Boolean prefixWithContext)`
`StandardContentTarget`	`withRankBoost(long rankBoost)`
`StandardContentTarget`	`withRankBoost(java.lang.Long rankBoost)`
`StandardContentTarget`	`withRankOnAnnotation(java.util.Collection<RankOnAnnotation> __values)`
`StandardContentTarget`	`withRankOnAnnotation(RankOnAnnotation... __values)` List of RankOnAnnotation
`StandardContentTarget`	`withRetrievable(boolean retrievable)`
`StandardContentTarget`	`withRetrievable(java.lang.Boolean retrievable)`
`StandardContentTarget`	`withRetrieveField(java.lang.String retrieveField)`
`StandardContentTarget`	`withSearchable(boolean searchable)`
`StandardContentTarget`	`withSearchable(java.lang.Boolean searchable)`
`StandardContentTarget`	`withSubstringsScore(int substringsScore)`
`StandardContentTarget`	`withSubstringsScore(java.lang.Integer substringsScore)`
`StandardContentTarget`	`withSuffixesScore(int suffixesScore)`
`StandardContentTarget`	`withSuffixesScore(java.lang.Integer suffixesScore)`
`void`	`writeTo(java.io.OutputStream os)` Write this StandardContentTarget 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
  - rankOnAnnotation
```
public java.util.List<RankOnAnnotation> rankOnAnnotation
```
  - increaseRankOnAnnotation
```
public java.util.List<IncreaseRankOnAnnotation> increaseRankOnAnnotation
```
  - decreaseRankOnAnnotation
```
public java.util.List<DecreaseRankOnAnnotation> decreaseRankOnAnnotation
```
  - prefixWithContext
```
public boolean prefixWithContext
```
  - DEFAULT_PREFIX_WITH_CONTEXT
```
public static final boolean DEFAULT_PREFIX_WITH_CONTEXT
```
    See Also:
    
    Constant Field Values
  - addStartEnd
```
public boolean addStartEnd
```
  - DEFAULT_ADD_START_END
```
public static final boolean DEFAULT_ADD_START_END
```
    See Also:
    
    Constant Field Values
  - indexPrefixes
```
public boolean indexPrefixes
```
  - DEFAULT_INDEX_PREFIXES
```
public static final boolean DEFAULT_INDEX_PREFIXES
```
    See Also:
    
    Constant Field Values
  - prefixesScore
```
public int prefixesScore
```
  - DEFAULT_PREFIXES_SCORE
```
public static final int DEFAULT_PREFIXES_SCORE
```
    See Also:
    
    Constant Field Values
  - maxPrefixLength
```
public int maxPrefixLength
```
  - DEFAULT_MAX_PREFIX_LENGTH
```
public static final int DEFAULT_MAX_PREFIX_LENGTH
```
    See Also:
    
    Constant Field Values
  - indexSuffixes
```
public boolean indexSuffixes
```
  - DEFAULT_INDEX_SUFFIXES
```
public static final boolean DEFAULT_INDEX_SUFFIXES
```
    See Also:
    
    Constant Field Values
  - suffixesScore
```
public int suffixesScore
```
  - DEFAULT_SUFFIXES_SCORE
```
public static final int DEFAULT_SUFFIXES_SCORE
```
    See Also:
    
    Constant Field Values
  - maxSuffixLength
```
public int maxSuffixLength
```
  - DEFAULT_MAX_SUFFIX_LENGTH
```
public static final int DEFAULT_MAX_SUFFIX_LENGTH
```
    See Also:
    
    Constant Field Values
  - indexSubstrings
```
public boolean indexSubstrings
```
  - DEFAULT_INDEX_SUBSTRINGS
```
public static final boolean DEFAULT_INDEX_SUBSTRINGS
```
    See Also:
    
    Constant Field Values
  - substringsScore
```
public int substringsScore
```
  - DEFAULT_SUBSTRINGS_SCORE
```
public static final int DEFAULT_SUBSTRINGS_SCORE
```
    See Also:
    
    Constant Field Values
  - searchable
```
public boolean searchable
```
  - DEFAULT_SEARCHABLE
```
public static final boolean DEFAULT_SEARCHABLE
```
    See Also:
    
    Constant Field Values
  - retrievable
```
public boolean retrievable
```
  - DEFAULT_RETRIEVABLE
```
public static final boolean DEFAULT_RETRIEVABLE
```
    See Also:
    
    Constant Field Values
  - retrieveField
```
public java.lang.String retrieveField
```
  - indexNormalized
```
public boolean indexNormalized
```
  - DEFAULT_INDEX_NORMALIZED
```
public static final boolean DEFAULT_INDEX_NORMALIZED
```
    See Also:
    
    Constant Field Values
  - indexLowercase
```
public boolean indexLowercase
```
  - DEFAULT_INDEX_LOWERCASE
```
public static final boolean DEFAULT_INDEX_LOWERCASE
```
    See Also:
    
    Constant Field Values
  - indexExact
```
public boolean indexExact
```
  - DEFAULT_INDEX_EXACT
```
public static final boolean DEFAULT_INDEX_EXACT
```
    See Also:
    
    Constant Field Values
  - indexSeparators
```
public boolean indexSeparators
```
  - DEFAULT_INDEX_SEPARATORS
```
public static final boolean DEFAULT_INDEX_SEPARATORS
```
    See Also:
    
    Constant Field Values
  - addBreakBetweenChunks
```
public boolean addBreakBetweenChunks
```
  - DEFAULT_ADD_BREAK_BETWEEN_CHUNKS
```
public static final boolean DEFAULT_ADD_BREAK_BETWEEN_CHUNKS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StandardContentTarget
```
public StandardContentTarget()
```
  - StandardContentTarget
```
public StandardContentTarget(StandardContentTarget o)
```
    Copy constructor
- Method Detail
  - withIndexField
```
public StandardContentTarget withIndexField(java.lang.String indexField)
```
    Overrides:
    
    withIndexField in class ContentTarget
  - withForcedRank
```
public StandardContentTarget withForcedRank(long forcedRank)
```
    Overrides:
    
    withForcedRank in class ContentTarget
  - withForcedRank
```
public StandardContentTarget withForcedRank(java.lang.Long forcedRank)
```
    Overrides:
    
    withForcedRank in class ContentTarget
  - withRankBoost
```
public StandardContentTarget withRankBoost(long rankBoost)
```
    Overrides:
    
    withRankBoost in class ContentTarget
  - withRankBoost
```
public StandardContentTarget withRankBoost(java.lang.Long rankBoost)
```
    Overrides:
    
    withRankBoost in class ContentTarget
  - getRankOnAnnotation
```
public java.util.List<RankOnAnnotation> getRankOnAnnotation()
```
    List of RankOnAnnotation
  - withRankOnAnnotation
```
public StandardContentTarget withRankOnAnnotation(RankOnAnnotation... __values)
```
    List of RankOnAnnotation
  - withRankOnAnnotation
```
public StandardContentTarget withRankOnAnnotation(java.util.Collection<RankOnAnnotation> __values)
```
  - getIncreaseRankOnAnnotation
```
public java.util.List<IncreaseRankOnAnnotation> getIncreaseRankOnAnnotation()
```
    List of IncreaseRankOnAnnotation
  - withIncreaseRankOnAnnotation
```
public StandardContentTarget withIncreaseRankOnAnnotation(IncreaseRankOnAnnotation... __values)
```
    List of IncreaseRankOnAnnotation
  - withIncreaseRankOnAnnotation
```
public StandardContentTarget withIncreaseRankOnAnnotation(java.util.Collection<IncreaseRankOnAnnotation> __values)
```
  - getDecreaseRankOnAnnotation
```
public java.util.List<DecreaseRankOnAnnotation> getDecreaseRankOnAnnotation()
```
    List of DecreaseRankOnAnnotation
  - withDecreaseRankOnAnnotation
```
public StandardContentTarget withDecreaseRankOnAnnotation(DecreaseRankOnAnnotation... __values)
```
    List of DecreaseRankOnAnnotation
  - withDecreaseRankOnAnnotation
```
public StandardContentTarget withDecreaseRankOnAnnotation(java.util.Collection<DecreaseRankOnAnnotation> __values)
```
  - setPrefixWithContext
```
public void setPrefixWithContext(boolean prefixWithContext)
```
    Enables prefixing of all words in inverted lists by 'contextName#'.
  - isPrefixWithContext
```
public boolean isPrefixWithContext()
```
    Enables prefixing of all words in inverted lists by 'contextName#'.
  - withPrefixWithContext
```
public StandardContentTarget withPrefixWithContext(boolean prefixWithContext)
```
  - withPrefixWithContext
```
public StandardContentTarget withPrefixWithContext(java.lang.Boolean prefixWithContext)
```
  - setAddStartEnd
```
public void setAddStartEnd(boolean addStartEnd)
```
    Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content.
    Only valid if Chunk is mapped with semantic=true.
    This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__)
  - isAddStartEnd
```
public boolean isAddStartEnd()
```
    Enables the introduction of a word __start__ before chunk content and a word __end__ after chunk content.
    Only valid if Chunk is mapped with semantic=true.
    This option is compatible with prefixContextName: produce contextName#__start__ and contextName#__end__)
  - withAddStartEnd
```
public StandardContentTarget withAddStartEnd(boolean addStartEnd)
```
  - withAddStartEnd
```
public StandardContentTarget withAddStartEnd(java.lang.Boolean addStartEnd)
```
  - setIndexPrefixes
```
public void setIndexPrefixes(boolean indexPrefixes)
```
    Enables the indexing of all prefixes for each word with a score = prefixScore.
    The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig.
  - isIndexPrefixes
```
public boolean isIndexPrefixes()
```
    Enables the indexing of all prefixes for each word with a score = prefixScore.
    The prefix can be mapped to a specific type if you add 'prefix' in formIndexingConfig.
  - withIndexPrefixes
```
public StandardContentTarget withIndexPrefixes(boolean indexPrefixes)
```
  - withIndexPrefixes
```
public StandardContentTarget withIndexPrefixes(java.lang.Boolean indexPrefixes)
```
  - setPrefixesScore
```
public void setPrefixesScore(int prefixesScore)
```
    Score given to words' prefixes. The document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - getPrefixesScore
```
public int getPrefixesScore()
```
    Score given to words' prefixes. The document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - withPrefixesScore
```
public StandardContentTarget withPrefixesScore(int prefixesScore)
```
  - withPrefixesScore
```
public StandardContentTarget withPrefixesScore(java.lang.Integer prefixesScore)
```
  - setMaxPrefixLength
```
public void setMaxPrefixLength(int maxPrefixLength)
```
    Maximum length of the extracted prefixes.
  - getMaxPrefixLength
```
public int getMaxPrefixLength()
```
    Maximum length of the extracted prefixes.
  - withMaxPrefixLength
```
public StandardContentTarget withMaxPrefixLength(int maxPrefixLength)
```
  - withMaxPrefixLength
```
public StandardContentTarget withMaxPrefixLength(java.lang.Integer maxPrefixLength)
```
  - setIndexSuffixes
```
public void setIndexSuffixes(boolean indexSuffixes)
```
    Enables the indexing of all suffixes for each word with a score = suffixScore.
    The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig.
  - isIndexSuffixes
```
public boolean isIndexSuffixes()
```
    Enables the indexing of all suffixes for each word with a score = suffixScore.
    The suffix can be mapped to a specific kind if you add 'suffix' in formIndexingConfig.
  - withIndexSuffixes
```
public StandardContentTarget withIndexSuffixes(boolean indexSuffixes)
```
  - withIndexSuffixes
```
public StandardContentTarget withIndexSuffixes(java.lang.Boolean indexSuffixes)
```
  - setSuffixesScore
```
public void setSuffixesScore(int suffixesScore)
```
    Score given to words' prefixes. The document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - getSuffixesScore
```
public int getSuffixesScore()
```
    Score given to words' prefixes. The document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - withSuffixesScore
```
public StandardContentTarget withSuffixesScore(int suffixesScore)
```
  - withSuffixesScore
```
public StandardContentTarget withSuffixesScore(java.lang.Integer suffixesScore)
```
  - setMaxSuffixLength
```
public void setMaxSuffixLength(int maxSuffixLength)
```
    Maximum length of the extracted suffixes.
  - getMaxSuffixLength
```
public int getMaxSuffixLength()
```
    Maximum length of the extracted suffixes.
  - withMaxSuffixLength
```
public StandardContentTarget withMaxSuffixLength(int maxSuffixLength)
```
  - withMaxSuffixLength
```
public StandardContentTarget withMaxSuffixLength(java.lang.Integer maxSuffixLength)
```
  - setIndexSubstrings
```
public void setIndexSubstrings(boolean indexSubstrings)
```
    Enables the indexing of all substrings for each word with a score = substringScore.
    The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig.
  - isIndexSubstrings
```
public boolean isIndexSubstrings()
```
    Enables the indexing of all substrings for each word with a score = substringScore.
    The suffix can be mapped to a specific kind if you add 'substring' in formIndexingConfig.
  - withIndexSubstrings
```
public StandardContentTarget withIndexSubstrings(boolean indexSubstrings)
```
  - withIndexSubstrings
```
public StandardContentTarget withIndexSubstrings(java.lang.Boolean indexSubstrings)
```
  - setSubstringsScore
```
public void setSubstringsScore(int substringsScore)
```
    Score given to extracted substrings. Document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - getSubstringsScore
```
public int getSubstringsScore()
```
    Score given to extracted substrings. Document relevance is determined by its score.
    The text matching score basically represents the "distance" between a search query and a document.
  - withSubstringsScore
```
public StandardContentTarget withSubstringsScore(int substringsScore)
```
  - withSubstringsScore
```
public StandardContentTarget withSubstringsScore(java.lang.Integer substringsScore)
```
  - setSearchable
```
public void setSearchable(boolean searchable)
```
    Marks the content of the DocumentChunk as indexed and searchable.
  - isSearchable
```
public boolean isSearchable()
```
    Marks the content of the DocumentChunk as indexed and searchable.
  - withSearchable
```
public StandardContentTarget withSearchable(boolean searchable)
```
  - withSearchable
```
public StandardContentTarget withSearchable(java.lang.Boolean searchable)
```
  - setRetrievable
```
public void setRetrievable(boolean retrievable)
```
    Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved.
    For numerical values, retrievability allows you to sort results by field.
  - isRetrievable
```
public boolean isRetrievable()
```
    Enables the content of the DocumentChunk to be directly stored in the index, so that it can be retrieved.
    For numerical values, retrievability allows you to sort results by field.
  - withRetrievable
```
public StandardContentTarget withRetrievable(boolean retrievable)
```
  - withRetrievable
```
public StandardContentTarget withRetrievable(java.lang.Boolean retrievable)
```
  - setRetrieveField
```
public void setRetrieveField(java.lang.String retrieveField)
```
    The index field in which the content will be stored.
    If null, the content will be put in 'indexField'.
  - getRetrieveField
```
public java.lang.String getRetrieveField()
```
    The index field in which the content will be stored.
    If null, the content will be put in 'indexField'.
  - withRetrieveField
```
public StandardContentTarget withRetrieveField(java.lang.String retrieveField)
```
  - setIndexNormalized
```
public void setIndexNormalized(boolean indexNormalized)
```
    Enables the indexing of the normalized form of the word.
  - isIndexNormalized
```
public boolean isIndexNormalized()
```
    Enables the indexing of the normalized form of the word.
  - withIndexNormalized
```
public StandardContentTarget withIndexNormalized(boolean indexNormalized)
```
  - withIndexNormalized
```
public StandardContentTarget withIndexNormalized(java.lang.Boolean indexNormalized)
```
  - setIndexLowercase
```
public void setIndexLowercase(boolean indexLowercase)
```
    Enables the indexing of the lowercase (non-normalized) form of each token.
  - isIndexLowercase
```
public boolean isIndexLowercase()
```
    Enables the indexing of the lowercase (non-normalized) form of each token.
  - withIndexLowercase
```
public StandardContentTarget withIndexLowercase(boolean indexLowercase)
```
  - withIndexLowercase
```
public StandardContentTarget withIndexLowercase(java.lang.Boolean indexLowercase)
```
  - setIndexExact
```
public void setIndexExact(boolean indexExact)
```
    Enables the indexing of the exact (non-normalized) form of each token.
  - isIndexExact
```
public boolean isIndexExact()
```
    Enables the indexing of the exact (non-normalized) form of each token.
  - withIndexExact
```
public StandardContentTarget withIndexExact(boolean indexExact)
```
  - withIndexExact
```
public StandardContentTarget withIndexExact(java.lang.Boolean indexExact)
```
  - setIndexSeparators
```
public void setIndexSeparators(boolean indexSeparators)
```
    Enables the indexing of the index standard separators.
    Indexed standard separators are: paragraph, sentence and page.
    Standard separators indexing is required for the SPLIT operator to work with these separators.
  - isIndexSeparators
```
public boolean isIndexSeparators()
```
    Enables the indexing of the index standard separators.
    Indexed standard separators are: paragraph, sentence and page.
    Standard separators indexing is required for the SPLIT operator to work with these separators.
  - withIndexSeparators
```
public StandardContentTarget withIndexSeparators(boolean indexSeparators)
```
  - withIndexSeparators
```
public StandardContentTarget withIndexSeparators(java.lang.Boolean indexSeparators)
```
  - setAddBreakBetweenChunks
```
public void setAddBreakBetweenChunks(boolean addBreakBetweenChunks)
```
    Enables the introduction of a break between document chunks by the indexer.
    This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator.
    For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
    - If addBreakBetweenChunks is false, then the document will match on the query "foo bar", foo NEXT bar
    - If addBreakBetweenChunks is true, then the document will not match the query "foo bar" nor foo NEXT bar but will match the query foo AND bar
  - isAddBreakBetweenChunks
```
public boolean isAddBreakBetweenChunks()
```
    Enables the introduction of a break between document chunks by the indexer.
    This forbids phrase matching across these chunks and has an impact on search when using double-quotes expressions or the 'NEXT' operator.
    For example, if a document has a "title" chunk containing "foo" and a "text" chunk containing "bar", and they are both remapped to the text field.
    - If addBreakBetweenChunks is false, then the document will match on the query "foo bar", foo NEXT bar
    - If addBreakBetweenChunks is true, then the document will not match the query "foo bar" nor foo NEXT bar but will match the query foo AND bar
  - withAddBreakBetweenChunks
```
public StandardContentTarget withAddBreakBetweenChunks(boolean addBreakBetweenChunks)
```
  - withAddBreakBetweenChunks
```
public StandardContentTarget withAddBreakBetweenChunks(java.lang.Boolean addBreakBetweenChunks)
```
  - makeCopy
```
public StandardContentTarget makeCopy()
```
    Creates and returns a deep copy of this StandardContentTarget.
    
    Overrides:
    
    makeCopy in class ContentTarget
  - readFrom
```
public static StandardContentTarget readFrom(java.io.InputStream is)
                                      throws javax.xml.bind.JAXBException
```
    Read this StandardContentTarget 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 StandardContentTarget as an XML fragment
    
    Overrides:
    
    writeTo in class ContentTarget
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static StandardContentTarget fromString(java.lang.String s)
                                        throws javax.xml.bind.JAXBException,
                                               java.io.UnsupportedEncodingException
```
    String representation of this StandardContentTarget.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this StandardContentTarget.
    
    Overrides:
    
    toString in class ContentTarget
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this StandardContentTarget.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class ContentTarget
    
    Throws:
    
    com.exalead.util.TypedException

Class StandardContentTarget

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

rankOnAnnotation

increaseRankOnAnnotation

decreaseRankOnAnnotation

prefixWithContext

DEFAULT_PREFIX_WITH_CONTEXT

addStartEnd

DEFAULT_ADD_START_END

indexPrefixes

DEFAULT_INDEX_PREFIXES

prefixesScore

DEFAULT_PREFIXES_SCORE

maxPrefixLength

DEFAULT_MAX_PREFIX_LENGTH

indexSuffixes

DEFAULT_INDEX_SUFFIXES

suffixesScore

DEFAULT_SUFFIXES_SCORE

maxSuffixLength

DEFAULT_MAX_SUFFIX_LENGTH

indexSubstrings

DEFAULT_INDEX_SUBSTRINGS

substringsScore

DEFAULT_SUBSTRINGS_SCORE

searchable

DEFAULT_SEARCHABLE

retrievable

DEFAULT_RETRIEVABLE

retrieveField

indexNormalized

DEFAULT_INDEX_NORMALIZED

indexLowercase

DEFAULT_INDEX_LOWERCASE

indexExact

DEFAULT_INDEX_EXACT

indexSeparators

DEFAULT_INDEX_SEPARATORS

addBreakBetweenChunks

DEFAULT_ADD_BREAK_BETWEEN_CHUNKS

Constructor Detail

StandardContentTarget

StandardContentTarget

Method Detail

withIndexField

withForcedRank

withForcedRank

withRankBoost

withRankBoost

getRankOnAnnotation

withRankOnAnnotation

withRankOnAnnotation

getIncreaseRankOnAnnotation

withIncreaseRankOnAnnotation

withIncreaseRankOnAnnotation

getDecreaseRankOnAnnotation

withDecreaseRankOnAnnotation

withDecreaseRankOnAnnotation

setPrefixWithContext

isPrefixWithContext

withPrefixWithContext

withPrefixWithContext

setAddStartEnd

isAddStartEnd

withAddStartEnd

withAddStartEnd

setIndexPrefixes

isIndexPrefixes

withIndexPrefixes

withIndexPrefixes

setPrefixesScore

getPrefixesScore

withPrefixesScore

withPrefixesScore