com.exalead.mercury.mami.indexing.v10

Class NumericalFieldConfig

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DoubleFieldConfig, SignedFieldConfig, UnsignedFieldConfig

public abstract class NumericalFieldConfig
extends SortableFieldConfig
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NumericalFieldConfig.Transformer<T>
static interface	NumericalFieldConfig.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	bitsForValue
int	blockSize
static int	DEFAULT_BITS_FOR_VALUE
static int	DEFAULT_BLOCK_SIZE

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
NumericalFieldConfig()
NumericalFieldConfig(NumericalFieldConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(NumericalFieldConfig.Transformer<T> transformer, T[] t)
abstract void	accept(NumericalFieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this NumericalFieldConfig.
static NumericalFieldConfig	fromString(java.lang.String s) String representation of this NumericalFieldConfig.
int	getBitsForValue() Number of bits used to store numerical values. For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits. For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits.
int	getBlockSize()
NumericalFieldConfig	makeCopy()
static NumericalFieldConfig	readFrom(java.io.InputStream is) Read this NumericalFieldConfig from an XML fragment.
void	setBitsForValue(int bitsForValue) Number of bits used to store numerical values. For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits. For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits.
void	setBlockSize(int blockSize)
java.lang.String	toString() String representation of this NumericalFieldConfig.
NumericalFieldConfig	withBitsForValue(int bitsForValue)
NumericalFieldConfig	withBitsForValue(java.lang.Integer bitsForValue)
NumericalFieldConfig	withBlockSize(int blockSize)
NumericalFieldConfig	withBlockSize(java.lang.Integer blockSize)
NumericalFieldConfig	withDataModelClass(java.lang.String dataModelClass)
NumericalFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
NumericalFieldConfig	withDataModelState(java.lang.String dataModelState)
NumericalFieldConfig	withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)
NumericalFieldConfig	withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)
NumericalFieldConfig	withFieldName(java.lang.String fieldName)
NumericalFieldConfig	withFromDataModel(FieldConfig fromDataModel)
NumericalFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
NumericalFieldConfig	withMultiContext(boolean multiContext)
NumericalFieldConfig	withMultiContext(java.lang.Boolean multiContext)
NumericalFieldConfig	withMultivalued(boolean multivalued)
NumericalFieldConfig	withMultivalued(java.lang.Boolean multivalued)
NumericalFieldConfig	withRamBased(boolean ramBased)
NumericalFieldConfig	withRamBased(java.lang.Boolean ramBased)
NumericalFieldConfig	withRetrievable(boolean retrievable)
NumericalFieldConfig	withRetrievable(java.lang.Boolean retrievable)
NumericalFieldConfig	withSearchable(boolean searchable)
NumericalFieldConfig	withSearchable(java.lang.Boolean searchable)
NumericalFieldConfig	withSortMultivaluedValues(boolean sortMultivaluedValues)
NumericalFieldConfig	withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)
NumericalFieldConfig	withVersion(int version)
NumericalFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os)

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

accept, accept, isDeltaRefEncodeMultivaluedValues, isSortMultivaluedValues, setDeltaRefEncodeMultivaluedValues, setSortMultivaluedValues

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

accept, accept, isMultiContext, isRamBased, setMultiContext, setRamBased

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

accept, accept, 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

bitsForValue

public int bitsForValue

DEFAULT_BITS_FOR_VALUE

public static final int DEFAULT_BITS_FOR_VALUE

See Also:

Constant Field Values

blockSize

public int blockSize

DEFAULT_BLOCK_SIZE

public static final int DEFAULT_BLOCK_SIZE

See Also:

Constant Field Values

Constructor Detail

NumericalFieldConfig

public NumericalFieldConfig()

NumericalFieldConfig

public NumericalFieldConfig(NumericalFieldConfig o)

Copy constructor

Method Detail

withDeltaRefEncodeMultivaluedValues

public NumericalFieldConfig withDeltaRefEncodeMultivaluedValues(boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class SortableFieldConfig

withDeltaRefEncodeMultivaluedValues

public NumericalFieldConfig withDeltaRefEncodeMultivaluedValues(java.lang.Boolean deltaRefEncodeMultivaluedValues)

Overrides:

withDeltaRefEncodeMultivaluedValues in class SortableFieldConfig

withSortMultivaluedValues

public NumericalFieldConfig withSortMultivaluedValues(boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class SortableFieldConfig

withSortMultivaluedValues

public NumericalFieldConfig withSortMultivaluedValues(java.lang.Boolean sortMultivaluedValues)

Overrides:

withSortMultivaluedValues in class SortableFieldConfig

withRamBased

public NumericalFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class SortableFieldConfig

withRamBased

public NumericalFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class SortableFieldConfig

withMultiContext

public NumericalFieldConfig withMultiContext(boolean multiContext)

Overrides:

withMultiContext in class SortableFieldConfig

withMultiContext

public NumericalFieldConfig withMultiContext(java.lang.Boolean multiContext)

Overrides:

withMultiContext in class SortableFieldConfig

withFieldName

public NumericalFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class SortableFieldConfig

withSearchable

public NumericalFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class SortableFieldConfig

withSearchable

public NumericalFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class SortableFieldConfig

withRetrievable

public NumericalFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class SortableFieldConfig

withRetrievable

public NumericalFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class SortableFieldConfig

withDataModelState

public NumericalFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SortableFieldConfig

withFromDataModel

public NumericalFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class SortableFieldConfig

withDataModelClass

public NumericalFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SortableFieldConfig

withDataModelProperty

public NumericalFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SortableFieldConfig

withMultivalued

public NumericalFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class SortableFieldConfig

withMultivalued

public NumericalFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class SortableFieldConfig

withVersion

public NumericalFieldConfig withVersion(int version)

Overrides:

withVersion in class SortableFieldConfig

withVersion

public NumericalFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class SortableFieldConfig

withListsEncoderConfig

public NumericalFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class SortableFieldConfig

setBitsForValue

public void setBitsForValue(int bitsForValue)

Number of bits used to store numerical values.
For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits.
For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits.

getBitsForValue

public int getBitsForValue()

Number of bits used to store numerical values.
For unsigned numerical fields, the possible values are [0; 2^N - 1], and the field values are stored on N bits.
For signed fields (signed integer and double), the possible values are [-2^N, 2^N - 1], and the field values are stored on (N+1) bits.

withBitsForValue

public NumericalFieldConfig withBitsForValue(int bitsForValue)

withBitsForValue

public NumericalFieldConfig withBitsForValue(java.lang.Integer bitsForValue)

setBlockSize

public void setBlockSize(int blockSize)

getBlockSize

public int getBlockSize()

withBlockSize

public NumericalFieldConfig withBlockSize(int blockSize)

withBlockSize

public NumericalFieldConfig withBlockSize(java.lang.Integer blockSize)

makeCopy

public NumericalFieldConfig makeCopy()

Overrides:

makeCopy in class SortableFieldConfig

readFrom

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

Read this NumericalFieldConfig 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

Overrides:

writeTo in class SortableFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this NumericalFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this NumericalFieldConfig.

Overrides:

toString in class SortableFieldConfig

check

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

Checks this NumericalFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SortableFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException