com.exalead.mercury.mami.indexing.v10

Class AttributeGroupAccess

java.lang.Object

com.exalead.mercury.mami.indexing.v10.AttributeGroupAccess

All Implemented Interfaces:

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

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

Configuration specifying how to access the attribute group at runtime.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AttributeGroupAccess.RunType

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	cacheId
static boolean	DEFAULT_MLOCK
static boolean	DEFAULT_PRELOAD
static java.lang.String	DEFAULT_RUN_TYPE
java.lang.String	groupId
boolean	mlock
boolean	preload
java.lang.String	runType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AttributeGroupAccess.
static AttributeGroupAccess	fromString(java.lang.String s) String representation of this AttributeGroupAccess.
java.lang.String	getCacheId() For pagecache I/O type, specifies the cache ID.
java.lang.String	getGroupId() Specifies which attribute group store this access configuration applies to.
java.lang.String	getRunType() Specifies how the attribute group should be accessed at runtime.
AttributeGroupAccess.RunType	getRunTypeAsEnum() Specifies how the attribute group should be accessed at runtime.
static boolean	isA(java.lang.String str, AttributeGroupAccess.RunType item)
boolean	isMlock() For RAM-based access type, specifies if the attribute group should be locked in RAM.
static boolean	isOneOf(java.lang.String str, AttributeGroupAccess.RunType... items)
boolean	isPreload() For RAM-based access type, specifies if the attribute group should be loaded in RAM at startup instead of at access time.
AttributeGroupAccess	makeCopy() Creates and returns a deep copy of this AttributeGroupAccess.
static AttributeGroupAccess	readFrom(java.io.InputStream is) Read this AttributeGroupAccess from an XML fragment.
void	setCacheId(java.lang.String cacheId) For pagecache I/O type, specifies the cache ID.
void	setGroupId(java.lang.String groupId) Specifies which attribute group store this access configuration applies to.
void	setMlock(boolean mlock) For RAM-based access type, specifies if the attribute group should be locked in RAM.
void	setPreload(boolean preload) For RAM-based access type, specifies if the attribute group should be loaded in RAM at startup instead of at access time.
void	setRunType(AttributeGroupAccess.RunType item) Specifies how the attribute group should be accessed at runtime.
void	setRunType(java.lang.String runType) Specifies how the attribute group should be accessed at runtime.
java.lang.String	toString() String representation of this AttributeGroupAccess.
AttributeGroupAccess	withCacheId(java.lang.String cacheId)
AttributeGroupAccess	withGroupId(java.lang.String groupId)
AttributeGroupAccess	withMlock(boolean mlock)
AttributeGroupAccess	withMlock(java.lang.Boolean mlock)
AttributeGroupAccess	withPreload(boolean preload)
AttributeGroupAccess	withPreload(java.lang.Boolean preload)
AttributeGroupAccess	withRunType(java.lang.String runType)
void	writeTo(java.io.OutputStream os) Write this AttributeGroupAccess as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

groupId

public java.lang.String groupId

runType

public java.lang.String runType

DEFAULT_RUN_TYPE

public static final java.lang.String DEFAULT_RUN_TYPE

See Also:

Constant Field Values

preload

public boolean preload

DEFAULT_PRELOAD

public static final boolean DEFAULT_PRELOAD

See Also:

Constant Field Values

mlock

public boolean mlock

DEFAULT_MLOCK

public static final boolean DEFAULT_MLOCK

See Also:

Constant Field Values

cacheId

public java.lang.String cacheId

Constructor Detail

AttributeGroupAccess

public AttributeGroupAccess()

AttributeGroupAccess

public AttributeGroupAccess(AttributeGroupAccess o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          AttributeGroupAccess.RunType item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              AttributeGroupAccess.RunType... items)

setRunType

public void setRunType(AttributeGroupAccess.RunType item)

Specifies how the attribute group should be accessed at runtime.

getRunTypeAsEnum

public AttributeGroupAccess.RunType getRunTypeAsEnum()

Specifies how the attribute group should be accessed at runtime.

setGroupId

public void setGroupId(java.lang.String groupId)

Specifies which attribute group store this access configuration applies to.

getGroupId

public java.lang.String getGroupId()

Specifies which attribute group store this access configuration applies to.

withGroupId

public AttributeGroupAccess withGroupId(java.lang.String groupId)

setRunType

public void setRunType(java.lang.String runType)

Specifies how the attribute group should be accessed at runtime.

getRunType

public java.lang.String getRunType()

Specifies how the attribute group should be accessed at runtime.

withRunType

public AttributeGroupAccess withRunType(java.lang.String runType)

setPreload

public void setPreload(boolean preload)

For RAM-based access type, specifies if the attribute group should be loaded in RAM at startup instead of at access time.

isPreload

public boolean isPreload()

For RAM-based access type, specifies if the attribute group should be loaded in RAM at startup instead of at access time.

withPreload

public AttributeGroupAccess withPreload(boolean preload)

withPreload

public AttributeGroupAccess withPreload(java.lang.Boolean preload)

setMlock

public void setMlock(boolean mlock)

For RAM-based access type, specifies if the attribute group should be locked in RAM. Preventing it being moved to the swap area.

isMlock

public boolean isMlock()

For RAM-based access type, specifies if the attribute group should be locked in RAM. Preventing it being moved to the swap area.

withMlock

public AttributeGroupAccess withMlock(boolean mlock)

withMlock

public AttributeGroupAccess withMlock(java.lang.Boolean mlock)

setCacheId

public void setCacheId(java.lang.String cacheId)

For pagecache I/O type, specifies the cache ID.

getCacheId

public java.lang.String getCacheId()

For pagecache I/O type, specifies the cache ID.

withCacheId

public AttributeGroupAccess withCacheId(java.lang.String cacheId)

makeCopy

public AttributeGroupAccess makeCopy()

Creates and returns a deep copy of this AttributeGroupAccess.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AttributeGroupAccess.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AttributeGroupAccess.

Overrides:

toString in class java.lang.Object

check

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

Checks this AttributeGroupAccess.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException