com.exalead.cloudview.consolidationapi.processors

Interface ICreateTransformationHandler<P extends ITransformationDocument,R extends IMutableTransformationDocumentParameterized<R>>

All Superinterfaces:

ITransformationHandler<P>

All Known Subinterfaces:

IJavaAllUpdatesTransformationHandler, IJavaCreateTransformationHandler

public interface ICreateTransformationHandler<P extends ITransformationDocument,R extends IMutableTransformationDocumentParameterized<R>>
extends ITransformationHandler<P>

Provides the creation operations for the IJavaAllUpdatesTransformationHandler regarding the transformation processors.

Method Summary

Modifier and Type	Method and Description
R	createChildDocument(P parentDocument, java.lang.String subURI, java.lang.String type, java.lang.String... parentTypes) Creates a transformation document from a parent one and with the required given properties.
R	createDocument(java.lang.String uri, java.lang.String type, java.lang.String... parentTypes) Creates a transformation document with the required given properties, and with automatic memory management.
R	createUnmanagedDocument(java.lang.String uri, java.lang.String type, java.lang.String... parentTypes) Creates a transformation document with the required given properties without automatic memory management (as described in createDocument(String, String, String...).

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

discard, yield

Method Detail

createDocument

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

Creates a transformation document with the required given properties, and with automatic memory management. What the latter really means is that if at the end of the transformation phase no arcs point on it, it will be automatically destroyed by the consolidation server. This is on opposition with createUnmanagedDocument(String, String, String...) where one needs to delete the created document explicitly.

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 IMutableTransformationDocument.

createChildDocument

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

Creates a transformation 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 IMutableTransformationDocument.

createUnmanagedDocument

R createUnmanagedDocument(@Nonnull
                          java.lang.String uri,
                          @Nonnull
                          java.lang.String type,
                          @Nullable
                          java.lang.String... parentTypes)

Creates a transformation document with the required given properties without automatic memory management (as described in createDocument(String, String, String...).

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 IMutableTransformationDocument.