com.exalead.cloudview.alerting.v10

Class StandardIncrementalModeConfig

java.lang.Object

com.exalead.cloudview.alerting.v10.IncrementalModeConfig

com.exalead.cloudview.alerting.v10.StandardIncrementalModeConfig

All Implemented Interfaces:

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

public class StandardIncrementalModeConfig
extends IncrementalModeConfig
implements com.exalead.util.Checkable, java.io.Serializable

A simple implementation of incremental mode. Using this mode may cause some documents that have already been alerted
to trigger another alert.

When each document is analyzed, an analysis timestamp is attached to this document. When triggering the alert query,
the criteria "analysis_timestamp > (PREVIOUS_ALERT_TRIGGER_TIMESTAMP - OFFSET)" is added to the user query.
PREVIOUS_ALERT_TRIGGER_TIMESTAMP is then set to the current timestamp.

The OFFSET is required to account for the time delta between the moment a document is analyzed and the moment it is available
for queries.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	analysisTimestampIndexField
static java.lang.String	DEFAULT_ANALYSIS_TIMESTAMP_INDEX_FIELD
static long	DEFAULT_TIMESTAMP_OFFSET_S
static java.lang.String	DEFAULT_TIMESTAMP_RESTRICTION_PAGE_PARAMETER
long	timestampOffsetS
java.lang.String	timestampRestrictionPageParameter

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this StandardIncrementalModeConfig.
static StandardIncrementalModeConfig	fromString(java.lang.String s) String representation of this StandardIncrementalModeConfig.
java.lang.String	getAnalysisTimestampIndexField()
long	getTimestampOffsetS() Negative offset in seconds on the previous trigger timestamp, to account for the time delta between the moment a document is analyzed and the moment it is available for queries.
java.lang.String	getTimestampRestrictionPageParameter() Name of the Mashup-API page parameter to send the ELLQL query for timestamp restriction
StandardIncrementalModeConfig	makeCopy() Creates and returns a deep copy of this StandardIncrementalModeConfig.
static StandardIncrementalModeConfig	readFrom(java.io.InputStream is) Read this StandardIncrementalModeConfig from an XML fragment.
void	setAnalysisTimestampIndexField(java.lang.String analysisTimestampIndexField)
void	setTimestampOffsetS(long timestampOffsetS) Negative offset in seconds on the previous trigger timestamp, to account for the time delta between the moment a document is analyzed and the moment it is available for queries.
void	setTimestampRestrictionPageParameter(java.lang.String timestampRestrictionPageParameter) Name of the Mashup-API page parameter to send the ELLQL query for timestamp restriction
java.lang.String	toString() String representation of this StandardIncrementalModeConfig.
StandardIncrementalModeConfig	withAnalysisTimestampIndexField(java.lang.String analysisTimestampIndexField)
StandardIncrementalModeConfig	withTimestampOffsetS(long timestampOffsetS)
StandardIncrementalModeConfig	withTimestampOffsetS(java.lang.Long timestampOffsetS)
StandardIncrementalModeConfig	withTimestampRestrictionPageParameter(java.lang.String timestampRestrictionPageParameter)
void	writeTo(java.io.OutputStream os) Write this StandardIncrementalModeConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

analysisTimestampIndexField

public java.lang.String analysisTimestampIndexField

DEFAULT_ANALYSIS_TIMESTAMP_INDEX_FIELD

public static final java.lang.String DEFAULT_ANALYSIS_TIMESTAMP_INDEX_FIELD

See Also:

Constant Field Values

timestampRestrictionPageParameter

public java.lang.String timestampRestrictionPageParameter

DEFAULT_TIMESTAMP_RESTRICTION_PAGE_PARAMETER

public static final java.lang.String DEFAULT_TIMESTAMP_RESTRICTION_PAGE_PARAMETER

See Also:

Constant Field Values

timestampOffsetS

public long timestampOffsetS

DEFAULT_TIMESTAMP_OFFSET_S

public static final long DEFAULT_TIMESTAMP_OFFSET_S

See Also:

Constant Field Values

Constructor Detail

StandardIncrementalModeConfig

public StandardIncrementalModeConfig()

StandardIncrementalModeConfig

public StandardIncrementalModeConfig(StandardIncrementalModeConfig o)

Copy constructor

Method Detail

setAnalysisTimestampIndexField

public void setAnalysisTimestampIndexField(java.lang.String analysisTimestampIndexField)

getAnalysisTimestampIndexField

public java.lang.String getAnalysisTimestampIndexField()

withAnalysisTimestampIndexField

public StandardIncrementalModeConfig withAnalysisTimestampIndexField(java.lang.String analysisTimestampIndexField)

setTimestampRestrictionPageParameter

public void setTimestampRestrictionPageParameter(java.lang.String timestampRestrictionPageParameter)

Name of the Mashup-API page parameter to send the ELLQL query for timestamp restriction

getTimestampRestrictionPageParameter

public java.lang.String getTimestampRestrictionPageParameter()

Name of the Mashup-API page parameter to send the ELLQL query for timestamp restriction

withTimestampRestrictionPageParameter

public StandardIncrementalModeConfig withTimestampRestrictionPageParameter(java.lang.String timestampRestrictionPageParameter)

setTimestampOffsetS

public void setTimestampOffsetS(long timestampOffsetS)

Negative offset in seconds on the previous trigger timestamp, to account for the time delta between
the moment a document is analyzed and the moment it is available for queries.

getTimestampOffsetS

public long getTimestampOffsetS()

Negative offset in seconds on the previous trigger timestamp, to account for the time delta between
the moment a document is analyzed and the moment it is available for queries.

withTimestampOffsetS

public StandardIncrementalModeConfig withTimestampOffsetS(long timestampOffsetS)

withTimestampOffsetS

public StandardIncrementalModeConfig withTimestampOffsetS(java.lang.Long timestampOffsetS)

makeCopy

public StandardIncrementalModeConfig makeCopy()

Creates and returns a deep copy of this StandardIncrementalModeConfig.

Overrides:

makeCopy in class IncrementalModeConfig

readFrom

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

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

Overrides:

writeTo in class IncrementalModeConfig

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this StandardIncrementalModeConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this StandardIncrementalModeConfig.

Overrides:

toString in class IncrementalModeConfig

check

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

Checks this StandardIncrementalModeConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IncrementalModeConfig

Throws:

com.exalead.util.TypedException