com.exalead.mercury.mami.indexing.v10

Class IndexSchema

java.lang.Object

com.exalead.mercury.mami.indexing.v10.IndexSchema

All Implemented Interfaces:

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

public class IndexSchema
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for an index schema. This defines the fields actually stored in an index.
Most commonly, only one index schema is defined, and used by all build groups (for all slices).
This configuration is referenced in the BuildGroup element in 'Deployment'.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	allowIntensiveDiskAccess
java.util.List<AttributeGroupStore>	attributeGroupStore
static boolean	DEFAULT_ALLOW_INTENSIVE_DISK_ACCESS
java.util.List<FieldConfig>	fieldConfig
java.lang.String	name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this IndexSchema.
static IndexSchema	fromString(java.lang.String s) String representation of this IndexSchema.
java.util.List<AttributeGroupStore>	getAttributeGroupStore()
java.util.List<FieldConfig>	getFieldConfig()
java.util.Map<java.lang.String,FieldConfig>	getFieldConfigAsMap() Get the map of FieldConfig, indexed by fieldName
FieldConfig	getFieldConfigByFieldName(java.lang.String _lookup) Get the FieldConfig for which the fieldName matches _lookup
java.lang.String	getName()
boolean	isAllowIntensiveDiskAccess() Allows intensive operations like sorting or faceting to be performed on disk (SSD should be preferred).
IndexSchema	makeCopy() Creates and returns a deep copy of this IndexSchema.
static IndexSchema	readFrom(java.io.InputStream is) Read this IndexSchema from an XML fragment.
boolean	removeFieldConfigByFieldName(java.lang.String _lookup) Removes the FieldConfig for which the fieldName matches _lookup
void	setAllowIntensiveDiskAccess(boolean allowIntensiveDiskAccess) Allows intensive operations like sorting or faceting to be performed on disk (SSD should be preferred).
void	setName(java.lang.String name)
java.lang.String	toString() String representation of this IndexSchema.
IndexSchema	withAllowIntensiveDiskAccess(boolean allowIntensiveDiskAccess)
IndexSchema	withAllowIntensiveDiskAccess(java.lang.Boolean allowIntensiveDiskAccess)
IndexSchema	withAttributeGroupStore(AttributeGroupStore... __values)
IndexSchema	withAttributeGroupStore(java.util.Collection<AttributeGroupStore> __values)
IndexSchema	withFieldConfig(java.util.Collection<FieldConfig> __values)
IndexSchema	withFieldConfig(FieldConfig... __values)
IndexSchema	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this IndexSchema as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

fieldConfig

public java.util.List<FieldConfig> fieldConfig

attributeGroupStore

public java.util.List<AttributeGroupStore> attributeGroupStore

allowIntensiveDiskAccess

public boolean allowIntensiveDiskAccess

DEFAULT_ALLOW_INTENSIVE_DISK_ACCESS

public static final boolean DEFAULT_ALLOW_INTENSIVE_DISK_ACCESS

See Also:

Constant Field Values

Constructor Detail

IndexSchema

public IndexSchema()

IndexSchema

public IndexSchema(IndexSchema o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public IndexSchema withName(java.lang.String name)

getFieldConfig

public java.util.List<FieldConfig> getFieldConfig()

getFieldConfigByFieldName

public FieldConfig getFieldConfigByFieldName(java.lang.String _lookup)

Get the FieldConfig for which the fieldName matches _lookup

Returns:

null if no matching FieldConfig is found

getFieldConfigAsMap

public java.util.Map<java.lang.String,FieldConfig> getFieldConfigAsMap()

Get the map of FieldConfig, indexed by fieldName

removeFieldConfigByFieldName

public boolean removeFieldConfigByFieldName(java.lang.String _lookup)

Removes the FieldConfig for which the fieldName matches _lookup

Returns:

false if no matching FieldConfig is found, true if one was found

withFieldConfig

public IndexSchema withFieldConfig(FieldConfig... __values)

withFieldConfig

public IndexSchema withFieldConfig(java.util.Collection<FieldConfig> __values)

getAttributeGroupStore

public java.util.List<AttributeGroupStore> getAttributeGroupStore()

withAttributeGroupStore

public IndexSchema withAttributeGroupStore(AttributeGroupStore... __values)

withAttributeGroupStore

public IndexSchema withAttributeGroupStore(java.util.Collection<AttributeGroupStore> __values)

setAllowIntensiveDiskAccess

public void setAllowIntensiveDiskAccess(boolean allowIntensiveDiskAccess)

Allows intensive operations like sorting or faceting to be performed on disk
(SSD should be preferred).

isAllowIntensiveDiskAccess

public boolean isAllowIntensiveDiskAccess()

Allows intensive operations like sorting or faceting to be performed on disk
(SSD should be preferred).

withAllowIntensiveDiskAccess

public IndexSchema withAllowIntensiveDiskAccess(boolean allowIntensiveDiskAccess)

withAllowIntensiveDiskAccess

public IndexSchema withAllowIntensiveDiskAccess(java.lang.Boolean allowIntensiveDiskAccess)

makeCopy

public IndexSchema makeCopy()

Creates and returns a deep copy of this IndexSchema.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this IndexSchema.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this IndexSchema.

Overrides:

toString in class java.lang.Object

check

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

Checks this IndexSchema.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException