com.exalead.mercury.mami.indexing.v10

Class StandardFieldConfig

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlphanumFieldConfig, BinaryFieldConfig, GeoFieldConfig, LegacySignedFieldConfig, LegacyUnsignedFieldConfig, PointFieldConfig, SortableFieldConfig, UidFieldConfig

public abstract class StandardFieldConfig
extends FieldConfig
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	StandardFieldConfig.Transformer<T>
static interface	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
static boolean	DEFAULT_MULTI_CONTEXT
static boolean	DEFAULT_RAM_BASED
boolean	multiContext
boolean	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
StandardFieldConfig()
StandardFieldConfig(StandardFieldConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(StandardFieldConfig.Transformer<T> transformer, T[] t)
abstract void	accept(StandardFieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this StandardFieldConfig.
static StandardFieldConfig	fromString(java.lang.String s) String representation of this StandardFieldConfig.
boolean	isMultiContext()
boolean	isRamBased() A value field must be RAM-based to perform synthesis efficiently.
StandardFieldConfig	makeCopy()
static StandardFieldConfig	readFrom(java.io.InputStream is) Read this StandardFieldConfig from an XML fragment.
void	setMultiContext(boolean multiContext)
void	setRamBased(boolean ramBased) A value field must be RAM-based to perform synthesis efficiently.
java.lang.String	toString() String representation of this StandardFieldConfig.
StandardFieldConfig	withDataModelClass(java.lang.String dataModelClass)
StandardFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
StandardFieldConfig	withDataModelState(java.lang.String dataModelState)
StandardFieldConfig	withFieldName(java.lang.String fieldName)
StandardFieldConfig	withFromDataModel(FieldConfig fromDataModel)
StandardFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
StandardFieldConfig	withMultiContext(boolean multiContext)
StandardFieldConfig	withMultiContext(java.lang.Boolean multiContext)
StandardFieldConfig	withMultivalued(boolean multivalued)
StandardFieldConfig	withMultivalued(java.lang.Boolean multivalued)
StandardFieldConfig	withRamBased(boolean ramBased)
StandardFieldConfig	withRamBased(java.lang.Boolean ramBased)
StandardFieldConfig	withRetrievable(boolean retrievable)
StandardFieldConfig	withRetrievable(java.lang.Boolean retrievable)
StandardFieldConfig	withSearchable(boolean searchable)
StandardFieldConfig	withSearchable(java.lang.Boolean searchable)
StandardFieldConfig	withVersion(int version)
StandardFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os)

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

ramBased

public boolean ramBased

DEFAULT_RAM_BASED

public static final boolean DEFAULT_RAM_BASED

See Also:

Constant Field Values

multiContext

public boolean multiContext

DEFAULT_MULTI_CONTEXT

public static final boolean DEFAULT_MULTI_CONTEXT

See Also:

Constant Field Values

Constructor Detail

StandardFieldConfig

public StandardFieldConfig()

StandardFieldConfig

public StandardFieldConfig(StandardFieldConfig o)

Copy constructor

Method Detail

withFieldName

public StandardFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class FieldConfig

withSearchable

public StandardFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class FieldConfig

withSearchable

public StandardFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class FieldConfig

withRetrievable

public StandardFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class FieldConfig

withRetrievable

public StandardFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class FieldConfig

withDataModelState

public StandardFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class FieldConfig

withFromDataModel

public StandardFieldConfig withFromDataModel(FieldConfig fromDataModel)

withDataModelClass

public StandardFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class FieldConfig

withDataModelProperty

public StandardFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class FieldConfig

withMultivalued

public StandardFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class FieldConfig

withMultivalued

public StandardFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class FieldConfig

withVersion

public StandardFieldConfig withVersion(int version)

Overrides:

withVersion in class FieldConfig

withVersion

public StandardFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class FieldConfig

withListsEncoderConfig

public StandardFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class FieldConfig

setRamBased

public void setRamBased(boolean ramBased)

A value field must be RAM-based to perform synthesis efficiently.

isRamBased

public boolean isRamBased()

A value field must be RAM-based to perform synthesis efficiently.

withRamBased

public StandardFieldConfig withRamBased(boolean ramBased)

withRamBased

public StandardFieldConfig withRamBased(java.lang.Boolean ramBased)

setMultiContext

public void setMultiContext(boolean multiContext)

isMultiContext

public boolean isMultiContext()

withMultiContext

public StandardFieldConfig withMultiContext(boolean multiContext)

withMultiContext

public StandardFieldConfig withMultiContext(java.lang.Boolean multiContext)

makeCopy

public StandardFieldConfig makeCopy()

Overrides:

makeCopy in class FieldConfig

readFrom

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

Read this StandardFieldConfig 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 FieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this StandardFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StandardFieldConfig.

Overrides:

toString in class FieldConfig

check

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

Checks this StandardFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class FieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException