com.exalead.mercury.mami.indexing.v10

Class FieldConfig

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CategoryFieldConfig, StandardFieldConfig

public abstract class FieldConfig
extends java.lang.Object
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 class	FieldConfig.FromDataModel
static interface	FieldConfig.Transformer<T>
static interface	FieldConfig.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_MULTIVALUED
static boolean	DEFAULT_RETRIEVABLE
static boolean	DEFAULT_SEARCHABLE
static int	DEFAULT_VERSION
java.lang.String	fieldName
protected FieldConfig.FromDataModel	fromDataModel
ListsEncoderConfig	listsEncoderConfig
boolean	multivalued
boolean	retrievable
boolean	searchable
int	version

Constructor Summary

Constructors

Constructor and Description
FieldConfig()
FieldConfig(FieldConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(FieldConfig.Transformer<T> transformer, T[] t)
abstract void	accept(FieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this FieldConfig.
static FieldConfig	fromString(java.lang.String s) String representation of this FieldConfig.
java.lang.String	getDataModelClass() If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config.
java.lang.String	getDataModelState() Is this index field config managed by a data model?
java.lang.String	getFieldName() The name of the field. The name of a field can only contain lower-case characters, numbers and underscore.
FieldConfig.FromDataModel	getFromDataModel()
ListsEncoderConfig	getListsEncoderConfig() Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used.
int	getVersion()
boolean	isMultivalued()
boolean	isRetrievable() Allows the content of this field to be retrieved at query time and displayed in the search results.
boolean	isSearchable() Allows users to query on this field (using a prefix handler).
FieldConfig	makeCopy()
static FieldConfig	readFrom(java.io.InputStream is) Read this FieldConfig from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or customized", you will find here the name of the DataModelClass that generated this field config.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is "auto" or customized", you will find here the name of the DataModelProperty that generated this field config.
void	setDataModelState(java.lang.String dataModelState) Is this index field config managed by a data model?
void	setFieldName(java.lang.String fieldName) The name of the field. The name of a field can only contain lower-case characters, numbers and underscore.
void	setFromDataModel(FieldConfig.FromDataModel __value)
void	setListsEncoderConfig(ListsEncoderConfig listsEncoderConfig) Configuration of the inverted lists encoder. If no configuration is specified, a Rice encoder is used.
void	setMultivalued(boolean multivalued)
void	setRetrievable(boolean retrievable) Allows the content of this field to be retrieved at query time and displayed in the search results.
void	setSearchable(boolean searchable) Allows users to query on this field (using a prefix handler).
void	setVersion(int version)
java.lang.String	toString() String representation of this FieldConfig.
FieldConfig	withDataModelClass(java.lang.String dataModelClass)
FieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
FieldConfig	withDataModelState(java.lang.String dataModelState)
FieldConfig	withFieldName(java.lang.String fieldName)
FieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
FieldConfig	withMultivalued(boolean multivalued)
FieldConfig	withMultivalued(java.lang.Boolean multivalued)
FieldConfig	withRetrievable(boolean retrievable)
FieldConfig	withRetrievable(java.lang.Boolean retrievable)
FieldConfig	withSearchable(boolean searchable)
FieldConfig	withSearchable(java.lang.Boolean searchable)
FieldConfig	withVersion(int version)
FieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fieldName

public java.lang.String fieldName

searchable

public boolean searchable

DEFAULT_SEARCHABLE

public static final boolean DEFAULT_SEARCHABLE

See Also:

Constant Field Values

retrievable

public boolean retrievable

DEFAULT_RETRIEVABLE

public static final boolean DEFAULT_RETRIEVABLE

See Also:

Constant Field Values

dataModelState

public java.lang.String dataModelState

fromDataModel

protected FieldConfig.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

multivalued

public boolean multivalued

DEFAULT_MULTIVALUED

public static final boolean DEFAULT_MULTIVALUED

See Also:

Constant Field Values

version

public int version

DEFAULT_VERSION

public static final int DEFAULT_VERSION

See Also:

Constant Field Values

listsEncoderConfig

public ListsEncoderConfig listsEncoderConfig

Constructor Detail

FieldConfig

public FieldConfig()

FieldConfig

public FieldConfig(FieldConfig o)

Copy constructor

Method Detail

setFieldName

public void setFieldName(java.lang.String fieldName)

The name of the field.
The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+

getFieldName

public java.lang.String getFieldName()

The name of the field.
The name of a field can only contain lower-case characters, numbers and underscore. [a-z0-9_]+

withFieldName

public FieldConfig withFieldName(java.lang.String fieldName)

setSearchable

public void setSearchable(boolean searchable)

Allows users to query on this field (using a prefix handler).

isSearchable

public boolean isSearchable()

Allows users to query on this field (using a prefix handler).

withSearchable

public FieldConfig withSearchable(boolean searchable)

withSearchable

public FieldConfig withSearchable(java.lang.Boolean searchable)

setRetrievable

public void setRetrievable(boolean retrievable)

Allows the content of this field to be retrieved at query time and displayed in the search results.

isRetrievable

public boolean isRetrievable()

Allows the content of this field to be retrieved at query time and displayed in the search results.

withRetrievable

public FieldConfig withRetrievable(boolean retrievable)

withRetrievable

public FieldConfig withRetrievable(java.lang.Boolean retrievable)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this index field config managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this index field config managed by a data model?

withDataModelState

public FieldConfig withDataModelState(java.lang.String dataModelState)

getFromDataModel

public FieldConfig.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(FieldConfig.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is "auto" or customized", you will find here the
name of the DataModelClass that generated this field config.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is "auto" or customized", you will find here the
name of the DataModelClass that generated this field config.

withDataModelClass

public FieldConfig withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is "auto" or customized", you will find here the
name of the DataModelProperty that generated this field config.

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is "auto" or customized", you will find here the
name of the DataModelProperty that generated this field config.

withDataModelProperty

public FieldConfig withDataModelProperty(java.lang.String dataModelProperty)

setMultivalued

public void setMultivalued(boolean multivalued)

isMultivalued

public boolean isMultivalued()

withMultivalued

public FieldConfig withMultivalued(boolean multivalued)

withMultivalued

public FieldConfig withMultivalued(java.lang.Boolean multivalued)

setVersion

public void setVersion(int version)

getVersion

public int getVersion()

withVersion

public FieldConfig withVersion(int version)

withVersion

public FieldConfig withVersion(java.lang.Integer version)

setListsEncoderConfig

public void setListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Configuration of the inverted lists encoder.
If no configuration is specified, a Rice encoder is used.

getListsEncoderConfig

public ListsEncoderConfig getListsEncoderConfig()

Configuration of the inverted lists encoder.
If no configuration is specified, a Rice encoder is used.

withListsEncoderConfig

public FieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

makeCopy

public FieldConfig makeCopy()

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FieldConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this FieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException