com.exalead.mercury.mami.indexing.v10

Class AttributeGroupStore

java.lang.Object

com.exalead.mercury.mami.indexing.v10.AttributeGroupStore

All Implemented Interfaces:

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

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

Configuration of an attribute group. An attribute group define how attributes should be persisted on disk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributeGroupStore.Format

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FORMAT
static int	DEFAULT_LEAF_SIZE
java.lang.String	format
int	id
java.lang.String	label
int	leafSize
java.lang.String	retrievableRoles

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AttributeGroupStore.
static AttributeGroupStore	fromString(java.lang.String s) String representation of this AttributeGroupStore.
java.lang.String	getFormat() Specifies how to persist the data on disk for this attribute group.
AttributeGroupStore.Format	getFormatAsEnum() Specifies how to persist the data on disk for this attribute group.
int	getId() A unique identifier for this attribute group.
java.lang.String	getLabel() A human readable name for this attribute group.
int	getLeafSize() If the format is SimpleRowOrientedStore, configures the leaf size (i.e., maximum IO size read per DID).
java.lang.String	getRetrievableRoles() Specifies a comma-separated list of annotations to be handled in this attribute group store.
static boolean	isA(java.lang.String str, AttributeGroupStore.Format item)
static boolean	isOneOf(java.lang.String str, AttributeGroupStore.Format... items)
AttributeGroupStore	makeCopy() Creates and returns a deep copy of this AttributeGroupStore.
static AttributeGroupStore	readFrom(java.io.InputStream is) Read this AttributeGroupStore from an XML fragment.
void	setFormat(AttributeGroupStore.Format item) Specifies how to persist the data on disk for this attribute group.
void	setFormat(java.lang.String format) Specifies how to persist the data on disk for this attribute group.
void	setId(int id) A unique identifier for this attribute group.
void	setLabel(java.lang.String label) A human readable name for this attribute group.
void	setLeafSize(int leafSize) If the format is SimpleRowOrientedStore, configures the leaf size (i.e., maximum IO size read per DID).
void	setRetrievableRoles(java.lang.String retrievableRoles) Specifies a comma-separated list of annotations to be handled in this attribute group store.
java.lang.String	toString() String representation of this AttributeGroupStore.
AttributeGroupStore	withFormat(java.lang.String format)
AttributeGroupStore	withId(int id)
AttributeGroupStore	withId(java.lang.Integer id)
AttributeGroupStore	withLabel(java.lang.String label)
AttributeGroupStore	withLeafSize(int leafSize)
AttributeGroupStore	withLeafSize(java.lang.Integer leafSize)
AttributeGroupStore	withRetrievableRoles(java.lang.String retrievableRoles)
void	writeTo(java.io.OutputStream os) Write this AttributeGroupStore as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

id

public int id

label

public java.lang.String label

format

public java.lang.String format

DEFAULT_FORMAT

public static final java.lang.String DEFAULT_FORMAT

See Also:

Constant Field Values

retrievableRoles

public java.lang.String retrievableRoles

leafSize

public int leafSize

DEFAULT_LEAF_SIZE

public static final int DEFAULT_LEAF_SIZE

See Also:

Constant Field Values

Constructor Detail

AttributeGroupStore

public AttributeGroupStore()

AttributeGroupStore

public AttributeGroupStore(AttributeGroupStore o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          AttributeGroupStore.Format item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              AttributeGroupStore.Format... items)

setFormat

public void setFormat(AttributeGroupStore.Format item)

Specifies how to persist the data on disk for this attribute group.

getFormatAsEnum

public AttributeGroupStore.Format getFormatAsEnum()

Specifies how to persist the data on disk for this attribute group.

setId

public void setId(int id)

A unique identifier for this attribute group.

getId

public int getId()

A unique identifier for this attribute group.

withId

public AttributeGroupStore withId(int id)

withId

public AttributeGroupStore withId(java.lang.Integer id)

setLabel

public void setLabel(java.lang.String label)

A human readable name for this attribute group.

getLabel

public java.lang.String getLabel()

A human readable name for this attribute group.

withLabel

public AttributeGroupStore withLabel(java.lang.String label)

setFormat

public void setFormat(java.lang.String format)

Specifies how to persist the data on disk for this attribute group.

getFormat

public java.lang.String getFormat()

Specifies how to persist the data on disk for this attribute group.

withFormat

public AttributeGroupStore withFormat(java.lang.String format)

setRetrievableRoles

public void setRetrievableRoles(java.lang.String retrievableRoles)

Specifies a comma-separated list of annotations to be handled in this attribute group store. Ex: @Facetable,@Sortable,@Display

getRetrievableRoles

public java.lang.String getRetrievableRoles()

Specifies a comma-separated list of annotations to be handled in this attribute group store. Ex: @Facetable,@Sortable,@Display

withRetrievableRoles

public AttributeGroupStore withRetrievableRoles(java.lang.String retrievableRoles)

setLeafSize

public void setLeafSize(int leafSize)

If the format is SimpleRowOrientedStore, configures the leaf size (i.e., maximum IO size read per DID).

getLeafSize

public int getLeafSize()

If the format is SimpleRowOrientedStore, configures the leaf size (i.e., maximum IO size read per DID).

withLeafSize

public AttributeGroupStore withLeafSize(int leafSize)

withLeafSize

public AttributeGroupStore withLeafSize(java.lang.Integer leafSize)

makeCopy

public AttributeGroupStore makeCopy()

Creates and returns a deep copy of this AttributeGroupStore.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AttributeGroupStore.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AttributeGroupStore.

Overrides:

toString in class java.lang.Object

check

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

Checks this AttributeGroupStore.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException