com.exalead.mercury.mami.indexing.v10

Class ValueFieldConfig

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ReferenceFieldConfig, TextFieldConfig

public class ValueFieldConfig
extends SortableFieldConfig
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

Modifier and Type	Class and Description
static class	ValueFieldConfig.Implementation
static interface	ValueFieldConfig.Transformer<T>
static interface	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
boolean	bloomFilter
static boolean	DEFAULT_BLOOM_FILTER
static int	DEFAULT_HASH_THRESHOLD
static boolean	DEFAULT_IGNORE_PRESENT_BIT
static java.lang.String	DEFAULT_IMPLEMENTATION
static int	DEFAULT_MIN_MEMBER_NB_BITS
static boolean	DEFAULT_OPTIMIZE_LISTS_FOR_PATTERN_SEARCH
int	hashThreshold
boolean	ignorePresentBit
java.lang.String	implementation
int	minMemberNbBits
boolean	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
ValueFieldConfig()
ValueFieldConfig(ValueFieldConfig 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 ValueFieldConfig.
static ValueFieldConfig	fromString(java.lang.String s) String representation of this ValueFieldConfig.
int	getHashThreshold() Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold.
java.lang.String	getImplementation() Advanced configuration.
ValueFieldConfig.Implementation	getImplementationAsEnum() Advanced configuration.
int	getMinMemberNbBits() Min number of bits for attr part for value field.
static boolean	isA(java.lang.String str, ValueFieldConfig.Implementation item)
boolean	isBloomFilter() Activates a Bloom filter per slot.
boolean	isIgnorePresentBit() Uses and loads the present bit.
static boolean	isOneOf(java.lang.String str, ValueFieldConfig.Implementation... items)
boolean	isOptimizeListsForPatternSearch() speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space.
ValueFieldConfig	makeCopy() Creates and returns a deep copy of this ValueFieldConfig.
static ValueFieldConfig	readFrom(java.io.InputStream is) Read this ValueFieldConfig from an XML fragment.
void	setBloomFilter(boolean bloomFilter) Activates a Bloom filter per slot.
void	setHashThreshold(int hashThreshold) Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold.
void	setIgnorePresentBit(boolean ignorePresentBit) Uses and loads the present bit.
void	setImplementation(java.lang.String implementation) Advanced configuration.
void	setImplementation(ValueFieldConfig.Implementation item) Advanced configuration.
void	setMinMemberNbBits(int minMemberNbBits) Min number of bits for attr part for value field.
void	setOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch) speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space.
java.lang.String	toString() String representation of this ValueFieldConfig.
ValueFieldConfig	withBloomFilter(boolean bloomFilter)
ValueFieldConfig	withBloomFilter(java.lang.Boolean bloomFilter)
ValueFieldConfig	withDataModelClass(java.lang.String dataModelClass)
ValueFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
ValueFieldConfig	withDataModelState(java.lang.String dataModelState)
ValueFieldConfig	withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)
ValueFieldConfig	withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)
ValueFieldConfig	withFieldName(java.lang.String fieldName)
ValueFieldConfig	withFromDataModel(FieldConfig fromDataModel)
ValueFieldConfig	withHashThreshold(int hashThreshold)
ValueFieldConfig	withHashThreshold(java.lang.Integer hashThreshold)
ValueFieldConfig	withIgnorePresentBit(boolean ignorePresentBit)
ValueFieldConfig	withIgnorePresentBit(java.lang.Boolean ignorePresentBit)
ValueFieldConfig	withImplementation(java.lang.String implementation)
ValueFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
ValueFieldConfig	withMinMemberNbBits(int minMemberNbBits)
ValueFieldConfig	withMinMemberNbBits(java.lang.Integer minMemberNbBits)
ValueFieldConfig	withMultiContext(boolean multiContext)
ValueFieldConfig	withMultiContext(java.lang.Boolean multiContext)
ValueFieldConfig	withMultivalued(boolean multivalued)
ValueFieldConfig	withMultivalued(java.lang.Boolean multivalued)
ValueFieldConfig	withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)
ValueFieldConfig	withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)
ValueFieldConfig	withRamBased(boolean ramBased)
ValueFieldConfig	withRamBased(java.lang.Boolean ramBased)
ValueFieldConfig	withRetrievable(boolean retrievable)
ValueFieldConfig	withRetrievable(java.lang.Boolean retrievable)
ValueFieldConfig	withSearchable(boolean searchable)
ValueFieldConfig	withSearchable(java.lang.Boolean searchable)
ValueFieldConfig	withSortMultivaluedValues(boolean sortMultivaluedValues)
ValueFieldConfig	withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)
ValueFieldConfig	withVersion(int version)
ValueFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this ValueFieldConfig as an XML fragment

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

ignorePresentBit

public boolean ignorePresentBit

DEFAULT_IGNORE_PRESENT_BIT

public static final boolean DEFAULT_IGNORE_PRESENT_BIT

See Also:

Constant Field Values

minMemberNbBits

public int minMemberNbBits

DEFAULT_MIN_MEMBER_NB_BITS

public static final int DEFAULT_MIN_MEMBER_NB_BITS

See Also:

Constant Field Values

bloomFilter

public boolean bloomFilter

DEFAULT_BLOOM_FILTER

public static final boolean DEFAULT_BLOOM_FILTER

See Also:

Constant Field Values

hashThreshold

public int hashThreshold

DEFAULT_HASH_THRESHOLD

public static final int DEFAULT_HASH_THRESHOLD

See Also:

Constant Field Values

implementation

public java.lang.String implementation

DEFAULT_IMPLEMENTATION

public static final java.lang.String DEFAULT_IMPLEMENTATION

See Also:

Constant Field Values

optimizeListsForPatternSearch

public boolean optimizeListsForPatternSearch

DEFAULT_OPTIMIZE_LISTS_FOR_PATTERN_SEARCH

public static final boolean DEFAULT_OPTIMIZE_LISTS_FOR_PATTERN_SEARCH

See Also:

Constant Field Values

Constructor Detail

ValueFieldConfig

public ValueFieldConfig()

ValueFieldConfig

public ValueFieldConfig(ValueFieldConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          ValueFieldConfig.Implementation item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              ValueFieldConfig.Implementation... items)

setImplementation

public void setImplementation(ValueFieldConfig.Implementation item)

Advanced configuration. Internal structure used to store the field dictionary.

getImplementationAsEnum

public ValueFieldConfig.Implementation getImplementationAsEnum()

Advanced configuration. Internal structure used to store the field dictionary.

withDeltaRefEncodeMultivaluedValues

public ValueFieldConfig withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class SortableFieldConfig

withDeltaRefEncodeMultivaluedValues

public ValueFieldConfig withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class SortableFieldConfig

withSortMultivaluedValues

public ValueFieldConfig withSortMultivaluedValues(boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class SortableFieldConfig

withSortMultivaluedValues

public ValueFieldConfig withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class SortableFieldConfig

withRamBased

public ValueFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class SortableFieldConfig

withRamBased

public ValueFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class SortableFieldConfig

withMultiContext

public ValueFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class SortableFieldConfig

withMultiContext

public ValueFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class SortableFieldConfig

withFieldName

public ValueFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class SortableFieldConfig

withSearchable

public ValueFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class SortableFieldConfig

withSearchable

public ValueFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class SortableFieldConfig

withRetrievable

public ValueFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class SortableFieldConfig

withRetrievable

public ValueFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class SortableFieldConfig

withDataModelState

public ValueFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SortableFieldConfig

withFromDataModel

public ValueFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class SortableFieldConfig

withDataModelClass

public ValueFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SortableFieldConfig

withDataModelProperty

public ValueFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SortableFieldConfig

withMultivalued

public ValueFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class SortableFieldConfig

withMultivalued

public ValueFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class SortableFieldConfig

withVersion

public ValueFieldConfig withVersion(int version)

Overrides:

withVersion in class SortableFieldConfig

withVersion

public ValueFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class SortableFieldConfig

withListsEncoderConfig

public ValueFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class SortableFieldConfig

setIgnorePresentBit

public void setIgnorePresentBit(boolean ignorePresentBit)

Uses and loads the present bit.

isIgnorePresentBit

public boolean isIgnorePresentBit()

Uses and loads the present bit.

withIgnorePresentBit

public ValueFieldConfig withIgnorePresentBit(boolean ignorePresentBit)

withIgnorePresentBit

public ValueFieldConfig withIgnorePresentBit(java.lang.Boolean ignorePresentBit)

setMinMemberNbBits

public void setMinMemberNbBits(int minMemberNbBits)

Min number of bits for attr part for value field.

getMinMemberNbBits

public int getMinMemberNbBits()

Min number of bits for attr part for value field.

withMinMemberNbBits

public ValueFieldConfig withMinMemberNbBits(int minMemberNbBits)

withMinMemberNbBits

public ValueFieldConfig withMinMemberNbBits(java.lang.Integer minMemberNbBits)

setBloomFilter

public void setBloomFilter(boolean bloomFilter)

Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot.
Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly.
Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing).

isBloomFilter

public boolean isBloomFilter()

Activates a Bloom filter per slot. This speeds up requests containing words that are not present in the field on a given slot.
Disable this option if all words of the request for this field are always matching, and if you compact into big slots regularly.
Enable this option if there is either a lot of misses (e.g. on the "text" field) or if you have small updates (e.g. with real-time indexing).

withBloomFilter

public ValueFieldConfig withBloomFilter(boolean bloomFilter)

withBloomFilter

public ValueFieldConfig withBloomFilter(java.lang.Boolean bloomFilter)

setHashThreshold

public void setHashThreshold(int hashThreshold)

Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold.

getHashThreshold

public int getHashThreshold()

Stores a hash value in field dictionary instead of the original data if value length is greater than this threshold.

withHashThreshold

public ValueFieldConfig withHashThreshold(int hashThreshold)

withHashThreshold

public ValueFieldConfig withHashThreshold(java.lang.Integer hashThreshold)

setImplementation

public void setImplementation(java.lang.String implementation)

Advanced configuration. Internal structure used to store the field dictionary.

getImplementation

public java.lang.String getImplementation()

Advanced configuration. Internal structure used to store the field dictionary.

withImplementation

public ValueFieldConfig withImplementation(java.lang.String implementation)

setOptimizeListsForPatternSearch

public void setOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)

speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space.

isOptimizeListsForPatternSearch

public boolean isOptimizeListsForPatternSearch()

speed up pattern search by reducing the number of opened inverted lists at the expense of indexing time and disk space.

withOptimizeListsForPatternSearch

public ValueFieldConfig withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)

withOptimizeListsForPatternSearch

public ValueFieldConfig withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)

makeCopy

public ValueFieldConfig makeCopy()

Creates and returns a deep copy of this ValueFieldConfig.

Overrides:

makeCopy in class SortableFieldConfig

readFrom

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

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

Overrides:

writeTo in class SortableFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ValueFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ValueFieldConfig.

Overrides:

toString in class SortableFieldConfig

check

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

Checks this ValueFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SortableFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SortableFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class StandardFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class FieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SortableFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class StandardFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class FieldConfig

Throws:

com.exalead.util.TypedException