com.exalead.cloudview.consolidationapi.processors

Interface IAggregationHandler<P extends IAggregationDocumentParameterized<P>>

Type Parameters:

P - The type of aggregated document on which the handler operates.

All Known Subinterfaces:

ICreateAggregationHandler<P>, IDeleteAggregationHandler<P>, IJavaAggregationHandler, IJavaAllUpdatesAggregationHandler, IJavaCreateAggregationHandler, IJavaDeleteAggregationHandler

public interface IAggregationHandler<P extends IAggregationDocumentParameterized<P>>

Provides the common operations for the aggregation processors.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXTRA_ORDERS_FLUSH_SIZE

Method Summary

Modifier and Type	Method and Description
void	discard() Discards the current document passed to the processor, that is prevents it from going to the next stage.
java.lang.String	getReason() Returns a string representing the reason for the document being pushed to aggregation.
java.util.List<java.util.List<P>>	match(P document, java.lang.String matchingExpression) Finds the list of paths in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.
java.util.List<P>	matchPathEnd(P document, java.lang.String matchingExpression) Returns the last documents of every paths in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.
java.util.List<P>	matchPathEnd(P document, java.lang.String matchingExpression, boolean testDirectives, boolean testParts, java.lang.String... metas) Finds the list of documents in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.
java.util.List<P>	matchPathEnd(P document, java.lang.String matchingExpression, java.lang.String... metas) Finds the list of documents in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.
void	yield(P document) Yields the given document to the next aggregation processor or to the Forwarding Rules.
void	yieldAndForward(P document) Yields the given document to the next aggregation processor.

Field Detail

EXTRA_ORDERS_FLUSH_SIZE

static final int EXTRA_ORDERS_FLUSH_SIZE

See Also:

Constant Field Values

Method Detail

discard

void discard()

Discards the current document passed to the processor, that is prevents it from going to the next stage.

getReason

java.lang.String getReason()

Returns a string representing the reason for the document being pushed to aggregation. It can be of three value: ADDED, DELETED, IMPACTED.

Returns:

A possibly null value if we don't know the reason (unexpected), otherwise one of the distinct values described.

match

java.util.List<java.util.List<P>> match(@Nonnull
                                        P document,
                                        @Nonnull
                                        java.lang.String matchingExpression)

Finds the list of paths in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.

Parameters:

document - The starting document from which we will evaluate the matching expression.

matchingExpression - Defines the valid sequence of arcs that will be returned if found in the graph.

Returns:

A list of result path.

matchPathEnd

java.util.List<P> matchPathEnd(P document,
                               java.lang.String matchingExpression)

Returns the last documents of every paths in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.

Parameters:

document - The starting document from which we will evaluate the matching expression.

matchingExpression - Defines the valid sequence of arcs that will be returned if found in the graph.

Returns:

A list of documents.

matchPathEnd

java.util.List<P> matchPathEnd(P document,
                               java.lang.String matchingExpression,
                               boolean testDirectives,
                               boolean testParts,
                               java.lang.String... metas)

Finds the list of documents in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression.

Parameters:

document - The starting document from which we will evaluate the matching expression.

matchingExpression - Defines the valid sequence of arcs that will be returned if found in the graph. The pattern string should preferably be a static string to allow the static code analyzed to extract it at build time which is required by the impact analysis.

testDirectives - If the directives should be checked for change.

testParts - If the parts should be checked for change.

metas - The metas to check for impact detection.

Returns:

A list of documents.

matchPathEnd

java.util.List<P> matchPathEnd(P document,
                               java.lang.String matchingExpression,
                               java.lang.String... metas)

Finds the list of documents in the graph that start from the specified IAggregationDocument and that satisfy the @i matchingExpression. This is equivalent to call #matchPathEnd(P, String, boolean, boolean, String...) with testDirectives and testParts as false values.

Parameters:

document - The starting document from which we will evaluate the matching expression.

matchingExpression - Defines the valid sequence of arcs that will be returned if found in the graph. The pattern string should preferably be a static string to allow the static code analyzed to extract it at build time which is required by the impact analysis.

metas - The metas to check for impact detection.

Returns:

A list of documents.

yield

void yield(@Nonnull
           P document)

Yields the given document to the next aggregation processor or to the Forwarding Rules. Note that such call is mandatory for newly created documents, i.e. documents created via the methods found in ICreateAggregationHandler. And it is optional for the current aggregated document being processed.

Parameters:

document - The document to yield.

yieldAndForward

void yieldAndForward(P document)

Yields the given document to the next aggregation processor. Note that such a call can only be called for newly created documents, and never for the current aggregated document being processed. Also note that when a document is yielded using this method, it is stacked with the document that triggered its creation. Hence if too many documents are forwarded using this rule for the same initial document issue could occur.

Parameters:

document - The document to yield.