com.exalead.cloudview.consolidationapi.processors

Interface IMutableConsolidationDocument<T>

Type Parameters:

T - The derived type that will implement such interface, in order to allow method call chaining.

All Superinterfaces:

IConsolidationDocument

All Known Subinterfaces:

IAggregationDocument, IAggregationDocumentParameterized<T>, IMutableTransformationDocument, IMutableTransformationDocumentParameterized<T>

public interface IMutableConsolidationDocument<T>
extends IConsolidationDocument

Enriches the set of operations available within IConsolidationDocument with a list of operations allowing the modifications of the internal data.

Method Summary

Modifier and Type	Method and Description
T	deleteDirective(java.lang.String name) Deletes the given directive values associated to the given name.
T	deleteDirectives(java.lang.String name, java.lang.String... values) Deletes only the directives values given from the directive name provided.
T	deleteMeta(java.lang.String name) Deletes all the meta values associated to the given name.
T	deleteMetas(java.lang.String name, java.lang.String... values) Deletes only the meta values given from the meta name provided.
T	deleteParts(java.lang.String name) Deletes the associated document parts related to the given part name.
T	deleteParts(java.lang.String name, IDocumentPart... documentParts) Deletes all the part directives values for the part name provided.
T	setAllDirectives(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> directives) Assigns all the directives name/values association to the current document.
T	setAllMetas(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> metas) Assigns all the meta name/values association to the current document.
T	setAllParts(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>> parts) Assigns all the parts associations to the current document.
T	setDirective(java.lang.String name, java.lang.String value) Assigns the only directive value for the given name provided.
T	setDirectives(java.lang.String name, java.lang.Iterable<java.lang.String> values) Assigns the directive values for the given name provided.
T	setMeta(java.lang.String name, java.lang.Iterable<java.lang.String> values) Assigns the meta values for the given name provided.
T	setMeta(java.lang.String name, java.lang.String value) Assigns the only meta value for the given name provided.
T	setPart(java.lang.String name, IDocumentPart documentPart) Assigns the document part for the given name provided.
T	setParts(java.lang.String name, java.lang.Iterable<IDocumentPart> documentParts) Assigns the document parts for the given name provided.
default T	setStamp(java.lang.String value) Assigns the stamp with the given value.
T	withDirective(java.lang.String name, java.lang.String value) Adds for the particular name the directive value to the possible list of predefined ones.
T	withDirectives(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> directives) Adds the list of directive key-values to the possible list of predefined ones.
T	withDirectives(java.lang.String name, java.lang.Iterable<java.lang.String> values) Adds for the particular name the directive values to the possible list of predefined ones.
T	withMeta(java.lang.String name, java.lang.Iterable<java.lang.String> values) Adds for the particular name the meta values to the possible list of predefined ones.
T	withMeta(java.lang.String name, java.lang.String value, java.lang.String... otherValues) Adds for the particular name the meta value to the possible list of predefined ones.
T	withMetas(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> metas) Adds the list of meta key-values to the possible list of predefined ones.
T	withPart(java.lang.String name, IDocumentPart documentPart) Adds the document part to the list of predefined ones for the given name.
T	withParts(java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>> parts) Adds the list of part associations to the current document.
T	withParts(java.lang.String name, java.lang.Iterable<IDocumentPart> documentParts) Adds the sequence of document parts to the list of predefined ones for the given name.

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

deleteDirective

T deleteDirective(@Nonnull
                  java.lang.String name)

Deletes the given directive values associated to the given name.

Parameters:

name - The directive name of interest.

Returns:

The current document instance in order to allow method call chaining.

deleteDirectives

T deleteDirectives(@Nonnull
                   java.lang.String name,
                   @Nonnull
                   java.lang.String... values)

Deletes only the directives values given from the directive name provided.

Parameters:

name - The directive name of interest.

values - The list of directives values to remove from the original list of values.

Returns:

The current document instance in order to allow method call chaining.

deleteMeta

T deleteMeta(@Nonnull
             java.lang.String name)

Deletes all the meta values associated to the given name.

Parameters:

name - The meta name of interest.

Returns:

The current document instance in order to allow method call chaining.

deleteMetas

T deleteMetas(@Nonnull
              java.lang.String name,
              @Nonnull
              java.lang.String... values)

Deletes only the meta values given from the meta name provided.

Parameters:

name - The meta name of interest.

values - The list of meta values to remove from the original list of values.

Returns:

The current document instance in order to allow method call chaining.

deleteParts

T deleteParts(@Nonnull
              java.lang.String name)

Deletes the associated document parts related to the given part name.

Parameters:

name - The part name of interest.

Returns:

The current document instance in order to allow method call chaining.

deleteParts

T deleteParts(@Nonnull
              java.lang.String name,
              @Nonnull
              IDocumentPart... documentParts)

Deletes all the part directives values for the part name provided.

Parameters:

name - The part name of interest.

documentParts - The list of document parts to remove from the original list of values.

Returns:

The current document instance in order to allow method call chaining.

setDirective

T setDirective(@Nonnull
               java.lang.String name,
               @Nonnull
               java.lang.String value)

Assigns the only directive value for the given name provided.

Parameters:

name - The directive name of interest.

value - The directive value to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setDirectives

T setDirectives(@Nonnull
                java.lang.String name,
                @Nonnull
                java.lang.Iterable<java.lang.String> values)

Assigns the directive values for the given name provided.

Parameters:

name - The directive name of interest.

values - The directive values to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setAllDirectives

T setAllDirectives(@Nonnull
                   java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> directives)

Assigns all the directives name/values association to the current document.

Parameters:

directives - The directive name/values to consider.

Returns:

The current document instance in order to allow method call chaining.

setMeta

T setMeta(@Nonnull
          java.lang.String name,
          @Nonnull
          java.lang.String value)

Assigns the only meta value for the given name provided.

Parameters:

name - The meta name of interest.

value - The meta value to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setMeta

T setMeta(@Nonnull
          java.lang.String name,
          @Nonnull
          java.lang.Iterable<java.lang.String> values)

Assigns the meta values for the given name provided.

Parameters:

name - The meta name of interest.

values - The meta values to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setAllMetas

T setAllMetas(@Nonnull
              java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> metas)

Assigns all the meta name/values association to the current document.

Parameters:

metas - The meta name/values to consider.

Returns:

The current document instance in order to allow method call chaining.

setPart

T setPart(@Nonnull
          java.lang.String name,
          @Nonnull
          IDocumentPart documentPart)

Assigns the document part for the given name provided.

Parameters:

name - The part name of interest.

value - The document part to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setParts

T setParts(@Nonnull
           java.lang.String name,
           @Nonnull
           java.lang.Iterable<IDocumentPart> documentParts)

Assigns the document parts for the given name provided.

Parameters:

name - The part name of interest.

value - The document part to associate to it.

Returns:

The current document instance in order to allow method call chaining.

setAllParts

T setAllParts(@Nonnull
              java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>> parts)

Assigns all the parts associations to the current document.

Parameters:

parts - The part name/documents to consider.

Returns:

The current document instance in order to allow method call chaining.

setStamp

default T setStamp(@Nullable
                   java.lang.String value)

Assigns the stamp with the given value.

Parameters:

value - The stamp to associate to it.

Returns:

The current document instance in order to allow method call chaining.

withDirective

T withDirective(@Nonnull
                java.lang.String name,
                @Nonnull
                java.lang.String value)

Adds for the particular name the directive value to the possible list of predefined ones. If none are defined a new list will be created.

Parameters:

name - The directive name of interest.

value - The directive value associated to it.

Returns:

The current document instance in order to allow method call chaining.

withDirectives

T withDirectives(@Nonnull
                 java.lang.String name,
                 @Nonnull
                 java.lang.Iterable<java.lang.String> values)

Adds for the particular name the directive values to the possible list of predefined ones. If none are defined a new list will be created.

Parameters:

name - The directive name of interest.

values - The directive values to add or associate to it.

Returns:

The current document instance in order to allow method call chaining.

withDirectives

T withDirectives(@Nonnull
                 java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> directives)

Adds the list of directive key-values to the possible list of predefined ones.

Parameters:

directives - The list of key-values directives.

Returns:

The current document instance in order to allow method call chaining.

withMeta

T withMeta(@Nonnull
           java.lang.String name,
           @Nonnull
           java.lang.String value,
           @Nullable
           java.lang.String... otherValues)

Adds for the particular name the meta value to the possible list of predefined ones. If none are defined a new list will be created.

Parameters:

name - The meta name of interest.

value - The meta value associated to it.

otherValues - Some other values to add if needed.

Returns:

The current document instance in order to allow method call chaining.

withMeta

T withMeta(@Nonnull
           java.lang.String name,
           @Nonnull
           java.lang.Iterable<java.lang.String> values)

Adds for the particular name the meta values to the possible list of predefined ones. If none are defined a new list will be created.

Parameters:

name - The meta name of interest.

values - The meta values to add or associate to it.

Returns:

The current document instance in order to allow method call chaining.

withMetas

T withMetas(@Nonnull
            java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> metas)

Adds the list of meta key-values to the possible list of predefined ones.

Parameters:

metas - The list of meta key-values.

Returns:

The current document instance in order to allow method call chaining.

withPart

T withPart(@Nonnull
           java.lang.String name,
           @Nonnull
           IDocumentPart documentPart)

Adds the document part to the list of predefined ones for the given name.

Parameters:

name - The name of interest.

documentPart - The part to associate to it.

Returns:

The current document instance in order to allow method call chaining.

withParts

T withParts(@Nonnull
            java.lang.String name,
            @Nonnull
            java.lang.Iterable<IDocumentPart> documentParts)

Adds the sequence of document parts to the list of predefined ones for the given name.

Parameters:

name - The name of interest.

documentParts - The different parts to associate to it.

Returns:

The current document instance in order to allow method call chaining.

withParts

T withParts(@Nonnull
            java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>> parts)

Adds the list of part associations to the current document.

Parameters:

parts - The list of part name/documents association.

Returns:

The current document instance in order to allow method call chaining.