com.exalead.mercury.mami.indexing.v10

Class AnalysisPolicy

java.lang.Object

com.exalead.mercury.mami.indexing.v10.AnalysisPolicy

All Implemented Interfaces:

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

Direct Known Subclasses:

AutomaticAnalysisPolicy, FixedThreadsAnalysisPolicy, PerSliceAnalysisPolicy, SameThreadAnalysisPolicy

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

Policy specifying how documents are dispatched to analysis threads.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalysisPolicy.MaxRAMConsumptionThreshold
static interface	AnalysisPolicy.Transformer<T>
static interface	AnalysisPolicy.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_R_A_M_CONSUMPTION_M_B
static java.lang.String	DEFAULT_MAX_R_A_M_CONSUMPTION_THRESHOLD
int	maxRAMConsumptionMB
java.lang.String	maxRAMConsumptionThreshold

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(AnalysisPolicy.Transformer<T> transformer, T[] t)
abstract void	accept(AnalysisPolicy.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this AnalysisPolicy.
static AnalysisPolicy	fromString(java.lang.String s) String representation of this AnalysisPolicy.
int	getMaxRAMConsumptionMB() The maximum of non-java RAM the analyzer can allocate.
java.lang.String	getMaxRAMConsumptionThreshold() When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index.
AnalysisPolicy.MaxRAMConsumptionThreshold	getMaxRAMConsumptionThresholdAsEnum() When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index.
static boolean	isA(java.lang.String str, AnalysisPolicy.MaxRAMConsumptionThreshold item)
static boolean	isOneOf(java.lang.String str, AnalysisPolicy.MaxRAMConsumptionThreshold... items)
AnalysisPolicy	makeCopy()
static AnalysisPolicy	readFrom(java.io.InputStream is) Read this AnalysisPolicy from an XML fragment.
void	setMaxRAMConsumptionMB(int maxRAMConsumptionMB) The maximum of non-java RAM the analyzer can allocate.
void	setMaxRAMConsumptionThreshold(AnalysisPolicy.MaxRAMConsumptionThreshold item) When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index.
void	setMaxRAMConsumptionThreshold(java.lang.String maxRAMConsumptionThreshold) When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index.
java.lang.String	toString() String representation of this AnalysisPolicy.
AnalysisPolicy	withMaxRAMConsumptionMB(int maxRAMConsumptionMB)
AnalysisPolicy	withMaxRAMConsumptionMB(java.lang.Integer maxRAMConsumptionMB)
AnalysisPolicy	withMaxRAMConsumptionThreshold(java.lang.String maxRAMConsumptionThreshold)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

maxRAMConsumptionThreshold

public java.lang.String maxRAMConsumptionThreshold

DEFAULT_MAX_R_A_M_CONSUMPTION_THRESHOLD

public static final java.lang.String DEFAULT_MAX_R_A_M_CONSUMPTION_THRESHOLD

See Also:

Constant Field Values

maxRAMConsumptionMB

public int maxRAMConsumptionMB

DEFAULT_MAX_R_A_M_CONSUMPTION_M_B

public static final int DEFAULT_MAX_R_A_M_CONSUMPTION_M_B

See Also:

Constant Field Values

Constructor Detail

AnalysisPolicy

public AnalysisPolicy()

AnalysisPolicy

public AnalysisPolicy(AnalysisPolicy o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          AnalysisPolicy.MaxRAMConsumptionThreshold item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              AnalysisPolicy.MaxRAMConsumptionThreshold... items)

setMaxRAMConsumptionThreshold

public void setMaxRAMConsumptionThreshold(AnalysisPolicy.MaxRAMConsumptionThreshold item)

When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.

• Enabled: Commits when the RAM size reaches the Threshold value specified (by default, 2048 MB).
• Auto: Commits when the RAM size reaches 2048 MB.'

getMaxRAMConsumptionThresholdAsEnum

public AnalysisPolicy.MaxRAMConsumptionThreshold getMaxRAMConsumptionThresholdAsEnum()

When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.

• Enabled: Commits when the RAM size reaches the Threshold value specified (by default, 2048 MB).
• Auto: Commits when the RAM size reaches 2048 MB.'

setMaxRAMConsumptionThreshold

public void setMaxRAMConsumptionThreshold(java.lang.String maxRAMConsumptionThreshold)

When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.

• Enabled: Commits when the RAM size reaches the Threshold value specified (by default, 2048 MB).
• Auto: Commits when the RAM size reaches 2048 MB.'

getMaxRAMConsumptionThreshold

public java.lang.String getMaxRAMConsumptionThreshold()

When reaching the RAM value specified, analysis is stopped and analyzed documents are imported to the index. Then analysis starts again.

• Enabled: Commits when the RAM size reaches the Threshold value specified (by default, 2048 MB).
• Auto: Commits when the RAM size reaches 2048 MB.'

withMaxRAMConsumptionThreshold

public AnalysisPolicy withMaxRAMConsumptionThreshold(java.lang.String maxRAMConsumptionThreshold)

setMaxRAMConsumptionMB

public void setMaxRAMConsumptionMB(int maxRAMConsumptionMB)

The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit.

getMaxRAMConsumptionMB

public int getMaxRAMConsumptionMB()

The maximum of non-java RAM the analyzer can allocate. Reaching this limit triggers a commit.

withMaxRAMConsumptionMB

public AnalysisPolicy withMaxRAMConsumptionMB(int maxRAMConsumptionMB)

withMaxRAMConsumptionMB

public AnalysisPolicy withMaxRAMConsumptionMB(java.lang.Integer maxRAMConsumptionMB)

makeCopy

public AnalysisPolicy makeCopy()

readFrom

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

Read this AnalysisPolicy 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this AnalysisPolicy.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AnalysisPolicy.

Overrides:

toString in class java.lang.Object

check

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

Checks this AnalysisPolicy.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

public abstract void accept(AnalysisPolicy.Visitor visitor)
                     throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public abstract <T> T accept(AnalysisPolicy.Transformer<T> transformer,
                             T[] t)
                      throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException