com.exalead.mercury.mami.deploy.v10

Class DocumentCacheConfig

java.lang.Object

com.exalead.mercury.mami.deploy.v10.DocumentCacheConfig

All Implemented Interfaces:

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

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

Configuration for the document cache.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentCacheConfig.CompactMode
static class	DocumentCacheConfig.DiskCompressionAlgorithm
static class	DocumentCacheConfig.EnumMode
static class	DocumentCacheConfig.ReadMode
static class	DocumentCacheConfig.TemporaryFilesCompressionAlgorithm

Field Summary

Fields

Modifier and Type	Field and Description
int	compactArity
java.lang.String	compactMode
static int	DEFAULT_COMPACT_ARITY
static java.lang.String	DEFAULT_COMPACT_MODE
static java.lang.String	DEFAULT_DISK_COMPRESSION_ALGORITHM
static java.lang.String	DEFAULT_ENUM_MODE
static int	DEFAULT_NB_BLOOM_BITS_PER_ELEMENT
static int	DEFAULT_NB_ELEMENTS_IN_LEAF
static java.lang.String	DEFAULT_READ_MODE
static java.lang.String	DEFAULT_TEMPORARY_FILES_COMPRESSION_ALGORITHM
java.lang.String	diskCompressionAlgorithm
java.lang.String	enumMode
int	nbBloomBitsPerElement
int	nbElementsInLeaf
java.lang.String	path
java.lang.String	readMode
java.lang.String	temporaryFilesCompressionAlgorithm

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DocumentCacheConfig.
static DocumentCacheConfig	fromString(java.lang.String s) String representation of this DocumentCacheConfig.
int	getCompactArity() Number of consecutive slots to trigger a compact.
java.lang.String	getCompactMode() Read mode of the document cache StrBTree, for compact.
DocumentCacheConfig.CompactMode	getCompactModeAsEnum() Read mode of the document cache StrBTree, for compact.
java.lang.String	getDiskCompressionAlgorithm() Algorithm to compress the document cache on disk.
DocumentCacheConfig.DiskCompressionAlgorithm	getDiskCompressionAlgorithmAsEnum() Algorithm to compress the document cache on disk.
java.lang.String	getEnumMode() Read mode of the document cache StrBTree, for enumeration.
DocumentCacheConfig.EnumMode	getEnumModeAsEnum() Read mode of the document cache StrBTree, for enumeration.
int	getNbBloomBitsPerElement() Number of bits per element in the document cache StrBTree bloom filter.
int	getNbElementsInLeaf() Number of entries in each of the document cache StrBTree leaves.
java.lang.String	getPath() Location of the document cache on the filesystem. Unless otherwise specified, the document cache is located in the "cache" subdirectory of the build group.
java.lang.String	getReadMode() Read mode of the document cache StrBTree, except for enumeration.
DocumentCacheConfig.ReadMode	getReadModeAsEnum() Read mode of the document cache StrBTree, except for enumeration.
java.lang.String	getTemporaryFilesCompressionAlgorithm() Algorithm to compress the temporary files on disk.
DocumentCacheConfig.TemporaryFilesCompressionAlgorithm	getTemporaryFilesCompressionAlgorithmAsEnum() Algorithm to compress the temporary files on disk.
static boolean	isA(java.lang.String str, DocumentCacheConfig.CompactMode item)
static boolean	isA(java.lang.String str, DocumentCacheConfig.DiskCompressionAlgorithm item)
static boolean	isA(java.lang.String str, DocumentCacheConfig.EnumMode item)
static boolean	isA(java.lang.String str, DocumentCacheConfig.ReadMode item)
static boolean	isA(java.lang.String str, DocumentCacheConfig.TemporaryFilesCompressionAlgorithm item)
static boolean	isOneOf(java.lang.String str, DocumentCacheConfig.CompactMode... items)
static boolean	isOneOf(java.lang.String str, DocumentCacheConfig.DiskCompressionAlgorithm... items)
static boolean	isOneOf(java.lang.String str, DocumentCacheConfig.EnumMode... items)
static boolean	isOneOf(java.lang.String str, DocumentCacheConfig.ReadMode... items)
static boolean	isOneOf(java.lang.String str, DocumentCacheConfig.TemporaryFilesCompressionAlgorithm... items)
DocumentCacheConfig	makeCopy() Creates and returns a deep copy of this DocumentCacheConfig.
static DocumentCacheConfig	readFrom(java.io.InputStream is) Read this DocumentCacheConfig from an XML fragment.
void	setCompactArity(int compactArity) Number of consecutive slots to trigger a compact.
void	setCompactMode(DocumentCacheConfig.CompactMode item) Read mode of the document cache StrBTree, for compact.
void	setCompactMode(java.lang.String compactMode) Read mode of the document cache StrBTree, for compact.
void	setDiskCompressionAlgorithm(DocumentCacheConfig.DiskCompressionAlgorithm item) Algorithm to compress the document cache on disk.
void	setDiskCompressionAlgorithm(java.lang.String diskCompressionAlgorithm) Algorithm to compress the document cache on disk.
void	setEnumMode(DocumentCacheConfig.EnumMode item) Read mode of the document cache StrBTree, for enumeration.
void	setEnumMode(java.lang.String enumMode) Read mode of the document cache StrBTree, for enumeration.
void	setNbBloomBitsPerElement(int nbBloomBitsPerElement) Number of bits per element in the document cache StrBTree bloom filter.
void	setNbElementsInLeaf(int nbElementsInLeaf) Number of entries in each of the document cache StrBTree leaves.
void	setPath(java.lang.String path) Location of the document cache on the filesystem. Unless otherwise specified, the document cache is located in the "cache" subdirectory of the build group.
void	setReadMode(DocumentCacheConfig.ReadMode item) Read mode of the document cache StrBTree, except for enumeration.
void	setReadMode(java.lang.String readMode) Read mode of the document cache StrBTree, except for enumeration.
void	setTemporaryFilesCompressionAlgorithm(DocumentCacheConfig.TemporaryFilesCompressionAlgorithm item) Algorithm to compress the temporary files on disk.
void	setTemporaryFilesCompressionAlgorithm(java.lang.String temporaryFilesCompressionAlgorithm) Algorithm to compress the temporary files on disk.
java.lang.String	toString() String representation of this DocumentCacheConfig.
DocumentCacheConfig	withCompactArity(int compactArity)
DocumentCacheConfig	withCompactArity(java.lang.Integer compactArity)
DocumentCacheConfig	withCompactMode(java.lang.String compactMode)
DocumentCacheConfig	withDiskCompressionAlgorithm(java.lang.String diskCompressionAlgorithm)
DocumentCacheConfig	withEnumMode(java.lang.String enumMode)
DocumentCacheConfig	withNbBloomBitsPerElement(int nbBloomBitsPerElement)
DocumentCacheConfig	withNbBloomBitsPerElement(java.lang.Integer nbBloomBitsPerElement)
DocumentCacheConfig	withNbElementsInLeaf(int nbElementsInLeaf)
DocumentCacheConfig	withNbElementsInLeaf(java.lang.Integer nbElementsInLeaf)
DocumentCacheConfig	withPath(java.lang.String path)
DocumentCacheConfig	withReadMode(java.lang.String readMode)
DocumentCacheConfig	withTemporaryFilesCompressionAlgorithm(java.lang.String temporaryFilesCompressionAlgorithm)
void	writeTo(java.io.OutputStream os) Write this DocumentCacheConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

path

public java.lang.String path

compactArity

public int compactArity

DEFAULT_COMPACT_ARITY

public static final int DEFAULT_COMPACT_ARITY

See Also:

Constant Field Values

nbBloomBitsPerElement

public int nbBloomBitsPerElement

DEFAULT_NB_BLOOM_BITS_PER_ELEMENT

public static final int DEFAULT_NB_BLOOM_BITS_PER_ELEMENT

See Also:

Constant Field Values

nbElementsInLeaf

public int nbElementsInLeaf

DEFAULT_NB_ELEMENTS_IN_LEAF

public static final int DEFAULT_NB_ELEMENTS_IN_LEAF

See Also:

Constant Field Values

readMode

public java.lang.String readMode

DEFAULT_READ_MODE

public static final java.lang.String DEFAULT_READ_MODE

See Also:

Constant Field Values

enumMode

public java.lang.String enumMode

DEFAULT_ENUM_MODE

public static final java.lang.String DEFAULT_ENUM_MODE

See Also:

Constant Field Values

compactMode

public java.lang.String compactMode

DEFAULT_COMPACT_MODE

public static final java.lang.String DEFAULT_COMPACT_MODE

See Also:

Constant Field Values

diskCompressionAlgorithm

public java.lang.String diskCompressionAlgorithm

DEFAULT_DISK_COMPRESSION_ALGORITHM

public static final java.lang.String DEFAULT_DISK_COMPRESSION_ALGORITHM

See Also:

Constant Field Values

temporaryFilesCompressionAlgorithm

public java.lang.String temporaryFilesCompressionAlgorithm

DEFAULT_TEMPORARY_FILES_COMPRESSION_ALGORITHM

public static final java.lang.String DEFAULT_TEMPORARY_FILES_COMPRESSION_ALGORITHM

See Also:

Constant Field Values

Constructor Detail

DocumentCacheConfig

public DocumentCacheConfig()

DocumentCacheConfig

public DocumentCacheConfig(DocumentCacheConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          DocumentCacheConfig.ReadMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DocumentCacheConfig.ReadMode... items)

setReadMode

public void setReadMode(DocumentCacheConfig.ReadMode item)

Read mode of the document cache StrBTree, except for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getReadModeAsEnum

public DocumentCacheConfig.ReadMode getReadModeAsEnum()

Read mode of the document cache StrBTree, except for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

isA

public static boolean isA(java.lang.String str,
                          DocumentCacheConfig.EnumMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DocumentCacheConfig.EnumMode... items)

setEnumMode

public void setEnumMode(DocumentCacheConfig.EnumMode item)

Read mode of the document cache StrBTree, for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getEnumModeAsEnum

public DocumentCacheConfig.EnumMode getEnumModeAsEnum()

Read mode of the document cache StrBTree, for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

isA

public static boolean isA(java.lang.String str,
                          DocumentCacheConfig.CompactMode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DocumentCacheConfig.CompactMode... items)

setCompactMode

public void setCompactMode(DocumentCacheConfig.CompactMode item)

Read mode of the document cache StrBTree, for compact. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getCompactModeAsEnum

public DocumentCacheConfig.CompactMode getCompactModeAsEnum()

Read mode of the document cache StrBTree, for compact. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

isA

public static boolean isA(java.lang.String str,
                          DocumentCacheConfig.DiskCompressionAlgorithm item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DocumentCacheConfig.DiskCompressionAlgorithm... items)

setDiskCompressionAlgorithm

public void setDiskCompressionAlgorithm(DocumentCacheConfig.DiskCompressionAlgorithm item)

Algorithm to compress the document cache on disk. Value can be null or one of

• none
• fastlz
• gzip
• lcs
• lz4

getDiskCompressionAlgorithmAsEnum

public DocumentCacheConfig.DiskCompressionAlgorithm getDiskCompressionAlgorithmAsEnum()

Algorithm to compress the document cache on disk. Value can be null or one of

• none
• fastlz
• gzip
• lcs
• lz4

isA

public static boolean isA(java.lang.String str,
                          DocumentCacheConfig.TemporaryFilesCompressionAlgorithm item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              DocumentCacheConfig.TemporaryFilesCompressionAlgorithm... items)

setTemporaryFilesCompressionAlgorithm

public void setTemporaryFilesCompressionAlgorithm(DocumentCacheConfig.TemporaryFilesCompressionAlgorithm item)

Algorithm to compress the temporary files on disk. Value can be null or one of

• none
• fastlz
• gzip
• lz4

getTemporaryFilesCompressionAlgorithmAsEnum

public DocumentCacheConfig.TemporaryFilesCompressionAlgorithm getTemporaryFilesCompressionAlgorithmAsEnum()

Algorithm to compress the temporary files on disk. Value can be null or one of

• none
• fastlz
• gzip
• lz4

setPath

public void setPath(java.lang.String path)

Location of the document cache on the filesystem.
Unless otherwise specified, the document cache is located in the
"cache" subdirectory of the build group.

getPath

public java.lang.String getPath()

Location of the document cache on the filesystem.
Unless otherwise specified, the document cache is located in the
"cache" subdirectory of the build group.

withPath

public DocumentCacheConfig withPath(java.lang.String path)

setCompactArity

public void setCompactArity(int compactArity)

Number of consecutive slots to trigger a compact.

getCompactArity

public int getCompactArity()

Number of consecutive slots to trigger a compact.

withCompactArity

public DocumentCacheConfig withCompactArity(int compactArity)

withCompactArity

public DocumentCacheConfig withCompactArity(java.lang.Integer compactArity)

setNbBloomBitsPerElement

public void setNbBloomBitsPerElement(int nbBloomBitsPerElement)

Number of bits per element in the document cache StrBTree bloom filter.

getNbBloomBitsPerElement

public int getNbBloomBitsPerElement()

Number of bits per element in the document cache StrBTree bloom filter.

withNbBloomBitsPerElement

public DocumentCacheConfig withNbBloomBitsPerElement(int nbBloomBitsPerElement)

withNbBloomBitsPerElement

public DocumentCacheConfig withNbBloomBitsPerElement(java.lang.Integer nbBloomBitsPerElement)

setNbElementsInLeaf

public void setNbElementsInLeaf(int nbElementsInLeaf)

Number of entries in each of the document cache StrBTree leaves.

getNbElementsInLeaf

public int getNbElementsInLeaf()

Number of entries in each of the document cache StrBTree leaves.

withNbElementsInLeaf

public DocumentCacheConfig withNbElementsInLeaf(int nbElementsInLeaf)

withNbElementsInLeaf

public DocumentCacheConfig withNbElementsInLeaf(java.lang.Integer nbElementsInLeaf)

setReadMode

public void setReadMode(java.lang.String readMode)

Read mode of the document cache StrBTree, except for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getReadMode

public java.lang.String getReadMode()

Read mode of the document cache StrBTree, except for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

withReadMode

public DocumentCacheConfig withReadMode(java.lang.String readMode)

setEnumMode

public void setEnumMode(java.lang.String enumMode)

Read mode of the document cache StrBTree, for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getEnumMode

public java.lang.String getEnumMode()

Read mode of the document cache StrBTree, for enumeration. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

withEnumMode

public DocumentCacheConfig withEnumMode(java.lang.String enumMode)

setCompactMode

public void setCompactMode(java.lang.String compactMode)

Read mode of the document cache StrBTree, for compact. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

getCompactMode

public java.lang.String getCompactMode()

Read mode of the document cache StrBTree, for compact. Value can be null or one of

• auto
• direct
• mmap
• mmap_mlock
• mmap_mload
• pagecache
• random
• sequential

withCompactMode

public DocumentCacheConfig withCompactMode(java.lang.String compactMode)

setDiskCompressionAlgorithm

public void setDiskCompressionAlgorithm(java.lang.String diskCompressionAlgorithm)

Algorithm to compress the document cache on disk. Value can be null or one of

• none
• fastlz
• gzip
• lcs
• lz4

getDiskCompressionAlgorithm

public java.lang.String getDiskCompressionAlgorithm()

Algorithm to compress the document cache on disk. Value can be null or one of

• none
• fastlz
• gzip
• lcs
• lz4

withDiskCompressionAlgorithm

public DocumentCacheConfig withDiskCompressionAlgorithm(java.lang.String diskCompressionAlgorithm)

setTemporaryFilesCompressionAlgorithm

public void setTemporaryFilesCompressionAlgorithm(java.lang.String temporaryFilesCompressionAlgorithm)

Algorithm to compress the temporary files on disk. Value can be null or one of

• none
• fastlz
• gzip
• lz4

getTemporaryFilesCompressionAlgorithm

public java.lang.String getTemporaryFilesCompressionAlgorithm()

Algorithm to compress the temporary files on disk. Value can be null or one of

• none
• fastlz
• gzip
• lz4

withTemporaryFilesCompressionAlgorithm

public DocumentCacheConfig withTemporaryFilesCompressionAlgorithm(java.lang.String temporaryFilesCompressionAlgorithm)

makeCopy

public DocumentCacheConfig makeCopy()

Creates and returns a deep copy of this DocumentCacheConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DocumentCacheConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DocumentCacheConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this DocumentCacheConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException