com.exalead.mercury.mami.deploy.v10

Class DIHConfig

java.lang.Object

com.exalead.mercury.mami.deploy.v10.DIHConfig

All Implemented Interfaces:

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

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

A DIHConfig is a set of parameters for a DIH.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DIHConfig.CompactMode
static class	DIHConfig.EnumMode
static class	DIHConfig.ReadMode

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_ENUM_MODE
static int	DEFAULT_NB_BLOOM_BITS_PER_ELEMENT
static int	DEFAULT_NB_ELEMENTS_IN_LEAF
static java.lang.String	DEFAULT_READ_MODE
java.lang.String	enumMode
int	nbBloomBitsPerElement
int	nbElementsInLeaf
java.lang.String	readMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this DIHConfig.
static DIHConfig	fromString(java.lang.String s) String representation of this DIHConfig.
int	getCompactArity() Number of consecutive slots to trigger a compact.
java.lang.String	getCompactMode() Read mode of the DIH's StrBTree, for compact.
DIHConfig.CompactMode	getCompactModeAsEnum() Read mode of the DIH's StrBTree, for compact.
java.lang.String	getEnumMode() Read mode of the DIH's StrBTree, for enumeration.
DIHConfig.EnumMode	getEnumModeAsEnum() Read mode of the DIH's StrBTree, for enumeration.
int	getNbBloomBitsPerElement() Number of bits per elements in the DIH's StrBTree's bloom filter.
int	getNbElementsInLeaf() Number of entries in each of the DIH's StrBTree's leaves.
java.lang.String	getReadMode() Read mode of the DIH's StrBTree, except for enumeration.
DIHConfig.ReadMode	getReadModeAsEnum() Read mode of the DIH's StrBTree, except for enumeration.
static boolean	isA(java.lang.String str, DIHConfig.CompactMode item)
static boolean	isA(java.lang.String str, DIHConfig.EnumMode item)
static boolean	isA(java.lang.String str, DIHConfig.ReadMode item)
static boolean	isOneOf(java.lang.String str, DIHConfig.CompactMode... items)
static boolean	isOneOf(java.lang.String str, DIHConfig.EnumMode... items)
static boolean	isOneOf(java.lang.String str, DIHConfig.ReadMode... items)
DIHConfig	makeCopy() Creates and returns a deep copy of this DIHConfig.
static DIHConfig	readFrom(java.io.InputStream is) Read this DIHConfig from an XML fragment.
void	setCompactArity(int compactArity) Number of consecutive slots to trigger a compact.
void	setCompactMode(DIHConfig.CompactMode item) Read mode of the DIH's StrBTree, for compact.
void	setCompactMode(java.lang.String compactMode) Read mode of the DIH's StrBTree, for compact.
void	setEnumMode(DIHConfig.EnumMode item) Read mode of the DIH's StrBTree, for enumeration.
void	setEnumMode(java.lang.String enumMode) Read mode of the DIH's StrBTree, for enumeration.
void	setNbBloomBitsPerElement(int nbBloomBitsPerElement) Number of bits per elements in the DIH's StrBTree's bloom filter.
void	setNbElementsInLeaf(int nbElementsInLeaf) Number of entries in each of the DIH's StrBTree's leaves.
void	setReadMode(DIHConfig.ReadMode item) Read mode of the DIH's StrBTree, except for enumeration.
void	setReadMode(java.lang.String readMode) Read mode of the DIH's StrBTree, except for enumeration.
java.lang.String	toString() String representation of this DIHConfig.
DIHConfig	withCompactArity(int compactArity)
DIHConfig	withCompactArity(java.lang.Integer compactArity)
DIHConfig	withCompactMode(java.lang.String compactMode)
DIHConfig	withEnumMode(java.lang.String enumMode)
DIHConfig	withNbBloomBitsPerElement(int nbBloomBitsPerElement)
DIHConfig	withNbBloomBitsPerElement(java.lang.Integer nbBloomBitsPerElement)
DIHConfig	withNbElementsInLeaf(int nbElementsInLeaf)
DIHConfig	withNbElementsInLeaf(java.lang.Integer nbElementsInLeaf)
DIHConfig	withReadMode(java.lang.String readMode)
void	writeTo(java.io.OutputStream os) Write this DIHConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

DIHConfig

public DIHConfig()

DIHConfig

public DIHConfig(DIHConfig o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setReadMode

public void setReadMode(DIHConfig.ReadMode item)

Read mode of the DIH's StrBTree, except for enumeration. Value can be null or one of

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

getReadModeAsEnum

public DIHConfig.ReadMode getReadModeAsEnum()

Read mode of the DIH's 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,
                          DIHConfig.EnumMode item)

isOneOf

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

setEnumMode

public void setEnumMode(DIHConfig.EnumMode item)

Read mode of the DIH's StrBTree, for enumeration. Value can be null or one of

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

getEnumModeAsEnum

public DIHConfig.EnumMode getEnumModeAsEnum()

Read mode of the DIH's 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,
                          DIHConfig.CompactMode item)

isOneOf

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

setCompactMode

public void setCompactMode(DIHConfig.CompactMode item)

Read mode of the DIH's StrBTree, for compact. Value can be null or one of

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

getCompactModeAsEnum

public DIHConfig.CompactMode getCompactModeAsEnum()

Read mode of the DIH's StrBTree, for compact. Value can be null or one of

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

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 DIHConfig withCompactArity(int compactArity)

withCompactArity

public DIHConfig withCompactArity(java.lang.Integer compactArity)

setNbBloomBitsPerElement

public void setNbBloomBitsPerElement(int nbBloomBitsPerElement)

Number of bits per elements in the DIH's StrBTree's bloom filter.

getNbBloomBitsPerElement

public int getNbBloomBitsPerElement()

Number of bits per elements in the DIH's StrBTree's bloom filter.

withNbBloomBitsPerElement

public DIHConfig withNbBloomBitsPerElement(int nbBloomBitsPerElement)

withNbBloomBitsPerElement

public DIHConfig withNbBloomBitsPerElement(java.lang.Integer nbBloomBitsPerElement)

setNbElementsInLeaf

public void setNbElementsInLeaf(int nbElementsInLeaf)

Number of entries in each of the DIH's StrBTree's leaves.

getNbElementsInLeaf

public int getNbElementsInLeaf()

Number of entries in each of the DIH's StrBTree's leaves.

withNbElementsInLeaf

public DIHConfig withNbElementsInLeaf(int nbElementsInLeaf)

withNbElementsInLeaf

public DIHConfig withNbElementsInLeaf(java.lang.Integer nbElementsInLeaf)

setReadMode

public void setReadMode(java.lang.String readMode)

Read mode of the DIH's 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 DIH's StrBTree, except for enumeration. Value can be null or one of

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

withReadMode

public DIHConfig withReadMode(java.lang.String readMode)

setEnumMode

public void setEnumMode(java.lang.String enumMode)

Read mode of the DIH's 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 DIH's StrBTree, for enumeration. Value can be null or one of

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

withEnumMode

public DIHConfig withEnumMode(java.lang.String enumMode)

setCompactMode

public void setCompactMode(java.lang.String compactMode)

Read mode of the DIH's 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 DIH's StrBTree, for compact. Value can be null or one of

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

withCompactMode

public DIHConfig withCompactMode(java.lang.String compactMode)

makeCopy

public DIHConfig makeCopy()

Creates and returns a deep copy of this DIHConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this DIHConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this DIHConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this DIHConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException