com.exalead.mercury.mami.indexing.v10

Class UidFieldConfig

java.lang.Object

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

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

com.exalead.mercury.mami.indexing.v10.UidFieldConfig

All Implemented Interfaces:

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

public class UidFieldConfig
extends StandardFieldConfig
implements com.exalead.util.Checkable, java.io.Serializable

This field stores a unique value in order to facilitate search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UidFieldConfig.DictStorage

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

StandardFieldConfig.Transformer<T>, StandardFieldConfig.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
int	bitsetThreshold
static int	DEFAULT_BITSET_THRESHOLD
static java.lang.String	DEFAULT_DICT_STORAGE
java.lang.String	dictStorage

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
UidFieldConfig()
UidFieldConfig(UidFieldConfig 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(StandardFieldConfig.Transformer<T> transformer, T[] t)
void	accept(StandardFieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this UidFieldConfig.
static UidFieldConfig	fromString(java.lang.String s) String representation of this UidFieldConfig.
int	getBitsetThreshold() Number of requested documents before switching from a dynamic array to a bitset representation.
java.lang.String	getDictStorage() Associative array implementation.
UidFieldConfig.DictStorage	getDictStorageAsEnum() Associative array implementation.
static boolean	isA(java.lang.String str, UidFieldConfig.DictStorage item)
static boolean	isOneOf(java.lang.String str, UidFieldConfig.DictStorage... items)
UidFieldConfig	makeCopy() Creates and returns a deep copy of this UidFieldConfig.
static UidFieldConfig	readFrom(java.io.InputStream is) Read this UidFieldConfig from an XML fragment.
void	setBitsetThreshold(int bitsetThreshold) Number of requested documents before switching from a dynamic array to a bitset representation.
void	setDictStorage(java.lang.String dictStorage) Associative array implementation.
void	setDictStorage(UidFieldConfig.DictStorage item) Associative array implementation.
java.lang.String	toString() String representation of this UidFieldConfig.
UidFieldConfig	withBitsetThreshold(int bitsetThreshold)
UidFieldConfig	withBitsetThreshold(java.lang.Integer bitsetThreshold)
UidFieldConfig	withDataModelClass(java.lang.String dataModelClass)
UidFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
UidFieldConfig	withDataModelState(java.lang.String dataModelState)
UidFieldConfig	withDictStorage(java.lang.String dictStorage)
UidFieldConfig	withFieldName(java.lang.String fieldName)
UidFieldConfig	withFromDataModel(FieldConfig fromDataModel)
UidFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
UidFieldConfig	withMultiContext(boolean multiContext)
UidFieldConfig	withMultiContext(java.lang.Boolean multiContext)
UidFieldConfig	withMultivalued(boolean multivalued)
UidFieldConfig	withMultivalued(java.lang.Boolean multivalued)
UidFieldConfig	withRamBased(boolean ramBased)
UidFieldConfig	withRamBased(java.lang.Boolean ramBased)
UidFieldConfig	withRetrievable(boolean retrievable)
UidFieldConfig	withRetrievable(java.lang.Boolean retrievable)
UidFieldConfig	withSearchable(boolean searchable)
UidFieldConfig	withSearchable(java.lang.Boolean searchable)
UidFieldConfig	withVersion(int version)
UidFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this UidFieldConfig as an XML fragment

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

dictStorage

public java.lang.String dictStorage

DEFAULT_DICT_STORAGE

public static final java.lang.String DEFAULT_DICT_STORAGE

See Also:

Constant Field Values

bitsetThreshold

public int bitsetThreshold

DEFAULT_BITSET_THRESHOLD

public static final int DEFAULT_BITSET_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

UidFieldConfig

public UidFieldConfig()

UidFieldConfig

public UidFieldConfig(UidFieldConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          UidFieldConfig.DictStorage item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              UidFieldConfig.DictStorage... items)

setDictStorage

public void setDictStorage(UidFieldConfig.DictStorage item)

Associative array implementation.

getDictStorageAsEnum

public UidFieldConfig.DictStorage getDictStorageAsEnum()

Associative array implementation.

withRamBased

public UidFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withRamBased

public UidFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class StandardFieldConfig

withMultiContext

public UidFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withMultiContext

public UidFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class StandardFieldConfig

withFieldName

public UidFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class StandardFieldConfig

withSearchable

public UidFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withSearchable

public UidFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class StandardFieldConfig

withRetrievable

public UidFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withRetrievable

public UidFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class StandardFieldConfig

withDataModelState

public UidFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class StandardFieldConfig

withFromDataModel

public UidFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class StandardFieldConfig

withDataModelClass

public UidFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class StandardFieldConfig

withDataModelProperty

public UidFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class StandardFieldConfig

withMultivalued

public UidFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withMultivalued

public UidFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class StandardFieldConfig

withVersion

public UidFieldConfig withVersion(int version)

Overrides:

withVersion in class StandardFieldConfig

withVersion

public UidFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class StandardFieldConfig

withListsEncoderConfig

public UidFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class StandardFieldConfig

setDictStorage

public void setDictStorage(java.lang.String dictStorage)

Associative array implementation.

getDictStorage

public java.lang.String getDictStorage()

Associative array implementation.

withDictStorage

public UidFieldConfig withDictStorage(java.lang.String dictStorage)

setBitsetThreshold

public void setBitsetThreshold(int bitsetThreshold)

Number of requested documents before switching from a dynamic array to a bitset representation.

getBitsetThreshold

public int getBitsetThreshold()

Number of requested documents before switching from a dynamic array to a bitset representation.

withBitsetThreshold

public UidFieldConfig withBitsetThreshold(int bitsetThreshold)

withBitsetThreshold

public UidFieldConfig withBitsetThreshold(java.lang.Integer bitsetThreshold)

makeCopy

public UidFieldConfig makeCopy()

Creates and returns a deep copy of this UidFieldConfig.

Overrides:

makeCopy in class StandardFieldConfig

readFrom

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

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

Overrides:

writeTo in class StandardFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UidFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UidFieldConfig.

Overrides:

toString in class StandardFieldConfig

check

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

Checks this UidFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class StandardFieldConfig

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(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