com.exalead.cloudview.consolidationapi.processors

Interface IDeleteAggregationHandler<P extends IAggregationDocumentParameterized<P>>

All Superinterfaces:

IAggregationHandler<P>

All Known Subinterfaces:

IJavaAllUpdatesAggregationHandler, IJavaDeleteAggregationHandler

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

Provides a facade for all delete operations allowed on an aggregation processor.

Field Summary

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

EXTRA_ORDERS_FLUSH_SIZE

Method Summary

Modifier and Type	Method and Description
void	deleteDocument() Sends a recursive deletion order for the document being aggregated, and all the other documents with a prefix matching the current document URI.
void	deleteDocument(java.util.List<java.lang.String> forwardRulesTypes) Sends a recursive deletion order for the document being aggregated, and all the other sub-documents with a prefix matching the current document URI.
void	deleteDocument(P document) Sends a recursive deletion order of the specified aggregated document and possibly all documents with a prefix matching the document URI.
void	deleteDocument(P document, boolean shouldBeRecursive) Sends a deletion order of the specified aggregated document, recursive or not.
void	deleteDocument(P document, boolean shouldBeRecursive, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order of the specified aggregated document, recursive or not.
void	deleteDocument(P document, java.util.List<java.lang.String> forwardRulesTypes) Sends a recursive deletion order of the specified aggregated document and possibly all documents with a prefix matching the document URI.
void	deleteDocument(java.lang.String uri) Sends a recursive deletion order for the document with the given uri prefix.
void	deleteDocument(java.lang.String uri, boolean shouldBeRecursive) Sends a deletion order for the document with the given uri, recursive or not.
void	deleteDocument(java.lang.String uri, boolean shouldBeRecursive, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order for the document with the given uri, recursive or not.
void	deleteDocument(java.lang.String uri, java.util.List<java.lang.String> forwardRulesTypes) Sends a recursive deletion order for the document with the given uri prefix.
void	deleteDocumentChildren(P document) Sends a deletion order for all the document children.
void	deleteDocumentChildren(P document, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order for all the document children.
void	deleteDocumentChildren(P document, java.lang.String path) Sends a deletion order for all the document children matching the given path.
void	deleteDocumentChildren(P document, java.lang.String path, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order for all the document children matching the given path.
void	deleteDocumentChildren(java.lang.String uri) Sends a deletion order for all the document children.
void	deleteDocumentChildren(java.lang.String uri, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order for all the document children.
void	deleteDocumentChildren(java.lang.String uri, java.lang.String path) Sends a deletion order for all the document children matching the given path.
void	deleteDocumentChildren(java.lang.String uri, java.lang.String path, java.util.List<java.lang.String> forwardRulesTypes) Sends a deletion order for all the document children matching the given path.
void	deleteDocumentRootPath(java.lang.String rootPath) Deletes a set of documents corresponding to a URI prefix.
void	deleteDocumentRootPath(java.lang.String rootPath, java.util.List<java.lang.String> forwardRulesTypes) Deletes all the documents matching the rootPath prefix, and with some forward rules types in order to allow correct routing/filtering by the Forward Rules handler (if needed).

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

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

Method Detail

deleteDocument

void deleteDocument()

Sends a recursive deletion order for the document being aggregated, and all the other documents with a prefix matching the current document URI.

deleteDocument

void deleteDocument(@Nullable
                    java.util.List<java.lang.String> forwardRulesTypes)

Sends a recursive deletion order for the document being aggregated, and all the other sub-documents with a prefix matching the current document URI. Furthermore a recursive deletion order with the current document URI will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocument

void deleteDocument(@Nonnull
                    java.lang.String uri)

Sends a recursive deletion order for the document with the given uri prefix.

Parameters:

uri - The unique identifier of the document to remove.

deleteDocument

void deleteDocument(@Nonnull
                    java.lang.String uri,
                    @Nullable
                    java.util.List<java.lang.String> forwardRulesTypes)

Sends a recursive deletion order for the document with the given uri prefix. Furthermore a recursive deletion order with the given document URI will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

uri - The unique identifier of the document to remove.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocument

void deleteDocument(@Nonnull
                    java.lang.String uri,
                    @Nonnull
                    boolean shouldBeRecursive)

Sends a deletion order for the document with the given uri, recursive or not.

Parameters:

uri - The unique identifier of the document to remove.

shouldBeRecursive - If the flag is true, then the deletion order affects all documents matching this same document URI prefix.

deleteDocument

void deleteDocument(@Nonnull
                    java.lang.String uri,
                    boolean shouldBeRecursive,
                    @Nullable
                    java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order for the document with the given uri, recursive or not. Furthermore a deletion order (recursive or not) with the given document URI will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

uri - The unique identifier of the document to remove.

shouldBeRecursive - If the flag is true, then the deletion order affects all documents matching this same document URI prefix.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocument

void deleteDocument(@Nonnull
                    P document)

Sends a recursive deletion order of the specified aggregated document and possibly all documents with a prefix matching the document URI.

Parameters:

document - The document to delete.

deleteDocument

void deleteDocument(@Nonnull
                    P document,
                    @Nullable
                    java.util.List<java.lang.String> forwardRulesTypes)

Sends a recursive deletion order of the specified aggregated document and possibly all documents with a prefix matching the document URI. Furthermore a recursive deletion order with the given document will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

document - The document to delete.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocument

void deleteDocument(@Nonnull
                    P document,
                    @Nonnull
                    boolean shouldBeRecursive)

Sends a deletion order of the specified aggregated document, recursive or not.

Parameters:

document - The document to delete.

shouldBeRecursive - If the flag is true, then the deletion order affects all documents matching this same document URI prefix.

deleteDocument

void deleteDocument(@Nonnull
                    P document,
                    boolean shouldBeRecursive,
                    @Nullable
                    java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order of the specified aggregated document, recursive or not. Furthermore a deletion order (recursive or not) with the given document will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

document - The document to delete.

shouldBeRecursive - If the flag is true, then the deletion order affects all documents matching this same document URI prefix.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            P document,
                            @Nullable
                            java.lang.String path)

Sends a deletion order for all the document children matching the given path. The document itself is not deleted.

Parameters:

document - The document root to consider.

path - A string prefix of the children URIs to be deleted, or an empty/null string to delete all children.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            P document,
                            @Nullable
                            java.lang.String path,
                            @Nullable
                            java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order for all the document children matching the given path. The document itself is not deleted. Furthermore a recursive children deletion order with the given document will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

document - The document root to consider.

path - A string prefix of the children URIs to be deleted, or an empty/null string to delete all children.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            java.lang.String uri,
                            @Nullable
                            java.lang.String path)

Sends a deletion order for all the document children matching the given path. The document itself is not deleted.

Parameters:

uri - The parent document URI to consider.

path - A string prefix of the children URIs to be deleted, or an empty/null string to delete all children.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            java.lang.String uri,
                            @Nullable
                            java.lang.String path,
                            @Nullable
                            java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order for all the document children matching the given path. The document itself is not deleted. Furthermore a recursive children deletion order with the given document URI will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

uri - The parent document URI to consider.

path - A string prefix of the children URIs to be deleted, or an empty/null string to delete all children.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            P document)

Sends a deletion order for all the document children. The document itself is not deleted.

Parameters:

document - The document root to consider.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            P document,
                            @Nullable
                            java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order for all the document children. The document itself is not deleted. Furthermore a recursive children deletion order with the given document will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

document - The document root to consider.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            java.lang.String uri)

Sends a deletion order for all the document children. The document itself is not deleted.

Parameters:

uri - The parent document URI to consider.

deleteDocumentChildren

void deleteDocumentChildren(@Nonnull
                            java.lang.String uri,
                            @Nullable
                            java.util.List<java.lang.String> forwardRulesTypes)

Sends a deletion order for all the document children. The document itself is not deleted. Furthermore a recursive children deletion order with the given document URI will be sent with the additional forward rules types provided in order to delete documents not known in the Consolidation Store while allowing correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

uri - The parent document URI to consider.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.

deleteDocumentRootPath

void deleteDocumentRootPath(@Nonnull
                            java.lang.String rootPath)

Deletes a set of documents corresponding to a URI prefix. All the documents matching the rootPath prefix will be deleted.

Parameters:

rootPath - An URI prefix used to select the documents to be deleted.

deleteDocumentRootPath

void deleteDocumentRootPath(@Nonnull
                            java.lang.String rootPath,
                            @Nullable
                            java.util.List<java.lang.String> forwardRulesTypes)

Deletes all the documents matching the rootPath prefix, and with some forward rules types in order to allow correct routing/filtering by the Forward Rules handler (if needed).

Parameters:

rootPath - An URI prefix used to select the documents to be deleted.

forwardRulesTypes - The forward rules types to consider to allow a proper behavior for documents not known in the Consolidation Store.