com.exalead.mercury.mami.consolidation.v10

Class CustomAggregation

java.lang.Object

com.exalead.mercury.mami.consolidation.v10.CSSpecific

com.exalead.mercury.mami.consolidation.v10.CustomAggregation

All Implemented Interfaces:

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

public class CustomAggregation
extends CSSpecific
implements com.exalead.util.Checkable, java.io.Serializable

This command triggers an aggregation with custom parameters. It allows you to specify the types or URIs on which to perform the aggregation.
CAUTION: Depending on the specified option, its execution can result in an inconsistent state of the consolidation storage, where some documents could be missing after aggregation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
AggregationForwardProcessorConfigList	aggregationForwardProcessorConfigList
static boolean	DEFAULT_FORCE_COMMIT
static boolean	DEFAULT_OVERRIDE_DETECTED_MATCHING_EXPRESSIONS
static boolean	DEFAULT_TRIGGER_IMPACT_DETECTION
java.lang.String	excludeTypes
java.lang.String	excludeURIs
boolean	forceCommit
java.lang.String	includeTypes
java.lang.String	includeURIs
boolean	overrideDetectedMatchingExpressions
boolean	triggerImpactDetection

Fields inherited from class com.exalead.mercury.mami.consolidation.v10.CSSpecific

instanceName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this CustomAggregation.
static CustomAggregation	fromString(java.lang.String s) String representation of this CustomAggregation.
AggregationForwardProcessorConfigList	getAggregationForwardProcessorConfigList()
java.lang.String	getExcludeTypes()
java.lang.String	getExcludeURIs()
java.lang.String	getIncludeTypes()
java.lang.String	getIncludeURIs()
boolean	isForceCommit() Updates the commit pointer. CAUTION: If set to true, it can break impact detection for excluded document types or URIs.
boolean	isOverrideDetectedMatchingExpressions() Overrides matching expressions detected during standard aggregation.
boolean	isTriggerImpactDetection() Triggers the impact detection.
CustomAggregation	makeCopy() Creates and returns a deep copy of this CustomAggregation.
static CustomAggregation	readFrom(java.io.InputStream is) Read this CustomAggregation from an XML fragment.
void	setAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)
void	setExcludeTypes(java.lang.String excludeTypes)
void	setExcludeURIs(java.lang.String excludeURIs)
void	setForceCommit(boolean forceCommit) Updates the commit pointer. CAUTION: If set to true, it can break impact detection for excluded document types or URIs.
void	setIncludeTypes(java.lang.String includeTypes)
void	setIncludeURIs(java.lang.String includeURIs)
void	setOverrideDetectedMatchingExpressions(boolean overrideDetectedMatchingExpressions) Overrides matching expressions detected during standard aggregation.
void	setTriggerImpactDetection(boolean triggerImpactDetection) Triggers the impact detection.
java.lang.String	toString() String representation of this CustomAggregation.
CustomAggregation	withAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)
CustomAggregation	withExcludeTypes(java.lang.String excludeTypes)
CustomAggregation	withExcludeURIs(java.lang.String excludeURIs)
CustomAggregation	withForceCommit(boolean forceCommit)
CustomAggregation	withForceCommit(java.lang.Boolean forceCommit)
CustomAggregation	withIncludeTypes(java.lang.String includeTypes)
CustomAggregation	withIncludeURIs(java.lang.String includeURIs)
CustomAggregation	withInstanceName(java.lang.String instanceName)
CustomAggregation	withOverrideDetectedMatchingExpressions(boolean overrideDetectedMatchingExpressions)
CustomAggregation	withOverrideDetectedMatchingExpressions(java.lang.Boolean overrideDetectedMatchingExpressions)
CustomAggregation	withTriggerImpactDetection(boolean triggerImpactDetection)
CustomAggregation	withTriggerImpactDetection(java.lang.Boolean triggerImpactDetection)
void	writeTo(java.io.OutputStream os) Write this CustomAggregation as an XML fragment

Methods inherited from class com.exalead.mercury.mami.consolidation.v10.CSSpecific

getInstanceName, setInstanceName

Methods inherited from class java.lang.Object

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

Field Detail

includeURIs

public java.lang.String includeURIs

excludeURIs

public java.lang.String excludeURIs

includeTypes

public java.lang.String includeTypes

excludeTypes

public java.lang.String excludeTypes

forceCommit

public boolean forceCommit

DEFAULT_FORCE_COMMIT

public static final boolean DEFAULT_FORCE_COMMIT

See Also:

Constant Field Values

overrideDetectedMatchingExpressions

public boolean overrideDetectedMatchingExpressions

DEFAULT_OVERRIDE_DETECTED_MATCHING_EXPRESSIONS

public static final boolean DEFAULT_OVERRIDE_DETECTED_MATCHING_EXPRESSIONS

See Also:

Constant Field Values

triggerImpactDetection

public boolean triggerImpactDetection

DEFAULT_TRIGGER_IMPACT_DETECTION

public static final boolean DEFAULT_TRIGGER_IMPACT_DETECTION

See Also:

Constant Field Values

aggregationForwardProcessorConfigList

public AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList

Constructor Detail

CustomAggregation

public CustomAggregation()

CustomAggregation

public CustomAggregation(CustomAggregation o)

Copy constructor

Method Detail

withInstanceName

public CustomAggregation withInstanceName(java.lang.String instanceName)

Overrides:

withInstanceName in class CSSpecific

setIncludeURIs

public void setIncludeURIs(java.lang.String includeURIs)

getIncludeURIs

public java.lang.String getIncludeURIs()

withIncludeURIs

public CustomAggregation withIncludeURIs(java.lang.String includeURIs)

setExcludeURIs

public void setExcludeURIs(java.lang.String excludeURIs)

getExcludeURIs

public java.lang.String getExcludeURIs()

withExcludeURIs

public CustomAggregation withExcludeURIs(java.lang.String excludeURIs)

setIncludeTypes

public void setIncludeTypes(java.lang.String includeTypes)

getIncludeTypes

public java.lang.String getIncludeTypes()

withIncludeTypes

public CustomAggregation withIncludeTypes(java.lang.String includeTypes)

setExcludeTypes

public void setExcludeTypes(java.lang.String excludeTypes)

getExcludeTypes

public java.lang.String getExcludeTypes()

withExcludeTypes

public CustomAggregation withExcludeTypes(java.lang.String excludeTypes)

setForceCommit

public void setForceCommit(boolean forceCommit)

Updates the commit pointer.
CAUTION: If set to true, it can break impact detection for excluded document types or URIs.

isForceCommit

public boolean isForceCommit()

Updates the commit pointer.
CAUTION: If set to true, it can break impact detection for excluded document types or URIs.

withForceCommit

public CustomAggregation withForceCommit(boolean forceCommit)

withForceCommit

public CustomAggregation withForceCommit(java.lang.Boolean forceCommit)

setOverrideDetectedMatchingExpressions

public void setOverrideDetectedMatchingExpressions(boolean overrideDetectedMatchingExpressions)

Overrides matching expressions detected during standard aggregation. This action is forced if the forceCommit option is set to true.
Enabling this option if the aggregation is launched on a subset of documents only, might break the impact detection for the other documents.

isOverrideDetectedMatchingExpressions

public boolean isOverrideDetectedMatchingExpressions()

Overrides matching expressions detected during standard aggregation. This action is forced if the forceCommit option is set to true.
Enabling this option if the aggregation is launched on a subset of documents only, might break the impact detection for the other documents.

withOverrideDetectedMatchingExpressions

public CustomAggregation withOverrideDetectedMatchingExpressions(boolean overrideDetectedMatchingExpressions)

withOverrideDetectedMatchingExpressions

public CustomAggregation withOverrideDetectedMatchingExpressions(java.lang.Boolean overrideDetectedMatchingExpressions)

setTriggerImpactDetection

public void setTriggerImpactDetection(boolean triggerImpactDetection)

Triggers the impact detection.

isTriggerImpactDetection

public boolean isTriggerImpactDetection()

Triggers the impact detection.

withTriggerImpactDetection

public CustomAggregation withTriggerImpactDetection(boolean triggerImpactDetection)

withTriggerImpactDetection

public CustomAggregation withTriggerImpactDetection(java.lang.Boolean triggerImpactDetection)

setAggregationForwardProcessorConfigList

public void setAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)

getAggregationForwardProcessorConfigList

public AggregationForwardProcessorConfigList getAggregationForwardProcessorConfigList()

withAggregationForwardProcessorConfigList

public CustomAggregation withAggregationForwardProcessorConfigList(AggregationForwardProcessorConfigList aggregationForwardProcessorConfigList)

makeCopy

public CustomAggregation makeCopy()

Creates and returns a deep copy of this CustomAggregation.

Overrides:

makeCopy in class CSSpecific

readFrom

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

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

Overrides:

writeTo in class CSSpecific

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomAggregation.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomAggregation.

Overrides:

toString in class CSSpecific

check

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

Checks this CustomAggregation.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class CSSpecific

Throws:

com.exalead.util.TypedException