public class AlphanumFieldConfig extends StandardFieldConfig implements com.exalead.util.Checkable, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
AlphanumFieldConfig.Implementation |
static class |
AlphanumFieldConfig.PatternSearchOptimizationType |
StandardFieldConfig.Transformer<T>, StandardFieldConfig.Visitor
FieldConfig.FromDataModel
Modifier and Type | Field and Description |
---|---|
boolean |
bloomFilter |
static boolean |
DEFAULT_BLOOM_FILTER |
static boolean |
DEFAULT_GZIP |
static java.lang.String |
DEFAULT_IMPLEMENTATION |
static int |
DEFAULT_MAX_INLINE_WORD_POSITIONS |
static int |
DEFAULT_NB_WORDS_PER_LEAF |
static boolean |
DEFAULT_OPTIMIZE_PATTERN_SEARCH |
static java.lang.String |
DEFAULT_PATTERN_SEARCH_OPTIMIZATION_TYPE |
static boolean |
DEFAULT_STORE_TF |
static boolean |
DEFAULT_USE_VARIABLE_POSITIONS_ENCODING |
boolean |
gzip |
java.lang.String |
implementation |
int |
maxInlineWordPositions
Deprecated.
|
int |
maxStoredWordPosition |
int |
nbWordsPerLeaf |
boolean |
optimizePatternSearch |
java.lang.String |
patternSearchOptimizationType |
boolean |
storeTf |
boolean |
useVariablePositionsEncoding
Deprecated.
|
DEFAULT_MULTI_CONTEXT, DEFAULT_RAM_BASED, multiContext, ramBased
dataModelClass, dataModelProperty, dataModelState, DEFAULT_MULTIVALUED, DEFAULT_RETRIEVABLE, DEFAULT_SEARCHABLE, DEFAULT_VERSION, fieldName, fromDataModel, listsEncoderConfig, multivalued, retrievable, searchable, version
Constructor and Description |
---|
AlphanumFieldConfig() |
AlphanumFieldConfig(AlphanumFieldConfig o)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
<T> T |
accept(FieldConfig.Transformer<T> transformer,
T[] t) |
void |
accept(FieldConfig.Visitor visitor) |
<T> T |
accept(StandardFieldConfig.Transformer<T> transformer,
T[] t) |
void |
accept(StandardFieldConfig.Visitor visitor) |
void |
check(boolean deep,
java.lang.String errorContext)
Checks this AlphanumFieldConfig.
|
static AlphanumFieldConfig |
fromString(java.lang.String s)
String representation of this AlphanumFieldConfig.
|
java.lang.String |
getImplementation()
Advanced configuration.
|
AlphanumFieldConfig.Implementation |
getImplementationAsEnum()
Advanced configuration.
|
int |
getMaxInlineWordPositions()
Deprecated.
|
int |
getMaxStoredWordPosition()
Number of words, starting from the beginning of the document, for which
word positions will be stored in the index.
This enables proximity ranking and position searching (NEAR, NEXT, ...) up to this number of words in the document. |
int |
getNbWordsPerLeaf()
Advanced configuration.
|
java.lang.String |
getPatternSearchOptimizationType()
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
AlphanumFieldConfig.PatternSearchOptimizationType |
getPatternSearchOptimizationTypeAsEnum()
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
static boolean |
isA(java.lang.String str,
AlphanumFieldConfig.Implementation item) |
static boolean |
isA(java.lang.String str,
AlphanumFieldConfig.PatternSearchOptimizationType item) |
boolean |
isBloomFilter()
Activates a Bloom filter per slot.
|
boolean |
isGzip()
Activates content compression
|
static boolean |
isOneOf(java.lang.String str,
AlphanumFieldConfig.Implementation... items) |
static boolean |
isOneOf(java.lang.String str,
AlphanumFieldConfig.PatternSearchOptimizationType... items) |
boolean |
isOptimizePatternSearch()
Adds extra informations to the index for pattern search optimization.
|
boolean |
isStoreTf()
Stores the number of terms of each document.
This information may be used by the ranking algorithm to normalize term frequencies (as "nbTerms"). This costs a few bytes of RAM per document. |
boolean |
isUseVariablePositionsEncoding()
Deprecated.
|
AlphanumFieldConfig |
makeCopy()
Creates and returns a deep copy of this AlphanumFieldConfig.
|
static AlphanumFieldConfig |
readFrom(java.io.InputStream is)
Read this AlphanumFieldConfig from an XML fragment.
|
void |
setBloomFilter(boolean bloomFilter)
Activates a Bloom filter per slot.
|
void |
setGzip(boolean gzip)
Activates content compression
|
void |
setImplementation(AlphanumFieldConfig.Implementation item)
Advanced configuration.
|
void |
setImplementation(java.lang.String implementation)
Advanced configuration.
|
void |
setMaxInlineWordPositions(int maxInlineWordPositions)
Deprecated.
|
void |
setMaxStoredWordPosition(int maxStoredWordPosition)
Number of words, starting from the beginning of the document, for which
word positions will be stored in the index.
This enables proximity ranking and position searching (NEAR, NEXT, ...) up to this number of words in the document. |
void |
setNbWordsPerLeaf(int nbWordsPerLeaf)
Advanced configuration.
|
void |
setOptimizePatternSearch(boolean optimizePatternSearch)
Adds extra informations to the index for pattern search optimization.
|
void |
setPatternSearchOptimizationType(AlphanumFieldConfig.PatternSearchOptimizationType item)
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
void |
setPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
Select algorithm based on dictionary ngrams or indexed ngrams (untokenized text only).
|
void |
setStoreTf(boolean storeTf)
Stores the number of terms of each document.
This information may be used by the ranking algorithm to normalize term frequencies (as "nbTerms"). This costs a few bytes of RAM per document. |
void |
setUseVariablePositionsEncoding(boolean useVariablePositionsEncoding)
Deprecated.
|
java.lang.String |
toString()
String representation of this AlphanumFieldConfig.
|
AlphanumFieldConfig |
withBloomFilter(boolean bloomFilter) |
AlphanumFieldConfig |
withBloomFilter(java.lang.Boolean bloomFilter) |
AlphanumFieldConfig |
withDataModelClass(java.lang.String dataModelClass) |
AlphanumFieldConfig |
withDataModelProperty(java.lang.String dataModelProperty) |
AlphanumFieldConfig |
withDataModelState(java.lang.String dataModelState) |
AlphanumFieldConfig |
withFieldName(java.lang.String fieldName) |
AlphanumFieldConfig |
withFromDataModel(FieldConfig fromDataModel) |
AlphanumFieldConfig |
withGzip(boolean gzip) |
AlphanumFieldConfig |
withGzip(java.lang.Boolean gzip) |
AlphanumFieldConfig |
withImplementation(java.lang.String implementation) |
AlphanumFieldConfig |
withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig) |
AlphanumFieldConfig |
withMaxInlineWordPositions(int maxInlineWordPositions)
Deprecated.
|
AlphanumFieldConfig |
withMaxInlineWordPositions(java.lang.Integer maxInlineWordPositions)
Deprecated.
|
AlphanumFieldConfig |
withMaxStoredWordPosition(int maxStoredWordPosition) |
AlphanumFieldConfig |
withMaxStoredWordPosition(java.lang.Integer maxStoredWordPosition) |
AlphanumFieldConfig |
withMultiContext(boolean multiContext) |
AlphanumFieldConfig |
withMultiContext(java.lang.Boolean multiContext) |
AlphanumFieldConfig |
withMultivalued(boolean multivalued) |
AlphanumFieldConfig |
withMultivalued(java.lang.Boolean multivalued) |
AlphanumFieldConfig |
withNbWordsPerLeaf(int nbWordsPerLeaf) |
AlphanumFieldConfig |
withNbWordsPerLeaf(java.lang.Integer nbWordsPerLeaf) |
AlphanumFieldConfig |
withOptimizePatternSearch(boolean optimizePatternSearch) |
AlphanumFieldConfig |
withOptimizePatternSearch(java.lang.Boolean optimizePatternSearch) |
AlphanumFieldConfig |
withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType) |
AlphanumFieldConfig |
withRamBased(boolean ramBased) |
AlphanumFieldConfig |
withRamBased(java.lang.Boolean ramBased) |
AlphanumFieldConfig |
withRetrievable(boolean retrievable) |
AlphanumFieldConfig |
withRetrievable(java.lang.Boolean retrievable) |
AlphanumFieldConfig |
withSearchable(boolean searchable) |
AlphanumFieldConfig |
withSearchable(java.lang.Boolean searchable) |
AlphanumFieldConfig |
withStoreTf(boolean storeTf) |
AlphanumFieldConfig |
withStoreTf(java.lang.Boolean storeTf) |
AlphanumFieldConfig |
withUseVariablePositionsEncoding(boolean useVariablePositionsEncoding)
Deprecated.
|
AlphanumFieldConfig |
withUseVariablePositionsEncoding(java.lang.Boolean useVariablePositionsEncoding)
Deprecated.
|
AlphanumFieldConfig |
withVersion(int version) |
AlphanumFieldConfig |
withVersion(java.lang.Integer version) |
void |
writeTo(java.io.OutputStream os)
Write this AlphanumFieldConfig as an XML fragment
|
isMultiContext, isRamBased, setMultiContext, setRamBased
getDataModelClass, getDataModelProperty, getDataModelState, getFieldName, getFromDataModel, getListsEncoderConfig, getVersion, isMultivalued, isRetrievable, isSearchable, setDataModelClass, setDataModelProperty, setDataModelState, setFieldName, setFromDataModel, setListsEncoderConfig, setMultivalued, setRetrievable, setSearchable, setVersion
public int maxStoredWordPosition
@Deprecated public int maxInlineWordPositions
public static final int DEFAULT_MAX_INLINE_WORD_POSITIONS
@Deprecated public boolean useVariablePositionsEncoding
public static final boolean DEFAULT_USE_VARIABLE_POSITIONS_ENCODING
public boolean storeTf
public static final boolean DEFAULT_STORE_TF
public boolean bloomFilter
public static final boolean DEFAULT_BLOOM_FILTER
public boolean gzip
public static final boolean DEFAULT_GZIP
public java.lang.String implementation
public static final java.lang.String DEFAULT_IMPLEMENTATION
public int nbWordsPerLeaf
public static final int DEFAULT_NB_WORDS_PER_LEAF
public boolean optimizePatternSearch
public static final boolean DEFAULT_OPTIMIZE_PATTERN_SEARCH
public java.lang.String patternSearchOptimizationType
public static final java.lang.String DEFAULT_PATTERN_SEARCH_OPTIMIZATION_TYPE
public AlphanumFieldConfig()
public AlphanumFieldConfig(AlphanumFieldConfig o)
public static boolean isA(java.lang.String str, AlphanumFieldConfig.Implementation item)
public static boolean isOneOf(java.lang.String str, AlphanumFieldConfig.Implementation... items)
public void setImplementation(AlphanumFieldConfig.Implementation item)
public AlphanumFieldConfig.Implementation getImplementationAsEnum()
public static boolean isA(java.lang.String str, AlphanumFieldConfig.PatternSearchOptimizationType item)
public static boolean isOneOf(java.lang.String str, AlphanumFieldConfig.PatternSearchOptimizationType... items)
public void setPatternSearchOptimizationType(AlphanumFieldConfig.PatternSearchOptimizationType item)
public AlphanumFieldConfig.PatternSearchOptimizationType getPatternSearchOptimizationTypeAsEnum()
public AlphanumFieldConfig withRamBased(boolean ramBased)
withRamBased
in class StandardFieldConfig
public AlphanumFieldConfig withRamBased(java.lang.Boolean ramBased)
withRamBased
in class StandardFieldConfig
public AlphanumFieldConfig withMultiContext(boolean multiContext)
withMultiContext
in class StandardFieldConfig
public AlphanumFieldConfig withMultiContext(java.lang.Boolean multiContext)
withMultiContext
in class StandardFieldConfig
public AlphanumFieldConfig withFieldName(java.lang.String fieldName)
withFieldName
in class StandardFieldConfig
public AlphanumFieldConfig withSearchable(boolean searchable)
withSearchable
in class StandardFieldConfig
public AlphanumFieldConfig withSearchable(java.lang.Boolean searchable)
withSearchable
in class StandardFieldConfig
public AlphanumFieldConfig withRetrievable(boolean retrievable)
withRetrievable
in class StandardFieldConfig
public AlphanumFieldConfig withRetrievable(java.lang.Boolean retrievable)
withRetrievable
in class StandardFieldConfig
public AlphanumFieldConfig withDataModelState(java.lang.String dataModelState)
withDataModelState
in class StandardFieldConfig
public AlphanumFieldConfig withFromDataModel(FieldConfig fromDataModel)
withFromDataModel
in class StandardFieldConfig
public AlphanumFieldConfig withDataModelClass(java.lang.String dataModelClass)
withDataModelClass
in class StandardFieldConfig
public AlphanumFieldConfig withDataModelProperty(java.lang.String dataModelProperty)
withDataModelProperty
in class StandardFieldConfig
public AlphanumFieldConfig withMultivalued(boolean multivalued)
withMultivalued
in class StandardFieldConfig
public AlphanumFieldConfig withMultivalued(java.lang.Boolean multivalued)
withMultivalued
in class StandardFieldConfig
public AlphanumFieldConfig withVersion(int version)
withVersion
in class StandardFieldConfig
public AlphanumFieldConfig withVersion(java.lang.Integer version)
withVersion
in class StandardFieldConfig
public AlphanumFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
withListsEncoderConfig
in class StandardFieldConfig
public void setMaxStoredWordPosition(int maxStoredWordPosition)
public int getMaxStoredWordPosition()
public AlphanumFieldConfig withMaxStoredWordPosition(int maxStoredWordPosition)
public AlphanumFieldConfig withMaxStoredWordPosition(java.lang.Integer maxStoredWordPosition)
@Deprecated public void setMaxInlineWordPositions(int maxInlineWordPositions)
@Deprecated public int getMaxInlineWordPositions()
@Deprecated public AlphanumFieldConfig withMaxInlineWordPositions(int maxInlineWordPositions)
@Deprecated public AlphanumFieldConfig withMaxInlineWordPositions(java.lang.Integer maxInlineWordPositions)
@Deprecated public void setUseVariablePositionsEncoding(boolean useVariablePositionsEncoding)
@Deprecated public boolean isUseVariablePositionsEncoding()
@Deprecated public AlphanumFieldConfig withUseVariablePositionsEncoding(boolean useVariablePositionsEncoding)
@Deprecated public AlphanumFieldConfig withUseVariablePositionsEncoding(java.lang.Boolean useVariablePositionsEncoding)
public void setStoreTf(boolean storeTf)
public boolean isStoreTf()
public AlphanumFieldConfig withStoreTf(boolean storeTf)
public AlphanumFieldConfig withStoreTf(java.lang.Boolean storeTf)
public void setBloomFilter(boolean bloomFilter)
public boolean isBloomFilter()
public AlphanumFieldConfig withBloomFilter(boolean bloomFilter)
public AlphanumFieldConfig withBloomFilter(java.lang.Boolean bloomFilter)
public void setGzip(boolean gzip)
public boolean isGzip()
public AlphanumFieldConfig withGzip(boolean gzip)
public AlphanumFieldConfig withGzip(java.lang.Boolean gzip)
public void setImplementation(java.lang.String implementation)
public java.lang.String getImplementation()
public AlphanumFieldConfig withImplementation(java.lang.String implementation)
public void setNbWordsPerLeaf(int nbWordsPerLeaf)
public int getNbWordsPerLeaf()
public AlphanumFieldConfig withNbWordsPerLeaf(int nbWordsPerLeaf)
public AlphanumFieldConfig withNbWordsPerLeaf(java.lang.Integer nbWordsPerLeaf)
public void setOptimizePatternSearch(boolean optimizePatternSearch)
public boolean isOptimizePatternSearch()
public AlphanumFieldConfig withOptimizePatternSearch(boolean optimizePatternSearch)
public AlphanumFieldConfig withOptimizePatternSearch(java.lang.Boolean optimizePatternSearch)
public void setPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
public java.lang.String getPatternSearchOptimizationType()
public AlphanumFieldConfig withPatternSearchOptimizationType(java.lang.String patternSearchOptimizationType)
public AlphanumFieldConfig makeCopy()
makeCopy
in class StandardFieldConfig
public static AlphanumFieldConfig readFrom(java.io.InputStream is) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
public void writeTo(java.io.OutputStream os) throws javax.xml.bind.JAXBException, java.io.IOException
writeTo
in class StandardFieldConfig
javax.xml.bind.JAXBException
java.io.IOException
public static AlphanumFieldConfig fromString(java.lang.String s) throws javax.xml.bind.JAXBException, java.io.UnsupportedEncodingException
javax.xml.bind.JAXBException
java.io.UnsupportedEncodingException
public java.lang.String toString()
toString
in class StandardFieldConfig
public void check(boolean deep, java.lang.String errorContext) throws com.exalead.util.TypedException
check
in interface com.exalead.util.Checkable
check
in class StandardFieldConfig
com.exalead.util.TypedException
public void accept(StandardFieldConfig.Visitor visitor) throws com.exalead.util.TypedException
accept
in class StandardFieldConfig
com.exalead.util.TypedException
public void accept(FieldConfig.Visitor visitor) throws com.exalead.util.TypedException
accept
in class FieldConfig
com.exalead.util.TypedException
public <T> T accept(StandardFieldConfig.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
accept
in class StandardFieldConfig
com.exalead.util.TypedException
public <T> T accept(FieldConfig.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
accept
in class FieldConfig
com.exalead.util.TypedException
Copyright © 2021 Dassault Systèmes, All Rights Reserved.