com.exalead.mercury.mami.indexing.v10

Class TextFieldConfig

java.lang.Object

com.exalead.mercury.mami.indexing.v10.FieldConfig

com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

com.exalead.mercury.mami.indexing.v10.SortableFieldConfig

com.exalead.mercury.mami.indexing.v10.ValueFieldConfig

com.exalead.mercury.mami.indexing.v10.TextFieldConfig

All Implemented Interfaces:

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

public class TextFieldConfig
extends ValueFieldConfig
implements com.exalead.util.Checkable, java.io.Serializable

Stores alphanumerical content with an internal ordinal mapping, which makes it suitable for efficient facetting. Each term is limited to 1024 bytes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.indexing.v10.ValueFieldConfig

ValueFieldConfig.Implementation, ValueFieldConfig.Transformer<T>, ValueFieldConfig.Visitor

Nested classes/interfaces inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

FieldConfig.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_STORE_POSITIONS
boolean	storePositions

Fields inherited from class com.exalead.mercury.mami.indexing.v10.ValueFieldConfig

bloomFilter, DEFAULT_BLOOM_FILTER, DEFAULT_HASH_THRESHOLD, DEFAULT_IGNORE_PRESENT_BIT, DEFAULT_IMPLEMENTATION, DEFAULT_MIN_MEMBER_NB_BITS, DEFAULT_OPTIMIZE_LISTS_FOR_PATTERN_SEARCH, hashThreshold, ignorePresentBit, implementation, minMemberNbBits, optimizeListsForPatternSearch

Fields inherited from class com.exalead.mercury.mami.indexing.v10.SortableFieldConfig

DEFAULT_DELTA_REF_ENCODE_MULTIVALUED_VALUES, DEFAULT_SORT_MULTIVALUED_VALUES, deltaRefEncodeMultivaluedValues, sortMultivaluedValues

Fields inherited from class com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

DEFAULT_MULTI_CONTEXT, DEFAULT_RAM_BASED, multiContext, ramBased

Fields inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

dataModelClass, dataModelProperty, dataModelState, DEFAULT_MULTIVALUED, DEFAULT_RETRIEVABLE, DEFAULT_SEARCHABLE, DEFAULT_VERSION, fieldName, fromDataModel, listsEncoderConfig, multivalued, retrievable, searchable, version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(FieldConfig.Transformer<T> transformer, T[] t)
void	accept(FieldConfig.Visitor visitor)
<T> T	accept(SortableFieldConfig.Transformer<T> transformer, T[] t)
void	accept(SortableFieldConfig.Visitor visitor)
<T> T	accept(StandardFieldConfig.Transformer<T> transformer, T[] t)
void	accept(StandardFieldConfig.Visitor visitor)
<T> T	accept(ValueFieldConfig.Transformer<T> transformer, T[] t)
void	accept(ValueFieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this TextFieldConfig.
static TextFieldConfig	fromString(java.lang.String s) String representation of this TextFieldConfig.
boolean	isStorePositions() Store positions for seq nodes and proximity scoring.
TextFieldConfig	makeCopy() Creates and returns a deep copy of this TextFieldConfig.
static TextFieldConfig	readFrom(java.io.InputStream is) Read this TextFieldConfig from an XML fragment.
void	setStorePositions(boolean storePositions) Store positions for seq nodes and proximity scoring.
java.lang.String	toString() String representation of this TextFieldConfig.
TextFieldConfig	withBloomFilter(boolean bloomFilter)
TextFieldConfig	withBloomFilter(java.lang.Boolean bloomFilter)
TextFieldConfig	withDataModelClass(java.lang.String dataModelClass)
TextFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
TextFieldConfig	withDataModelState(java.lang.String dataModelState)
TextFieldConfig	withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)
TextFieldConfig	withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)
TextFieldConfig	withFieldName(java.lang.String fieldName)
TextFieldConfig	withFromDataModel(FieldConfig fromDataModel)
TextFieldConfig	withHashThreshold(int hashThreshold)
TextFieldConfig	withHashThreshold(java.lang.Integer hashThreshold)
TextFieldConfig	withIgnorePresentBit(boolean ignorePresentBit)
TextFieldConfig	withIgnorePresentBit(java.lang.Boolean ignorePresentBit)
TextFieldConfig	withImplementation(java.lang.String implementation)
TextFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
TextFieldConfig	withMinMemberNbBits(int minMemberNbBits)
TextFieldConfig	withMinMemberNbBits(java.lang.Integer minMemberNbBits)
TextFieldConfig	withMultiContext(boolean multiContext)
TextFieldConfig	withMultiContext(java.lang.Boolean multiContext)
TextFieldConfig	withMultivalued(boolean multivalued)
TextFieldConfig	withMultivalued(java.lang.Boolean multivalued)
TextFieldConfig	withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)
TextFieldConfig	withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)
TextFieldConfig	withRamBased(boolean ramBased)
TextFieldConfig	withRamBased(java.lang.Boolean ramBased)
TextFieldConfig	withRetrievable(boolean retrievable)
TextFieldConfig	withRetrievable(java.lang.Boolean retrievable)
TextFieldConfig	withSearchable(boolean searchable)
TextFieldConfig	withSearchable(java.lang.Boolean searchable)
TextFieldConfig	withSortMultivaluedValues(boolean sortMultivaluedValues)
TextFieldConfig	withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)
TextFieldConfig	withStorePositions(boolean storePositions)
TextFieldConfig	withStorePositions(java.lang.Boolean storePositions)
TextFieldConfig	withVersion(int version)
TextFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this TextFieldConfig as an XML fragment

Methods inherited from class com.exalead.mercury.mami.indexing.v10.ValueFieldConfig

getHashThreshold, getImplementation, getImplementationAsEnum, getMinMemberNbBits, isA, isBloomFilter, isIgnorePresentBit, isOneOf, isOptimizeListsForPatternSearch, setBloomFilter, setHashThreshold, setIgnorePresentBit, setImplementation, setImplementation, setMinMemberNbBits, setOptimizeListsForPatternSearch

Methods inherited from class com.exalead.mercury.mami.indexing.v10.SortableFieldConfig

isDeltaRefEncodeMultivaluedValues, isSortMultivaluedValues, setDeltaRefEncodeMultivaluedValues, setSortMultivaluedValues

Methods inherited from class com.exalead.mercury.mami.indexing.v10.StandardFieldConfig

isMultiContext, isRamBased, setMultiContext, setRamBased

Methods inherited from class com.exalead.mercury.mami.indexing.v10.FieldConfig

getDataModelClass, getDataModelProperty, getDataModelState, getFieldName, getFromDataModel, getListsEncoderConfig, getVersion, isMultivalued, isRetrievable, isSearchable, setDataModelClass, setDataModelProperty, setDataModelState, setFieldName, setFromDataModel, setListsEncoderConfig, setMultivalued, setRetrievable, setSearchable, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

storePositions

public boolean storePositions

DEFAULT_STORE_POSITIONS

public static final boolean DEFAULT_STORE_POSITIONS

See Also:

Constant Field Values

Constructor Detail

TextFieldConfig

public TextFieldConfig()

TextFieldConfig

public TextFieldConfig(TextFieldConfig o)

Copy constructor

Method Detail

withRamBased

public TextFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class ValueFieldConfig

withRamBased

public TextFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class ValueFieldConfig

withMultiContext

public TextFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class ValueFieldConfig

withMultiContext

public TextFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class ValueFieldConfig

withRetrievable

public TextFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class ValueFieldConfig

withRetrievable

public TextFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class ValueFieldConfig

withIgnorePresentBit

public TextFieldConfig withIgnorePresentBit(boolean ignorePresentBit)

Overrides:

withIgnorePresentBit in class ValueFieldConfig

withIgnorePresentBit

public TextFieldConfig withIgnorePresentBit(java.lang.Boolean ignorePresentBit)

Overrides:

withIgnorePresentBit in class ValueFieldConfig

withMinMemberNbBits

public TextFieldConfig withMinMemberNbBits(int minMemberNbBits)

Overrides:

withMinMemberNbBits in class ValueFieldConfig

withMinMemberNbBits

public TextFieldConfig withMinMemberNbBits(java.lang.Integer minMemberNbBits)

Overrides:

withMinMemberNbBits in class ValueFieldConfig

withBloomFilter

public TextFieldConfig withBloomFilter(boolean bloomFilter)

Overrides:

withBloomFilter in class ValueFieldConfig

withBloomFilter

public TextFieldConfig withBloomFilter(java.lang.Boolean bloomFilter)

Overrides:

withBloomFilter in class ValueFieldConfig

withHashThreshold

public TextFieldConfig withHashThreshold(int hashThreshold)

Overrides:

withHashThreshold in class ValueFieldConfig

withHashThreshold

public TextFieldConfig withHashThreshold(java.lang.Integer hashThreshold)

Overrides:

withHashThreshold in class ValueFieldConfig

withImplementation

public TextFieldConfig withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class ValueFieldConfig

withOptimizeListsForPatternSearch

public TextFieldConfig withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)

Overrides:

withOptimizeListsForPatternSearch in class ValueFieldConfig

withOptimizeListsForPatternSearch

public TextFieldConfig withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)

Overrides:

withOptimizeListsForPatternSearch in class ValueFieldConfig

withDeltaRefEncodeMultivaluedValues

public TextFieldConfig withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class ValueFieldConfig

withDeltaRefEncodeMultivaluedValues

public TextFieldConfig withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class ValueFieldConfig

withSortMultivaluedValues

public TextFieldConfig withSortMultivaluedValues(boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class ValueFieldConfig

withSortMultivaluedValues

public TextFieldConfig withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class ValueFieldConfig

withFieldName

public TextFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class ValueFieldConfig

withSearchable

public TextFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class ValueFieldConfig

withSearchable

public TextFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class ValueFieldConfig

withDataModelState

public TextFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class ValueFieldConfig

withFromDataModel

public TextFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class ValueFieldConfig

withDataModelClass

public TextFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class ValueFieldConfig

withDataModelProperty

public TextFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class ValueFieldConfig

withMultivalued

public TextFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class ValueFieldConfig

withMultivalued

public TextFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class ValueFieldConfig

withVersion

public TextFieldConfig withVersion(int version)

Overrides:

withVersion in class ValueFieldConfig

withVersion

public TextFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class ValueFieldConfig

withListsEncoderConfig

public TextFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class ValueFieldConfig

setStorePositions

public void setStorePositions(boolean storePositions)

Store positions for seq nodes and proximity scoring.

isStorePositions

public boolean isStorePositions()

Store positions for seq nodes and proximity scoring.

withStorePositions

public TextFieldConfig withStorePositions(boolean storePositions)

withStorePositions

public TextFieldConfig withStorePositions(java.lang.Boolean storePositions)

makeCopy

public TextFieldConfig makeCopy()

Creates and returns a deep copy of this TextFieldConfig.

Overrides:

makeCopy in class ValueFieldConfig

readFrom

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

Read this TextFieldConfig 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 TextFieldConfig as an XML fragment

Overrides:

writeTo in class ValueFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this TextFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TextFieldConfig.

Overrides:

toString in class ValueFieldConfig

check

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

Checks this TextFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public void accept(ValueFieldConfig.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public void accept(SortableFieldConfig.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public void accept(StandardFieldConfig.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public void accept(FieldConfig.Visitor visitor)
            throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(ValueFieldConfig.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(SortableFieldConfig.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(StandardFieldConfig.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FieldConfig.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Overrides:

accept in class ValueFieldConfig

Throws:

com.exalead.util.TypedException