com.exalead.cloudview.consolidationapi.processors

Interface ICreateAggregationHandler<P extends IAggregationDocumentParameterized<P>>

All Superinterfaces:

IAggregationHandler<P>

All Known Subinterfaces:

IJavaAllUpdatesAggregationHandler, IJavaCreateAggregationHandler

public interface ICreateAggregationHandler<P extends IAggregationDocumentParameterized<P>>
extends IAggregationHandler<P>

Provides the creation operations for the aggregation processors.

Field Summary

Fields inherited from interface com.exalead.cloudview.consolidationapi.processors.IAggregationHandler

EXTRA_ORDERS_FLUSH_SIZE

Method Summary

Modifier and Type	Method and Description
P	createChildDocument(P parentDocument, java.lang.String subURI, java.lang.String type, java.lang.String... parentTypes) Creates an aggregation document from a parent one and with the required given properties.
P	createDocument(java.lang.String uri, java.lang.String type, java.lang.String... parentTypes) Create an aggregation document with the required given properties.
void	fetchParts(P document, java.lang.String connectorName, java.lang.String connectorDocumentURI) Fetches the parts corresponding to the document @i connectorDocumentURI from the connector specified by @i connectorName and append them to the given @i document.
boolean	isFetchOperation() When a Fetch Server performs a fetch operation request to the Consolidation Server, this handler (and only in such case) will return true.

Methods inherited from interface com.exalead.cloudview.consolidationapi.processors.IAggregationHandler

discard, getReason, match, matchPathEnd, matchPathEnd, matchPathEnd, yield, yieldAndForward

Method Detail

createDocument

P createDocument(@Nonnull
                 java.lang.String uri,
                 @Nonnull
                 java.lang.String type,
                 @Nullable
                 java.lang.String... parentTypes)

Create an aggregation document with the required given properties. Note that in opposition to ICreateTransformationHandler.createDocument(String, String, String...) this document is not automatically deleted if no edges point on it at the end of the aggregation phase. Documents will be pushed as is to the Forward Rules (if yielded), and so directed (or not) to an Indexing Server or another Consolidation Instance.

Parameters:

uri - The unique document identifier.

type - The document representative type.

parentTypes - A possible list of parent types ordered from their natural hierarchy.

Returns:

A non-null instance of IAggregationDocument.

createChildDocument

P createChildDocument(@Nonnull
                      P parentDocument,
                      @Nonnull
                      java.lang.String subURI,
                      @Nonnull
                      java.lang.String type,
                      @Nullable
                      java.lang.String... parentTypes)

Creates an aggregation document from a parent one and with the required given properties.

Parameters:

parentDocument - The parent document to consider.

subURI - The sub-URI that will added to the parent one in order to define a new unique one.

type - The document representative type.

parentTypes - A possible list of parent types ordered from their natural hierarchy.

Returns:

A non-null instance of IAggregationDocument.

isFetchOperation

boolean isFetchOperation()

When a Fetch Server performs a fetch operation request to the Consolidation Server, this handler (and only in such case) will return true. When this the case, all the aggregation operations performed in the processor will all be directed in return to the Fetch Server. None of the documents aggregated will proceed to the Forward Rules Handler, and thus to the Indexing Server. The operations allowed in such event are the ones of a create/update context, with furthermore the fetchParts operation. Note that this feature is highly specific, and in most cases you won't need to care of such situation. It is also likely to be removed in future releases.

Returns:

True if this is a fetch operation, false otherwise.

fetchParts

void fetchParts(@Nonnull
                P document,
                @Nonnull
                java.lang.String connectorName,
                @Nonnull
                java.lang.String connectorDocumentURI)

Fetches the parts corresponding to the document @i connectorDocumentURI from the connector specified by @i connectorName and append them to the given @i document.

Parameters:

document - the given document

connectorName - the connector name

connectorDocumentURI - the connector's document URI