com.exalead.cloudview.consolidationapi.processors

Interface IMutableTransformationDocumentParameterized<T extends IMutableTransformationDocumentParameterized<T>>

All Superinterfaces:

IConsolidationDocument, IMutableConsolidationDocument<T>, ITransformationDocument

All Known Subinterfaces:

IMutableTransformationDocument

public interface IMutableTransformationDocumentParameterized<T extends IMutableTransformationDocumentParameterized<T>>
extends ITransformationDocument, IMutableConsolidationDocument<T>

Represents a document for the processors at the transformation phase.

Method Summary

Modifier and Type	Method and Description
void	addArcFrom(java.lang.String arcType, ITransformationDocument fromDoc) Registers an arc addition from another document to the current one.
void	addArcFrom(java.lang.String arcType, java.lang.String fromDocURI) Registers an arc addition from another document to the current one.
void	addArcTo(java.lang.String arcType, ITransformationDocument toDoc) Registers an arc addition from the current document to another one.
void	addArcTo(java.lang.String arcType, java.lang.String toDocURI) Registers an arc addition from the current document to another one.
void	removeAllPredecessorArcs() Registers for deletion all adjacent arcs heading to the current one.
void	removeAllSuccessorArcs() Registers for deletion all adjacent arcs starting from the current one.
void	removeArcFrom(java.lang.String arcType, ITransformationDocument fromDoc) Registers for deletion the arc starting from the document specified to the current one, with the type provided.
void	removeArcFrom(java.lang.String arcType, java.lang.String fromDocURI) Registers for deletion the arc starting from the document specified to the current one, with the type provided.
void	removeArcTo(java.lang.String arcType, ITransformationDocument toDoc) Registers for deletion the arc starting from the current document to the other one specified, with the type provided.
void	removeArcTo(java.lang.String arcType, java.lang.String toDocURI) Registers for deletion the arc starting from the current document to the other one specified, with the type provided.
void	setType(java.lang.String documentType, java.lang.String... parentTypes) Defines the document representative type, as well as its possible parents as defined in IConsolidationDocument.getTypeInheritance().

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

deleteDirective, deleteDirectives, deleteMeta, deleteMetas, deleteParts, deleteParts, setAllDirectives, setAllMetas, setAllParts, setDirective, setDirectives, setMeta, setMeta, setPart, setParts, setStamp, withDirective, withDirectives, withDirectives, withMeta, withMeta, withMetas, withPart, withParts, withParts

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

getAllDirectives, getAllMetas, getAllParts, getDirective, getDirectiveNames, getDirectives, getMeta, getMetaNames, getMetas, getOriginalSources, getPart, getPartNames, getParts, getSource, getStamp, getType, getTypeInheritance, getUri, hasDirective, hasMeta, hasPart, isOfType

Method Detail

addArcFrom

void addArcFrom(@Nonnull
                java.lang.String arcType,
                @Nonnull
                ITransformationDocument fromDoc)

Registers an arc addition from another document to the current one.

Parameters:

arcType - The new arc type.

fromDoc - The other document defining the arc tail.

addArcFrom

void addArcFrom(@Nonnull
                java.lang.String arcType,
                @Nonnull
                java.lang.String fromDocURI)

Registers an arc addition from another document to the current one.

Parameters:

arcType - The new arc type.

fromDocURI - The URI of the other document defining the arc tail.

addArcTo

void addArcTo(@Nonnull
              java.lang.String arcType,
              @Nonnull
              ITransformationDocument toDoc)

Registers an arc addition from the current document to another one.

Parameters:

arcType - The new arc type.

toDoc - The other document defining the arc head.

addArcTo

void addArcTo(@Nonnull
              java.lang.String arcType,
              @Nonnull
              java.lang.String toDocURI)

Registers an arc addition from the current document to another one.

Parameters:

arcType - The new arc type.

toDocURI - The URI of the other document defining the arc head.

removeAllPredecessorArcs

void removeAllPredecessorArcs()

Registers for deletion all adjacent arcs heading to the current one.

removeAllSuccessorArcs

void removeAllSuccessorArcs()

Registers for deletion all adjacent arcs starting from the current one.

removeArcFrom

void removeArcFrom(@Nonnull
                   java.lang.String arcType,
                   @Nonnull
                   ITransformationDocument fromDoc)

Registers for deletion the arc starting from the document specified to the current one, with the type provided.

Parameters:

arcType - The arc type to consider.

fromDoc - The other document defining the arc tail.

removeArcFrom

void removeArcFrom(@Nonnull
                   java.lang.String arcType,
                   @Nonnull
                   java.lang.String fromDocURI)

Registers for deletion the arc starting from the document specified to the current one, with the type provided.

Parameters:

arcType - The arc type to consider.

fromDocURI - The URI of the other document defining the arc tail.

removeArcTo

void removeArcTo(@Nonnull
                 java.lang.String arcType,
                 @Nonnull
                 ITransformationDocument toDoc)

Registers for deletion the arc starting from the current document to the other one specified, with the type provided.

Parameters:

arcType - The arc type to consider.

toDocURI - The other document defining the arc head.

removeArcTo

void removeArcTo(@Nonnull
                 java.lang.String arcType,
                 @Nonnull
                 java.lang.String toDocURI)

Registers for deletion the arc starting from the current document to the other one specified, with the type provided.

Parameters:

arcType - The arc type to consider.

toDocURI - The URI of the other document defining the arc head.

setType

void setType(@Nonnull
             java.lang.String documentType,
             @Nullable
             java.lang.String... parentTypes)

Defines the document representative type, as well as its possible parents as defined in IConsolidationDocument.getTypeInheritance().

Parameters:

documentType - The document representative type.

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