com.exalead.cloudview.consolidationapi.processors

Interface IDeleteTransformationHandler<P extends ITransformationDocument>

All Superinterfaces:

ITransformationHandler<P>

All Known Subinterfaces:

IJavaAllUpdatesTransformationHandler, IJavaDeleteTransformationHandler

public interface IDeleteTransformationHandler<P extends ITransformationDocument>
extends ITransformationHandler<P>

Provides a facade for all delete operations allowed on a transformation processor.

Method Summary

Modifier and Type	Method and Description
void	deleteDocument() Sends a deletion order for the document being transformed, and all of its children.
void	deleteDocument(P document) Sends a deletion order of the specified transformed document and all of its children.
void	deleteDocument(P document, boolean shouldBeRecursive) Sends a deletion order of the specified transformed document and optionally all of its children.
void	deleteDocument(java.lang.String uri) Sends a deletion order for the document with the given URI and all of its children.
void	deleteDocument(java.lang.String uri, boolean shouldBeRecursive) Sends a deletion order for the document with the given URI and optionally all of its children.
void	deleteDocumentChildren(P document) 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.
void	deleteDocumentChildren(java.lang.String parentURI) Sends a deletion order for all the document children.
void	deleteDocumentChildren(java.lang.String parentURI, java.lang.String path) Sends a deletion order for all the document children.
void	deleteDocumentRootPath(java.lang.String rootPath) Deletes a set of documents corresponding to a URI prefix.

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

discard, yield

Method Detail

deleteDocument

void deleteDocument()

Sends a deletion order for the document being transformed, and all of its children.

deleteDocument

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

Sends a deletion order for the document with the given URI and all of its children.

Parameters:

uri - The unique identifier of the document to remove.

deleteDocument

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

Sends a deletion order for the document with the given URI and optionally all of its children.

Parameters:

uri - The unique identifier of the document to remove.

shouldBeRecursive - If the flag is true, then the deletion order affects all document's children.

deleteDocument

void deleteDocument(@Nonnull
                    P document)

Sends a deletion order of the specified transformed document and all of its children.

Parameters:

document - The document to delete.

deleteDocument

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

Sends a deletion order of the specified transformed document and optionally all of its children.

Parameters:

document - The document to delete.

shouldBeRecursive - If the flag is true, then the deletion order affects all document's children.

deleteDocumentChildren

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

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

Parameters:

document - The parent document.

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 parentURI)

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

Parameters:

parentURI - The unique identifier of the parent document

deleteDocumentChildren

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

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

Parameters:

parentURI - The unique identifier of the parent document

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)

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

Parameters:

document - The parent document.

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.