com.exalead.mercury.mami.indexing.v10

Class ReferenceFieldConfig

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.ReferenceFieldConfig

All Implemented Interfaces:

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

public class ReferenceFieldConfig
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 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
ReferenceFieldConfig()
ReferenceFieldConfig(ReferenceFieldConfig 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 ReferenceFieldConfig.
static ReferenceFieldConfig	fromString(java.lang.String s) String representation of this ReferenceFieldConfig.
ReferenceFieldConfig	makeCopy() Creates and returns a deep copy of this ReferenceFieldConfig.
static ReferenceFieldConfig	readFrom(java.io.InputStream is) Read this ReferenceFieldConfig from an XML fragment.
java.lang.String	toString() String representation of this ReferenceFieldConfig.
ReferenceFieldConfig	withBloomFilter(boolean bloomFilter)
ReferenceFieldConfig	withBloomFilter(java.lang.Boolean bloomFilter)
ReferenceFieldConfig	withDataModelClass(java.lang.String dataModelClass)
ReferenceFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
ReferenceFieldConfig	withDataModelState(java.lang.String dataModelState)
ReferenceFieldConfig	withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)
ReferenceFieldConfig	withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)
ReferenceFieldConfig	withFieldName(java.lang.String fieldName)
ReferenceFieldConfig	withFromDataModel(FieldConfig fromDataModel)
ReferenceFieldConfig	withHashThreshold(int hashThreshold)
ReferenceFieldConfig	withHashThreshold(java.lang.Integer hashThreshold)
ReferenceFieldConfig	withIgnorePresentBit(boolean ignorePresentBit)
ReferenceFieldConfig	withIgnorePresentBit(java.lang.Boolean ignorePresentBit)
ReferenceFieldConfig	withImplementation(java.lang.String implementation)
ReferenceFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
ReferenceFieldConfig	withMinMemberNbBits(int minMemberNbBits)
ReferenceFieldConfig	withMinMemberNbBits(java.lang.Integer minMemberNbBits)
ReferenceFieldConfig	withMultiContext(boolean multiContext)
ReferenceFieldConfig	withMultiContext(java.lang.Boolean multiContext)
ReferenceFieldConfig	withMultivalued(boolean multivalued)
ReferenceFieldConfig	withMultivalued(java.lang.Boolean multivalued)
ReferenceFieldConfig	withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)
ReferenceFieldConfig	withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)
ReferenceFieldConfig	withRamBased(boolean ramBased)
ReferenceFieldConfig	withRamBased(java.lang.Boolean ramBased)
ReferenceFieldConfig	withRetrievable(boolean retrievable)
ReferenceFieldConfig	withRetrievable(java.lang.Boolean retrievable)
ReferenceFieldConfig	withSearchable(boolean searchable)
ReferenceFieldConfig	withSearchable(java.lang.Boolean searchable)
ReferenceFieldConfig	withSortMultivaluedValues(boolean sortMultivaluedValues)
ReferenceFieldConfig	withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)
ReferenceFieldConfig	withVersion(int version)
ReferenceFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this ReferenceFieldConfig 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

Constructor Detail

ReferenceFieldConfig

public ReferenceFieldConfig()

ReferenceFieldConfig

public ReferenceFieldConfig(ReferenceFieldConfig o)

Copy constructor

Method Detail

withRamBased

public ReferenceFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class ValueFieldConfig

withRamBased

public ReferenceFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class ValueFieldConfig

withMultiContext

public ReferenceFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class ValueFieldConfig

withMultiContext

public ReferenceFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class ValueFieldConfig

withRetrievable

public ReferenceFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class ValueFieldConfig

withRetrievable

public ReferenceFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class ValueFieldConfig

withIgnorePresentBit

public ReferenceFieldConfig withIgnorePresentBit(boolean ignorePresentBit)

Overrides:

withIgnorePresentBit in class ValueFieldConfig

withIgnorePresentBit

public ReferenceFieldConfig withIgnorePresentBit(java.lang.Boolean ignorePresentBit)

Overrides:

withIgnorePresentBit in class ValueFieldConfig

withMinMemberNbBits

public ReferenceFieldConfig withMinMemberNbBits(int minMemberNbBits)

Overrides:

withMinMemberNbBits in class ValueFieldConfig

withMinMemberNbBits

public ReferenceFieldConfig withMinMemberNbBits(java.lang.Integer minMemberNbBits)

Overrides:

withMinMemberNbBits in class ValueFieldConfig

withBloomFilter

public ReferenceFieldConfig withBloomFilter(boolean bloomFilter)

Overrides:

withBloomFilter in class ValueFieldConfig

withBloomFilter

public ReferenceFieldConfig withBloomFilter(java.lang.Boolean bloomFilter)

Overrides:

withBloomFilter in class ValueFieldConfig

withHashThreshold

public ReferenceFieldConfig withHashThreshold(int hashThreshold)

Overrides:

withHashThreshold in class ValueFieldConfig

withHashThreshold

public ReferenceFieldConfig withHashThreshold(java.lang.Integer hashThreshold)

Overrides:

withHashThreshold in class ValueFieldConfig

withImplementation

public ReferenceFieldConfig withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class ValueFieldConfig

withOptimizeListsForPatternSearch

public ReferenceFieldConfig withOptimizeListsForPatternSearch(boolean optimizeListsForPatternSearch)

Overrides:

withOptimizeListsForPatternSearch in class ValueFieldConfig

withOptimizeListsForPatternSearch

public ReferenceFieldConfig withOptimizeListsForPatternSearch(java.lang.Boolean optimizeListsForPatternSearch)

Overrides:

withOptimizeListsForPatternSearch in class ValueFieldConfig

withDeltaRefEncodeMultivaluedValues

public ReferenceFieldConfig withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class ValueFieldConfig

withDeltaRefEncodeMultivaluedValues

public ReferenceFieldConfig withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class ValueFieldConfig

withSortMultivaluedValues

public ReferenceFieldConfig withSortMultivaluedValues(boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class ValueFieldConfig

withSortMultivaluedValues

public ReferenceFieldConfig withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class ValueFieldConfig

withFieldName

public ReferenceFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class ValueFieldConfig

withSearchable

public ReferenceFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class ValueFieldConfig

withSearchable

public ReferenceFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class ValueFieldConfig

withDataModelState

public ReferenceFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class ValueFieldConfig

withFromDataModel

public ReferenceFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class ValueFieldConfig

withDataModelClass

public ReferenceFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class ValueFieldConfig

withDataModelProperty

public ReferenceFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class ValueFieldConfig

withMultivalued

public ReferenceFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class ValueFieldConfig

withMultivalued

public ReferenceFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class ValueFieldConfig

withVersion

public ReferenceFieldConfig withVersion(int version)

Overrides:

withVersion in class ValueFieldConfig

withVersion

public ReferenceFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class ValueFieldConfig

withListsEncoderConfig

public ReferenceFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class ValueFieldConfig

makeCopy

public ReferenceFieldConfig makeCopy()

Creates and returns a deep copy of this ReferenceFieldConfig.

Overrides:

makeCopy in class ValueFieldConfig

readFrom

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

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

Overrides:

writeTo in class ValueFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ReferenceFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ReferenceFieldConfig.

Overrides:

toString in class ValueFieldConfig

check

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

Checks this ReferenceFieldConfig.

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