IConsolidationDocument (EXALEAD CloudView Custom code SDK)

All Known Subinterfaces:

IAggregationDocument, IAggregationDocumentParameterized<T>, IMutableConsolidationDocument<T>, IMutableTransformationDocument, IMutableTransformationDocumentParameterized<T>, ITransformationDocument
```
public interface IConsolidationDocument
```
Represents and gives access to the default data encapsulated within a consolidation document, either for transformation or aggregation.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>`	`getAllDirectives()` Returns all the directives defined in this document
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>>`	`getAllMetas()` Returns all the meta defined in this document
`java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>>`	`getAllParts()` Returns all the parts defined in this document
`java.lang.String`	`getDirective(java.lang.String name)` Returns the first directive value for the given name.
`java.util.Set<java.lang.String>`	`getDirectiveNames()` Returns all the document directive names.
`java.util.List<java.lang.String>`	`getDirectives(java.lang.String name)` Returns all the directives for the given name.
`java.lang.String`	`getMeta(java.lang.String name)` Returns the first meta value for the given name.
`java.util.Set<java.lang.String>`	`getMetaNames()` Returns all the meta names.
`java.util.List<java.lang.String>`	`getMetas(java.lang.String name)` Returns all the meta values for the given name.
`java.util.List<java.lang.String>`	`getOriginalSources()` Returns the list of original sources for the given document.
`IDocumentPart`	`getPart(java.lang.String name)` Returns the first document part for the given name.
`java.util.Set<java.lang.String>`	`getPartNames()` Returns all the document part names.
`java.util.List<IDocumentPart>`	`getParts(java.lang.String name)` Returns the list of document parts for the given name.
`java.lang.String`	`getSource()` Returns the document original source that produced it.
`default java.lang.String`	`getStamp()` Returns the document stamp.
`java.lang.String`	`getType()` Returns the document representative type.
`java.util.List<java.lang.String>`	`getTypeInheritance()` Returns the type inheritance for the document.
`java.lang.String`	`getUri()` Return the document unique identifier.
`boolean`	`hasDirective(java.lang.String name)` Indicates if yes or no the directive name has an associated value within the document.
`boolean`	`hasMeta(java.lang.String name)` Indicates if yes or no the meta name has an associated value within the document.
`boolean`	`hasPart(java.lang.String name)` Indicates if yes or no the part name has an associated value within the document.
`boolean`	`isOfType(java.lang.String type)` Indicates if the type transmitted is among the list of the current document types.

- Method Detail
  - isOfType
```
boolean isOfType(@Nonnull
                 java.lang.String type)
```
    Indicates if the type transmitted is among the list of the current document types.
    
    Parameters:
    
    type - The type to test against.
    
    Returns:
    
    True if the given type is among the list of current types, false otherwise.
  - getAllDirectives
```
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> getAllDirectives()
```
    Returns all the directives defined in this document
    
    Returns:
    
    an non-null immutable Iterable over all the directives defined in this document
  - getAllMetas
```
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<java.lang.String>>> getAllMetas()
```
    Returns all the meta defined in this document
    
    Returns:
    
    an non-null immutable Iterable over all the metas defined in this document
  - getAllParts
```
java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.util.List<IDocumentPart>>> getAllParts()
```
    Returns all the parts defined in this document
    
    Returns:
    
    an non-null immutable Iterable over all the parts defined in this document
  - getDirectiveNames
```
java.util.Set<java.lang.String> getDirectiveNames()
```
    Returns all the document directive names.
    
    Returns:
    
    An immutable but possibly empty set of directive names
  - getDirective
```
java.lang.String getDirective(@Nonnull
                              java.lang.String name)
```
    Returns the first directive value for the given name.
    
    Parameters:
    
    name - The directive name to consider.
    
    Returns:
    
    The associated directive value or null if there is none.
  - getDirectives
```
java.util.List<java.lang.String> getDirectives(@Nonnull
                                               java.lang.String name)
```
    Returns all the directives for the given name.
    
    Parameters:
    
    name - The directive name to consider.
    
    Returns:
    
    A null or immutable but possibly empty list of directive values
  - getMetaNames
```
java.util.Set<java.lang.String> getMetaNames()
```
    Returns all the meta names.
    
    Returns:
    
    An immutable but possibly empty set of meta names
  - getMeta
```
java.lang.String getMeta(@Nonnull
                         java.lang.String name)
```
    Returns the first meta value for the given name.
    
    Parameters:
    
    name - The meta name to consider.
    
    Returns:
    
    The associated meta value or null if there is none.
  - getMetas
```
java.util.List<java.lang.String> getMetas(@Nonnull
                                          java.lang.String name)
```
    Returns all the meta values for the given name.
    
    Parameters:
    
    name - The meta value to consider.
    
    Returns:
    
    A null or immutable but possibly empty list of meta values
  - getOriginalSources
```
java.util.List<java.lang.String> getOriginalSources()
```
    Returns the list of original sources for the given document.
    
    Returns:
    
    A null or immutable but possibly empty list of original sources
  - getPartNames
```
java.util.Set<java.lang.String> getPartNames()
```
    Returns all the document part names.
    
    Returns:
    
    An immutable but possibly empty set of document part names
  - getPart
```
IDocumentPart getPart(@Nonnull
                      java.lang.String name)
```
    Returns the first document part for the given name.
    
    Parameters:
    
    name - The part name to consider.
    
    Returns:
    
    The associated part or null if there is none for the name.
  - getParts
```
java.util.List<IDocumentPart> getParts(@Nonnull
                                       java.lang.String name)
```
    Returns the list of document parts for the given name.
    
    Parameters:
    
    name - The part name to consider.
    
    Returns:
    
    A null or immutable but possibly empty list of document parts
  - getSource
```
java.lang.String getSource()
```
    Returns the document original source that produced it.
    
    Returns:
    
    A string or null if there is none defined.
  - getType
```
java.lang.String getType()
```
    Returns the document representative type.
    
    Returns:
    
    A non-null non-empty string representing the type.
  - getStamp
```
default java.lang.String getStamp()
```
    Returns the document stamp.
    
    Returns:
    
    A string or null if there is none defined.
  - getTypeInheritance
```
java.util.List<java.lang.String> getTypeInheritance()
```
    Returns the type inheritance for the document. The first one in the list is a descendant of the second one, the second one of the third one, so on and so forth. So types are ordered from the most specific to the most generic.
    
    Returns:
    
    A non-null non-empty immutable list of types. Indeed such method should return at least one type at all times. The one returned by getType().
  - getUri
```
java.lang.String getUri()
```
    Return the document unique identifier.
    
    Returns:
    
    A unique and non-null string defining the identifier.
  - hasDirective
```
boolean hasDirective(@Nonnull
                     java.lang.String name)
```
    Indicates if yes or no the directive name has an associated value within the document.
    
    Parameters:
    
    name - The directive name to consider.
    
    Returns:
    
    True if there is a value associated, false otherwise.
  - hasMeta
```
boolean hasMeta(@Nonnull
                java.lang.String name)
```
    Indicates if yes or no the meta name has an associated value within the document.
    
    Parameters:
    
    name - The meta name to consider.
    
    Returns:
    
    True if there is a value associated, false otherwise.
  - hasPart
```
boolean hasPart(@Nonnull
                java.lang.String name)
```
    Indicates if yes or no the part name has an associated value within the document.
    
    Parameters:
    
    name - The part name to consider.
    
    Returns:
    
    True if there is a value associated, false otherwise.

Interface IConsolidationDocument

Method Summary

Method Detail

isOfType

getAllDirectives

getAllMetas

getAllParts

getDirectiveNames

getDirective

getDirectives

getMetaNames

getMeta

getMetas

getOriginalSources

getPartNames

getPart

getParts

getSource

getType

getStamp

getTypeInheritance

getUri

hasDirective

hasMeta

hasPart