com.exalead.mercury.mami.consolidation.v10

Class ConsolidationConfig

java.lang.Object

com.exalead.mercury.mami.consolidation.v10.ConsolidationConfig

All Implemented Interfaces:

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

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

Consolidation Server configuration. The Consolidation Server collects documents from a push API. The document goes through the following transformation steps before being sent to the Indexing Server:

1. Transformation processors
2. Aggregation processors

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsolidationConfig.AggregationTriggerConditions
static class	ConsolidationConfig.CommitTriggerConditions
static class	ConsolidationConfig.MaxNativeMemoryConsumptionThreshold

Field Summary

Fields

Modifier and Type	Field and Description
AdvancedConfig	advancedConfig
AggregationForwardProcessorConfigList	aggregationForwardProcessorConfigList
AggregationProcessorConfigList	aggregationProcessorConfigList
protected ConsolidationConfig.AggregationTriggerConditions	AggregationTriggerConditions
protected ConsolidationConfig.CommitTriggerConditions	CommitTriggerConditions
static int	DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_IN_M_B
static java.lang.String	DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_THRESHOLD
static int	DEFAULT_NB_THREADS
int	maxNativeMemoryConsumptionInMB
java.lang.String	maxNativeMemoryConsumptionThreshold
java.lang.String	name
int	nbThreads
TransformationProcessorConfigList	transformationProcessorConfigList

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConsolidationConfig.
static ConsolidationConfig	fromString(java.lang.String s) String representation of this ConsolidationConfig.
AdvancedConfig	getAdvancedConfig()
AggregationForwardProcessorConfigList	getAggregationForwardProcessorConfigList()
AggregationProcessorConfigList	getAggregationProcessorConfigList()
ConsolidationConfig.AggregationTriggerConditions	getAggregationTriggerConditions()
ConsolidationConfig.CommitTriggerConditions	getCommitTriggerConditions()
int	getMaxNativeMemoryConsumptionInMB() The maximum of native memory the transformation service can allocate.
java.lang.String	getMaxNativeMemoryConsumptionThreshold() When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed.
ConsolidationConfig.MaxNativeMemoryConsumptionThreshold	getMaxNativeMemoryConsumptionThresholdAsEnum() When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed.
java.lang.String	getName() Identifies this consolidation configuration uniquely
int	getNbThreads() Number of threads to allocate during the transformation and aggregation phases.
TransformationProcessorConfigList	getTransformationProcessorConfigList()
static boolean	isA(java.lang.String str, ConsolidationConfig.MaxNativeMemoryConsumptionThreshold item)
static boolean	isOneOf(java.lang.String str, ConsolidationConfig.MaxNativeMemoryConsumptionThreshold... items)
ConsolidationConfig	makeCopy() Creates and returns a deep copy of this ConsolidationConfig.
static ConsolidationConfig	readFrom(java.io.InputStream is) Read this ConsolidationConfig from an XML fragment.
void	setAdvancedConfig(AdvancedConfig advancedConfig)
void	setAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)
void	setAggregationProcessorConfigList(AggregationProcessorConfigList aggregationProcessorConfigList)
void	setAggregationTriggerConditions(ConsolidationConfig.AggregationTriggerConditions __value)
void	setCommitTriggerConditions(ConsolidationConfig.CommitTriggerConditions __value)
void	setMaxNativeMemoryConsumptionInMB(int maxNativeMemoryConsumptionInMB) The maximum of native memory the transformation service can allocate.
void	setMaxNativeMemoryConsumptionThreshold(ConsolidationConfig.MaxNativeMemoryConsumptionThreshold item) When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed.
void	setMaxNativeMemoryConsumptionThreshold(java.lang.String maxNativeMemoryConsumptionThreshold) When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed.
void	setName(java.lang.String name) Identifies this consolidation configuration uniquely
void	setNbThreads(int nbThreads) Number of threads to allocate during the transformation and aggregation phases.
void	setTransformationProcessorConfigList(TransformationProcessorConfigList transformationProcessorConfigList)
java.lang.String	toString() String representation of this ConsolidationConfig.
ConsolidationConfig	withAdvancedConfig(AdvancedConfig advancedConfig)
ConsolidationConfig	withAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)
ConsolidationConfig	withAggregationProcessorConfigList(AggregationProcessorConfigList aggregationProcessorConfigList)
ConsolidationConfig	withAggregationTriggerConditions(java.util.Collection<CommitTriggerCondition> __values)
ConsolidationConfig	withAggregationTriggerConditions(CommitTriggerCondition... __values)
ConsolidationConfig	withAggregationTriggerConditions(ConsolidationConfig.AggregationTriggerConditions __value)
ConsolidationConfig	withCommitTriggerConditions(java.util.Collection<CommitTriggerCondition> __values)
ConsolidationConfig	withCommitTriggerConditions(CommitTriggerCondition... __values)
ConsolidationConfig	withCommitTriggerConditions(ConsolidationConfig.CommitTriggerConditions __value)
ConsolidationConfig	withMaxNativeMemoryConsumptionInMB(int maxNativeMemoryConsumptionInMB)
ConsolidationConfig	withMaxNativeMemoryConsumptionInMB(java.lang.Integer maxNativeMemoryConsumptionInMB)
ConsolidationConfig	withMaxNativeMemoryConsumptionThreshold(java.lang.String maxNativeMemoryConsumptionThreshold)
ConsolidationConfig	withName(java.lang.String name)
ConsolidationConfig	withNbThreads(int nbThreads)
ConsolidationConfig	withNbThreads(java.lang.Integer nbThreads)
ConsolidationConfig	withTransformationProcessorConfigList(TransformationProcessorConfigList transformationProcessorConfigList)
void	writeTo(java.io.OutputStream os) Write this ConsolidationConfig 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

nbThreads

public int nbThreads

DEFAULT_NB_THREADS

public static final int DEFAULT_NB_THREADS

See Also:

Constant Field Values

maxNativeMemoryConsumptionThreshold

public java.lang.String maxNativeMemoryConsumptionThreshold

DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_THRESHOLD

public static final java.lang.String DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_THRESHOLD

See Also:

Constant Field Values

maxNativeMemoryConsumptionInMB

public int maxNativeMemoryConsumptionInMB

DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_IN_M_B

public static final int DEFAULT_MAX_NATIVE_MEMORY_CONSUMPTION_IN_M_B

See Also:

Constant Field Values

transformationProcessorConfigList

public TransformationProcessorConfigList transformationProcessorConfigList

aggregationProcessorConfigList

public AggregationProcessorConfigList aggregationProcessorConfigList

aggregationForwardProcessorConfigList

public AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList

CommitTriggerConditions

protected ConsolidationConfig.CommitTriggerConditions CommitTriggerConditions

AggregationTriggerConditions

protected ConsolidationConfig.AggregationTriggerConditions AggregationTriggerConditions

advancedConfig

public AdvancedConfig advancedConfig

Constructor Detail

ConsolidationConfig

public ConsolidationConfig()

ConsolidationConfig

public ConsolidationConfig(ConsolidationConfig o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          ConsolidationConfig.MaxNativeMemoryConsumptionThreshold item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              ConsolidationConfig.MaxNativeMemoryConsumptionThreshold... items)

setMaxNativeMemoryConsumptionThreshold

public void setMaxNativeMemoryConsumptionThreshold(ConsolidationConfig.MaxNativeMemoryConsumptionThreshold item)

When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed. Then the transformation starts again.

• Enabled: Commits when the memory usage reaches the threshold value specified (by default, 2048 MB).
• Auto: Commits when the memory usage reaches 2048 MB.'

getMaxNativeMemoryConsumptionThresholdAsEnum

public ConsolidationConfig.MaxNativeMemoryConsumptionThreshold getMaxNativeMemoryConsumptionThresholdAsEnum()

When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed. Then the transformation starts again.

• Enabled: Commits when the memory usage reaches the threshold value specified (by default, 2048 MB).
• Auto: Commits when the memory usage reaches 2048 MB.'

setName

public void setName(java.lang.String name)

Identifies this consolidation configuration uniquely

getName

public java.lang.String getName()

Identifies this consolidation configuration uniquely

withName

public ConsolidationConfig withName(java.lang.String name)

setNbThreads

public void setNbThreads(int nbThreads)

Number of threads to allocate during the transformation and aggregation phases.

getNbThreads

public int getNbThreads()

Number of threads to allocate during the transformation and aggregation phases.

withNbThreads

public ConsolidationConfig withNbThreads(int nbThreads)

withNbThreads

public ConsolidationConfig withNbThreads(java.lang.Integer nbThreads)

setMaxNativeMemoryConsumptionThreshold

public void setMaxNativeMemoryConsumptionThreshold(java.lang.String maxNativeMemoryConsumptionThreshold)

When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed. Then the transformation starts again.

• Enabled: Commits when the memory usage reaches the threshold value specified (by default, 2048 MB).
• Auto: Commits when the memory usage reaches 2048 MB.'

getMaxNativeMemoryConsumptionThreshold

public java.lang.String getMaxNativeMemoryConsumptionThreshold()

When reaching the memory consumption value specified, transformation is stopped and transformed documents are committed. Then the transformation starts again.

• Enabled: Commits when the memory usage reaches the threshold value specified (by default, 2048 MB).
• Auto: Commits when the memory usage reaches 2048 MB.'

withMaxNativeMemoryConsumptionThreshold

public ConsolidationConfig withMaxNativeMemoryConsumptionThreshold(java.lang.String maxNativeMemoryConsumptionThreshold)

setMaxNativeMemoryConsumptionInMB

public void setMaxNativeMemoryConsumptionInMB(int maxNativeMemoryConsumptionInMB)

The maximum of native memory the transformation service can allocate. Reaching this limit triggers a commit.

getMaxNativeMemoryConsumptionInMB

public int getMaxNativeMemoryConsumptionInMB()

The maximum of native memory the transformation service can allocate. Reaching this limit triggers a commit.

withMaxNativeMemoryConsumptionInMB

public ConsolidationConfig withMaxNativeMemoryConsumptionInMB(int maxNativeMemoryConsumptionInMB)

withMaxNativeMemoryConsumptionInMB

public ConsolidationConfig withMaxNativeMemoryConsumptionInMB(java.lang.Integer maxNativeMemoryConsumptionInMB)

setTransformationProcessorConfigList

public void setTransformationProcessorConfigList(TransformationProcessorConfigList transformationProcessorConfigList)

getTransformationProcessorConfigList

public TransformationProcessorConfigList getTransformationProcessorConfigList()

withTransformationProcessorConfigList

public ConsolidationConfig withTransformationProcessorConfigList(TransformationProcessorConfigList transformationProcessorConfigList)

setAggregationProcessorConfigList

public void setAggregationProcessorConfigList(AggregationProcessorConfigList aggregationProcessorConfigList)

getAggregationProcessorConfigList

public AggregationProcessorConfigList getAggregationProcessorConfigList()

withAggregationProcessorConfigList

public ConsolidationConfig withAggregationProcessorConfigList(AggregationProcessorConfigList aggregationProcessorConfigList)

setAggregationForwardProcessorConfigList

public void setAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)

getAggregationForwardProcessorConfigList

public AggregationForwardProcessorConfigList getAggregationForwardProcessorConfigList()

withAggregationForwardProcessorConfigList

public ConsolidationConfig withAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)

getCommitTriggerConditions

public ConsolidationConfig.CommitTriggerConditions getCommitTriggerConditions()

setCommitTriggerConditions

public void setCommitTriggerConditions(ConsolidationConfig.CommitTriggerConditions __value)

withCommitTriggerConditions

public ConsolidationConfig withCommitTriggerConditions(CommitTriggerCondition... __values)

withCommitTriggerConditions

public ConsolidationConfig withCommitTriggerConditions(java.util.Collection<CommitTriggerCondition> __values)

withCommitTriggerConditions

public ConsolidationConfig withCommitTriggerConditions(ConsolidationConfig.CommitTriggerConditions __value)

getAggregationTriggerConditions

public ConsolidationConfig.AggregationTriggerConditions getAggregationTriggerConditions()

setAggregationTriggerConditions

public void setAggregationTriggerConditions(ConsolidationConfig.AggregationTriggerConditions __value)

withAggregationTriggerConditions

public ConsolidationConfig withAggregationTriggerConditions(CommitTriggerCondition... __values)

withAggregationTriggerConditions

public ConsolidationConfig withAggregationTriggerConditions(java.util.Collection<CommitTriggerCondition> __values)

withAggregationTriggerConditions

public ConsolidationConfig withAggregationTriggerConditions(ConsolidationConfig.AggregationTriggerConditions __value)

setAdvancedConfig

public void setAdvancedConfig(AdvancedConfig advancedConfig)

getAdvancedConfig

public AdvancedConfig getAdvancedConfig()

withAdvancedConfig

public ConsolidationConfig withAdvancedConfig(AdvancedConfig advancedConfig)

makeCopy

public ConsolidationConfig makeCopy()

Creates and returns a deep copy of this ConsolidationConfig.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConsolidationConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConsolidationConfig.

Overrides:

toString in class java.lang.Object

check

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

Checks this ConsolidationConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException