com.exalead.mercury.mami.indexing.v10

Class CompactPolicies

java.lang.Object

com.exalead.mercury.mami.indexing.v10.CompactPolicies

All Implemented Interfaces:

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

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompactPolicies.Type

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AutoCompactPolicy>	autoCompactPolicy
static int	DEFAULT_HIGH_PRIORITY_COMPACT_NB_THREADS
static int	DEFAULT_LOW_PRIORITY_COMPACT_NB_THREADS
static int	DEFAULT_MAX_PAGE_CACHE_SIZE_M_B
static int	DEFAULT_MAX_PARALLEL_FULL_COMPACTS
static int	DEFAULT_PAGE_CACHE_PAGE_SIZE_K_B
static int	DEFAULT_PRIORITY_COMPACT_THRESHOLD
static boolean	DEFAULT_SYNCHRONOUS
static java.lang.String	DEFAULT_TYPE
int	highPriorityCompactNbThreads
int	lowPriorityCompactNbThreads
int	maxPageCacheSizeMB
int	maxParallelFullCompacts
int	pageCachePageSizeKB
int	priorityCompactThreshold
boolean	synchronous
java.lang.String	type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CompactPolicies.
static CompactPolicies	fromString(java.lang.String s) String representation of this CompactPolicies.
java.util.List<AutoCompactPolicy>	getAutoCompactPolicy() Specifies the auto-compact policies.
int	getHighPriorityCompactNbThreads() Number of threads to use for a compact having high priority (0: all available threads).
int	getLowPriorityCompactNbThreads() Number of threads to use for a compact having low priority (0: all available threads).
int	getMaxPageCacheSizeMB() If the policy uses the PageCache mode, it specifies the max cache size.
int	getMaxParallelFullCompacts() Limit the number of full compacts in parallel, can be useful when you don't have too much disk space available.
int	getPageCachePageSizeKB() If the policy uses the PageCache mode, it specifies the page size.
int	getPriorityCompactThreshold() When compacting a slot gen0-gen1, consider as a priority compact if gen1-gen0 < priorityCompactThreshold.
java.lang.String	getType() Specifies which I/O mode is used while compacting.
CompactPolicies.Type	getTypeAsEnum() Specifies which I/O mode is used while compacting.
static boolean	isA(java.lang.String str, CompactPolicies.Type item)
static boolean	isOneOf(java.lang.String str, CompactPolicies.Type... items)
boolean	isSynchronous() By default, compaction jobs are asynchronous.
CompactPolicies	makeCopy() Creates and returns a deep copy of this CompactPolicies.
static CompactPolicies	readFrom(java.io.InputStream is) Read this CompactPolicies from an XML fragment.
void	setHighPriorityCompactNbThreads(int highPriorityCompactNbThreads) Number of threads to use for a compact having high priority (0: all available threads).
void	setLowPriorityCompactNbThreads(int lowPriorityCompactNbThreads) Number of threads to use for a compact having low priority (0: all available threads).
void	setMaxPageCacheSizeMB(int maxPageCacheSizeMB) If the policy uses the PageCache mode, it specifies the max cache size.
void	setMaxParallelFullCompacts(int maxParallelFullCompacts) Limit the number of full compacts in parallel, can be useful when you don't have too much disk space available.
void	setPageCachePageSizeKB(int pageCachePageSizeKB) If the policy uses the PageCache mode, it specifies the page size.
void	setPriorityCompactThreshold(int priorityCompactThreshold) When compacting a slot gen0-gen1, consider as a priority compact if gen1-gen0 < priorityCompactThreshold.
void	setSynchronous(boolean synchronous) By default, compaction jobs are asynchronous.
void	setType(CompactPolicies.Type item) Specifies which I/O mode is used while compacting.
void	setType(java.lang.String type) Specifies which I/O mode is used while compacting.
java.lang.String	toString() String representation of this CompactPolicies.
CompactPolicies	withAutoCompactPolicy(AutoCompactPolicy... __values) Specifies the auto-compact policies.
CompactPolicies	withAutoCompactPolicy(java.util.Collection<AutoCompactPolicy> __values)
CompactPolicies	withHighPriorityCompactNbThreads(int highPriorityCompactNbThreads)
CompactPolicies	withHighPriorityCompactNbThreads(java.lang.Integer highPriorityCompactNbThreads)
CompactPolicies	withLowPriorityCompactNbThreads(int lowPriorityCompactNbThreads)
CompactPolicies	withLowPriorityCompactNbThreads(java.lang.Integer lowPriorityCompactNbThreads)
CompactPolicies	withMaxPageCacheSizeMB(int maxPageCacheSizeMB)
CompactPolicies	withMaxPageCacheSizeMB(java.lang.Integer maxPageCacheSizeMB)
CompactPolicies	withMaxParallelFullCompacts(int maxParallelFullCompacts)
CompactPolicies	withMaxParallelFullCompacts(java.lang.Integer maxParallelFullCompacts)
CompactPolicies	withPageCachePageSizeKB(int pageCachePageSizeKB)
CompactPolicies	withPageCachePageSizeKB(java.lang.Integer pageCachePageSizeKB)
CompactPolicies	withPriorityCompactThreshold(int priorityCompactThreshold)
CompactPolicies	withPriorityCompactThreshold(java.lang.Integer priorityCompactThreshold)
CompactPolicies	withSynchronous(boolean synchronous)
CompactPolicies	withSynchronous(java.lang.Boolean synchronous)
CompactPolicies	withType(java.lang.String type)
void	writeTo(java.io.OutputStream os) Write this CompactPolicies as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

autoCompactPolicy

public java.util.List<AutoCompactPolicy> autoCompactPolicy

synchronous

public boolean synchronous

DEFAULT_SYNCHRONOUS

public static final boolean DEFAULT_SYNCHRONOUS

See Also:

Constant Field Values

maxParallelFullCompacts

public int maxParallelFullCompacts

DEFAULT_MAX_PARALLEL_FULL_COMPACTS

public static final int DEFAULT_MAX_PARALLEL_FULL_COMPACTS

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

maxPageCacheSizeMB

public int maxPageCacheSizeMB

DEFAULT_MAX_PAGE_CACHE_SIZE_M_B

public static final int DEFAULT_MAX_PAGE_CACHE_SIZE_M_B

See Also:

Constant Field Values

pageCachePageSizeKB

public int pageCachePageSizeKB

DEFAULT_PAGE_CACHE_PAGE_SIZE_K_B

public static final int DEFAULT_PAGE_CACHE_PAGE_SIZE_K_B

See Also:

Constant Field Values

priorityCompactThreshold

public int priorityCompactThreshold

DEFAULT_PRIORITY_COMPACT_THRESHOLD

public static final int DEFAULT_PRIORITY_COMPACT_THRESHOLD

See Also:

Constant Field Values

lowPriorityCompactNbThreads

public int lowPriorityCompactNbThreads

DEFAULT_LOW_PRIORITY_COMPACT_NB_THREADS

public static final int DEFAULT_LOW_PRIORITY_COMPACT_NB_THREADS

See Also:

Constant Field Values

highPriorityCompactNbThreads

public int highPriorityCompactNbThreads

DEFAULT_HIGH_PRIORITY_COMPACT_NB_THREADS

public static final int DEFAULT_HIGH_PRIORITY_COMPACT_NB_THREADS

See Also:

Constant Field Values

Constructor Detail

CompactPolicies

public CompactPolicies()

CompactPolicies

public CompactPolicies(CompactPolicies o)

Copy constructor

Method Detail

isA

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

isOneOf

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

setType

public void setType(CompactPolicies.Type item)

Specifies which I/O mode is used while compacting. ( Value can be null or one of

• mmap
• pagecache

)

getTypeAsEnum

public CompactPolicies.Type getTypeAsEnum()

Specifies which I/O mode is used while compacting. ( Value can be null or one of

• mmap
• pagecache

)

getAutoCompactPolicy

public java.util.List<AutoCompactPolicy> getAutoCompactPolicy()

Specifies the auto-compact policies.

withAutoCompactPolicy

public CompactPolicies withAutoCompactPolicy(AutoCompactPolicy... __values)

Specifies the auto-compact policies.

withAutoCompactPolicy

public CompactPolicies withAutoCompactPolicy(java.util.Collection<AutoCompactPolicy> __values)

setSynchronous

public void setSynchronous(boolean synchronous)

By default, compaction jobs are asynchronous. If set, compacts will be done synchronously just after imports.

isSynchronous

public boolean isSynchronous()

By default, compaction jobs are asynchronous. If set, compacts will be done synchronously just after imports.

withSynchronous

public CompactPolicies withSynchronous(boolean synchronous)

withSynchronous

public CompactPolicies withSynchronous(java.lang.Boolean synchronous)

setMaxParallelFullCompacts

public void setMaxParallelFullCompacts(int maxParallelFullCompacts)

Limit the number of full compacts in parallel, can be useful when you don't have too much disk space available. 0 means no limit.

getMaxParallelFullCompacts

public int getMaxParallelFullCompacts()

Limit the number of full compacts in parallel, can be useful when you don't have too much disk space available. 0 means no limit.

withMaxParallelFullCompacts

public CompactPolicies withMaxParallelFullCompacts(int maxParallelFullCompacts)

withMaxParallelFullCompacts

public CompactPolicies withMaxParallelFullCompacts(java.lang.Integer maxParallelFullCompacts)

setType

public void setType(java.lang.String type)

Specifies which I/O mode is used while compacting. ( Value can be null or one of

• mmap
• pagecache

)

getType

public java.lang.String getType()

Specifies which I/O mode is used while compacting. ( Value can be null or one of

• mmap
• pagecache

)

withType

public CompactPolicies withType(java.lang.String type)

setMaxPageCacheSizeMB

public void setMaxPageCacheSizeMB(int maxPageCacheSizeMB)

If the policy uses the PageCache mode, it specifies the max cache size.

getMaxPageCacheSizeMB

public int getMaxPageCacheSizeMB()

If the policy uses the PageCache mode, it specifies the max cache size.

withMaxPageCacheSizeMB

public CompactPolicies withMaxPageCacheSizeMB(int maxPageCacheSizeMB)

withMaxPageCacheSizeMB

public CompactPolicies withMaxPageCacheSizeMB(java.lang.Integer maxPageCacheSizeMB)

setPageCachePageSizeKB

public void setPageCachePageSizeKB(int pageCachePageSizeKB)

If the policy uses the PageCache mode, it specifies the page size.

getPageCachePageSizeKB

public int getPageCachePageSizeKB()

If the policy uses the PageCache mode, it specifies the page size.

withPageCachePageSizeKB

public CompactPolicies withPageCachePageSizeKB(int pageCachePageSizeKB)

withPageCachePageSizeKB

public CompactPolicies withPageCachePageSizeKB(java.lang.Integer pageCachePageSizeKB)

setPriorityCompactThreshold

public void setPriorityCompactThreshold(int priorityCompactThreshold)

When compacting a slot gen0-gen1, consider as a priority compact if gen1-gen0 < priorityCompactThreshold. Default is 48. (0: disabled)

getPriorityCompactThreshold

public int getPriorityCompactThreshold()

When compacting a slot gen0-gen1, consider as a priority compact if gen1-gen0 < priorityCompactThreshold. Default is 48. (0: disabled)

withPriorityCompactThreshold

public CompactPolicies withPriorityCompactThreshold(int priorityCompactThreshold)

withPriorityCompactThreshold

public CompactPolicies withPriorityCompactThreshold(java.lang.Integer priorityCompactThreshold)

setLowPriorityCompactNbThreads

public void setLowPriorityCompactNbThreads(int lowPriorityCompactNbThreads)

Number of threads to use for a compact having low priority (0: all available threads).

getLowPriorityCompactNbThreads

public int getLowPriorityCompactNbThreads()

Number of threads to use for a compact having low priority (0: all available threads).

withLowPriorityCompactNbThreads

public CompactPolicies withLowPriorityCompactNbThreads(int lowPriorityCompactNbThreads)

withLowPriorityCompactNbThreads

public CompactPolicies withLowPriorityCompactNbThreads(java.lang.Integer lowPriorityCompactNbThreads)

setHighPriorityCompactNbThreads

public void setHighPriorityCompactNbThreads(int highPriorityCompactNbThreads)

Number of threads to use for a compact having high priority (0: all available threads).

getHighPriorityCompactNbThreads

public int getHighPriorityCompactNbThreads()

Number of threads to use for a compact having high priority (0: all available threads).

withHighPriorityCompactNbThreads

public CompactPolicies withHighPriorityCompactNbThreads(int highPriorityCompactNbThreads)

withHighPriorityCompactNbThreads

public CompactPolicies withHighPriorityCompactNbThreads(java.lang.Integer highPriorityCompactNbThreads)

makeCopy

public CompactPolicies makeCopy()

Creates and returns a deep copy of this CompactPolicies.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CompactPolicies.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CompactPolicies.

Overrides:

toString in class java.lang.Object

check

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

Checks this CompactPolicies.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException