com.exalead.mercury.mami.indexing.v10

Class FieldRuntimeConfig

java.lang.Object

com.exalead.mercury.mami.indexing.v10.FieldRuntimeConfig

All Implemented Interfaces:

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

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

Configuration specifying the index field at runtime.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldRuntimeConfig.DictType
static class	FieldRuntimeConfig.Type

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	cacheId
static java.lang.String	DEFAULT_DICT_TYPE
static boolean	DEFAULT_MLOCK
static boolean	DEFAULT_PRELOAD
static java.lang.String	DEFAULT_TYPE
java.lang.String	dictType
boolean	mlock
java.lang.String	name
boolean	preload
java.lang.String	type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FieldRuntimeConfig.
static FieldRuntimeConfig	fromString(java.lang.String s) String representation of this FieldRuntimeConfig.
java.lang.String	getCacheId() If PageCache is used, it specifies the cache ID.
java.lang.String	getDictType() Specifies the I/O mode used to load the dictionary part of an index field.
FieldRuntimeConfig.DictType	getDictTypeAsEnum() Specifies the I/O mode used to load the dictionary part of an index field.
java.lang.String	getName() The index field name.
java.lang.String	getType() Specifies the I/O mode used to load the component.
FieldRuntimeConfig.Type	getTypeAsEnum() Specifies the I/O mode used to load the component.
static boolean	isA(java.lang.String str, FieldRuntimeConfig.DictType item)
static boolean	isA(java.lang.String str, FieldRuntimeConfig.Type item)
boolean	isMlock() Should the field be locked in RAM.
static boolean	isOneOf(java.lang.String str, FieldRuntimeConfig.DictType... items)
static boolean	isOneOf(java.lang.String str, FieldRuntimeConfig.Type... items)
boolean	isPreload() Should the field be preloaded? This will force the field to be loaded in RAM at startup.
FieldRuntimeConfig	makeCopy() Creates and returns a deep copy of this FieldRuntimeConfig.
static FieldRuntimeConfig	readFrom(java.io.InputStream is) Read this FieldRuntimeConfig from an XML fragment.
void	setCacheId(java.lang.String cacheId) If PageCache is used, it specifies the cache ID.
void	setDictType(FieldRuntimeConfig.DictType item) Specifies the I/O mode used to load the dictionary part of an index field.
void	setDictType(java.lang.String dictType) Specifies the I/O mode used to load the dictionary part of an index field.
void	setMlock(boolean mlock) Should the field be locked in RAM.
void	setName(java.lang.String name) The index field name.
void	setPreload(boolean preload) Should the field be preloaded? This will force the field to be loaded in RAM at startup.
void	setType(FieldRuntimeConfig.Type item) Specifies the I/O mode used to load the component.
void	setType(java.lang.String type) Specifies the I/O mode used to load the component.
java.lang.String	toString() String representation of this FieldRuntimeConfig.
FieldRuntimeConfig	withCacheId(java.lang.String cacheId)
FieldRuntimeConfig	withDictType(java.lang.String dictType)
FieldRuntimeConfig	withMlock(boolean mlock)
FieldRuntimeConfig	withMlock(java.lang.Boolean mlock)
FieldRuntimeConfig	withName(java.lang.String name)
FieldRuntimeConfig	withPreload(boolean preload)
FieldRuntimeConfig	withPreload(java.lang.Boolean preload)
FieldRuntimeConfig	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this FieldRuntimeConfig 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

dictType

public java.lang.String dictType

DEFAULT_DICT_TYPE

public static final java.lang.String DEFAULT_DICT_TYPE

See Also:

Constant Field Values

type

public java.lang.String type

DEFAULT_TYPE

public static final java.lang.String DEFAULT_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

FieldRuntimeConfig

public FieldRuntimeConfig()

FieldRuntimeConfig

public FieldRuntimeConfig(FieldRuntimeConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          FieldRuntimeConfig.DictType item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              FieldRuntimeConfig.DictType... items)

setDictType

public void setDictType(FieldRuntimeConfig.DictType item)

Specifies the I/O mode used to load the dictionary part of an index field. ( Value can be one of

• mmap
• pagecache

)

getDictTypeAsEnum

public FieldRuntimeConfig.DictType getDictTypeAsEnum()

Specifies the I/O mode used to load the dictionary part of an index field. ( Value can be one of

• mmap
• pagecache

)

isA

public static boolean isA(java.lang.String str,
                          FieldRuntimeConfig.Type item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              FieldRuntimeConfig.Type... items)

setType

public void setType(FieldRuntimeConfig.Type item)

Specifies the I/O mode used to load the component. ( Value can be one of

• mmap
• pagecache

)

getTypeAsEnum

public FieldRuntimeConfig.Type getTypeAsEnum()

Specifies the I/O mode used to load the component. ( Value can be one of

• mmap
• pagecache

)

setName

public void setName(java.lang.String name)

The index field name.

getName

public java.lang.String getName()

The index field name.

withName

public FieldRuntimeConfig withName(java.lang.String name)

setDictType

public void setDictType(java.lang.String dictType)

Specifies the I/O mode used to load the dictionary part of an index field. ( Value can be one of

• mmap
• pagecache

)

getDictType

public java.lang.String getDictType()

Specifies the I/O mode used to load the dictionary part of an index field. ( Value can be one of

• mmap
• pagecache

)

withDictType

public FieldRuntimeConfig withDictType(java.lang.String dictType)

setType

public void setType(java.lang.String type)

Specifies the I/O mode used to load the component. ( Value can be one of

• mmap
• pagecache

)

getType

public java.lang.String getType()

Specifies the I/O mode used to load the component. ( Value can be one of

• mmap
• pagecache

)

withType

public FieldRuntimeConfig withType(java.lang.String type)

setPreload

public void setPreload(boolean preload)

Should the field be preloaded? This will force the field to be loaded in RAM at startup.

isPreload

public boolean isPreload()

Should the field be preloaded? This will force the field to be loaded in RAM at startup.

withPreload

public FieldRuntimeConfig withPreload(boolean preload)

withPreload

public FieldRuntimeConfig withPreload(java.lang.Boolean preload)

setMlock

public void setMlock(boolean mlock)

Should the field be locked in RAM.

isMlock

public boolean isMlock()

Should the field be locked in RAM.

withMlock

public FieldRuntimeConfig withMlock(boolean mlock)

withMlock

public FieldRuntimeConfig withMlock(java.lang.Boolean mlock)

setCacheId

public void setCacheId(java.lang.String cacheId)

If PageCache is used, it specifies the cache ID.

getCacheId

public java.lang.String getCacheId()

If PageCache is used, it specifies the cache ID.

withCacheId

public FieldRuntimeConfig withCacheId(java.lang.String cacheId)

makeCopy

public FieldRuntimeConfig makeCopy()

Creates and returns a deep copy of this FieldRuntimeConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FieldRuntimeConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FieldRuntimeConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this FieldRuntimeConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException