com.exalead.mercury.mami.indexing.v10

Class HierarchyFieldConfig

java.lang.Object

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

com.exalead.mercury.mami.indexing.v10.CategoryFieldConfig

com.exalead.mercury.mami.indexing.v10.HierarchyFieldConfig

All Implemented Interfaces:

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

public class HierarchyFieldConfig
extends CategoryFieldConfig
implements com.exalead.util.Checkable, java.io.Serializable

Stores hierarchy content. 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.CategoryFieldConfig

CategoryFieldConfig.Implementation, CategoryFieldConfig.Transformer<T>, CategoryFieldConfig.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.CategoryFieldConfig

DEFAULT_IMPLEMENTATION, DEFAULT_RAM_BASED, implementation, 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
HierarchyFieldConfig()
HierarchyFieldConfig(HierarchyFieldConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(CategoryFieldConfig.Transformer<T> transformer, T[] t)
void	accept(CategoryFieldConfig.Visitor visitor)
<T> T	accept(FieldConfig.Transformer<T> transformer, T[] t)
void	accept(FieldConfig.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this HierarchyFieldConfig.
static HierarchyFieldConfig	fromString(java.lang.String s) String representation of this HierarchyFieldConfig.
HierarchyFieldConfig	makeCopy() Creates and returns a deep copy of this HierarchyFieldConfig.
static HierarchyFieldConfig	readFrom(java.io.InputStream is) Read this HierarchyFieldConfig from an XML fragment.
java.lang.String	toString() String representation of this HierarchyFieldConfig.
HierarchyFieldConfig	withDataModelClass(java.lang.String dataModelClass)
HierarchyFieldConfig	withDataModelProperty(java.lang.String dataModelProperty)
HierarchyFieldConfig	withDataModelState(java.lang.String dataModelState)
HierarchyFieldConfig	withFieldName(java.lang.String fieldName)
HierarchyFieldConfig	withFromDataModel(FieldConfig fromDataModel)
HierarchyFieldConfig	withImplementation(java.lang.String implementation)
HierarchyFieldConfig	withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)
HierarchyFieldConfig	withMultivalued(boolean multivalued)
HierarchyFieldConfig	withMultivalued(java.lang.Boolean multivalued)
HierarchyFieldConfig	withRamBased(boolean ramBased)
HierarchyFieldConfig	withRamBased(java.lang.Boolean ramBased)
HierarchyFieldConfig	withRetrievable(boolean retrievable)
HierarchyFieldConfig	withRetrievable(java.lang.Boolean retrievable)
HierarchyFieldConfig	withSearchable(boolean searchable)
HierarchyFieldConfig	withSearchable(java.lang.Boolean searchable)
HierarchyFieldConfig	withVersion(int version)
HierarchyFieldConfig	withVersion(java.lang.Integer version)
void	writeTo(java.io.OutputStream os) Write this HierarchyFieldConfig as an XML fragment

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

getImplementation, getImplementationAsEnum, isA, isOneOf, isRamBased, setImplementation, setImplementation, 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

HierarchyFieldConfig

public HierarchyFieldConfig()

HierarchyFieldConfig

public HierarchyFieldConfig(HierarchyFieldConfig o)

Copy constructor

Method Detail

withRamBased

public HierarchyFieldConfig withRamBased(boolean ramBased)

Overrides:

withRamBased in class CategoryFieldConfig

withRamBased

public HierarchyFieldConfig withRamBased(java.lang.Boolean ramBased)

Overrides:

withRamBased in class CategoryFieldConfig

withImplementation

public HierarchyFieldConfig withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class CategoryFieldConfig

withFieldName

public HierarchyFieldConfig withFieldName(java.lang.String fieldName)

Overrides:

withFieldName in class CategoryFieldConfig

withSearchable

public HierarchyFieldConfig withSearchable(boolean searchable)

Overrides:

withSearchable in class CategoryFieldConfig

withSearchable

public HierarchyFieldConfig withSearchable(java.lang.Boolean searchable)

Overrides:

withSearchable in class CategoryFieldConfig

withRetrievable

public HierarchyFieldConfig withRetrievable(boolean retrievable)

Overrides:

withRetrievable in class CategoryFieldConfig

withRetrievable

public HierarchyFieldConfig withRetrievable(java.lang.Boolean retrievable)

Overrides:

withRetrievable in class CategoryFieldConfig

withDataModelState

public HierarchyFieldConfig withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class CategoryFieldConfig

withFromDataModel

public HierarchyFieldConfig withFromDataModel(FieldConfig fromDataModel)

Overrides:

withFromDataModel in class CategoryFieldConfig

withDataModelClass

public HierarchyFieldConfig withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class CategoryFieldConfig

withDataModelProperty

public HierarchyFieldConfig withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class CategoryFieldConfig

withMultivalued

public HierarchyFieldConfig withMultivalued(boolean multivalued)

Overrides:

withMultivalued in class CategoryFieldConfig

withMultivalued

public HierarchyFieldConfig withMultivalued(java.lang.Boolean multivalued)

Overrides:

withMultivalued in class CategoryFieldConfig

withVersion

public HierarchyFieldConfig withVersion(int version)

Overrides:

withVersion in class CategoryFieldConfig

withVersion

public HierarchyFieldConfig withVersion(java.lang.Integer version)

Overrides:

withVersion in class CategoryFieldConfig

withListsEncoderConfig

public HierarchyFieldConfig withListsEncoderConfig(ListsEncoderConfig listsEncoderConfig)

Overrides:

withListsEncoderConfig in class CategoryFieldConfig

makeCopy

public HierarchyFieldConfig makeCopy()

Creates and returns a deep copy of this HierarchyFieldConfig.

Overrides:

makeCopy in class CategoryFieldConfig

readFrom

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

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

Overrides:

writeTo in class CategoryFieldConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this HierarchyFieldConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this HierarchyFieldConfig.

Overrides:

toString in class CategoryFieldConfig

check

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

Checks this HierarchyFieldConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CategoryFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class CategoryFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class CategoryFieldConfig

Throws:

com.exalead.util.TypedException

accept

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

Overrides:

accept in class CategoryFieldConfig

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 CategoryFieldConfig

Throws:

com.exalead.util.TypedException