IDocument (NETVIBES Exalead CloudView Clients SDK)

All Known Implementing Classes:

Document
```
public interface IDocument
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCustomDirective(java.lang.String key, java.lang.String value)` Adds a new custom directive.
`void`	`addMeta(Meta meta)` Adds a new meta data to this document.
`void`	`addMeta(java.lang.String name, java.lang.String value)` Add a new meta to this document.
`void`	`addPart(Part part)` Adds a new part to this document.
`void`	`deleteCustomDirectives()` Delete all custom directives of this document.
`void`	`deleteMeta(java.lang.String name)` Delete all the Meta that match the given meta data name.
`void`	`deleteMetas()` Delete all metas of this document.
`void`	`deletePart(java.lang.String name)` Delete all the Part that match the given part name.
`void`	`deleteParts()` Delete all the part of this document.
`KeyValuesContainer<java.lang.String,java.lang.String>`	`getDirectiveContainer()` Gets the directives container associated with this document.
`java.lang.String`	`getForcedDid()` Gets the value of the forcedDid directive.
`java.lang.String`	`getForcedSlice()` Gets the value of the forcedSlice directive.
`MetaContainer`	`getMetaContainer()` Gets the meta container associated with this document.
`PartContainer`	`getPartContainer()` Gets the part container associated with this document.
`java.lang.String`	`getStamp()` Gets the document stamp.
`java.lang.String`	`getUri()` Gets the document unique identifier.
`void`	`setCustomDirective(java.lang.String key, java.lang.String value)` Set the value of a custom directive.
`void`	`setCustomDirectives(java.lang.String key, java.util.List<java.lang.String> values)` Sets the set of values of a custom directive.
`void`	`setForcedDid(java.lang.String value)` Sets the value of the forcedDid directive.
`void`	`setForcedSlice(java.lang.String value)` Sets the value of the forcedSlice directive.
`void`	`setStamp(java.lang.String stamp)` Sets the document stamp.
`void`	`setUri(java.lang.String uri)` Sets the unique identifier of the document.
`java.lang.String`	`toString()` Simple document serializer.

- Method Detail
  - addMeta
```
void addMeta(Meta meta)
```
    Adds a new meta data to this document. A document can contain as many meta data as required. The meta names do not need to be unique.
    
    Parameters:
    
    meta - The meta that should be added.
  - addMeta
```
void addMeta(java.lang.String name,
             java.lang.String value)
```
    Add a new meta to this document. A document can contain as many meta data as required. The meta names do not need to be unique
    
    Parameters:
    
    name - The name of the meta that should be added
    
    value - The value of the meta that should be added
  - deleteMeta
```
void deleteMeta(java.lang.String name)
```
    Delete all the Meta that match the given meta data name.
    
    Parameters:
    
    name - the meta data name to delete.
  - deleteMetas
```
void deleteMetas()
```
    Delete all metas of this document.
  - addPart
```
void addPart(Part part)
```
    Adds a new part to this document. A document can contain as many parts as required. But all the parts are merged in the indexing chain into one unique document. Refer to your EXALEAD CloudView documentation for more information about the multipart support.
    
    Parameters:
    
    part - Data to add.
    
    Throws:
    
    MultiplePartException
  - deletePart
```
void deletePart(java.lang.String name)
```
    Delete all the Part that match the given part name.
    
    Parameters:
    
    name - the part name to delete.
  - deleteParts
```
void deleteParts()
```
    Delete all the part of this document.
  - getStamp
```
java.lang.String getStamp()
```
    Gets the document stamp. The Stamp is a fingerprint that represents the "state", or "version" of the document. Stamps can be stored within the Indexing System, and retrieved by the Connector to determine which version of the document has been indexed, and whether it should be updated ((See PushAPI for more information on how to retrieve indexed stamps).
    
    Returns:
    
    the document stamp.
  - setStamp
```
void setStamp(java.lang.String stamp)
```
    Sets the document stamp.
    
    Parameters:
    
    stamp - the document stamp
  - getUri
```
java.lang.String getUri()
```
    Gets the document unique identifier. The URI is the unique identifier of the document inside the Indexed Corpus of the Connector. When several Connectors are configured to target the same EXALEAD CloudView product, each Connector possesses its own URI virtual namespace. As a consequence, two documents from two distinct Connectors may be indexed with the same URI.
    The '/' is the separator character used to hierarchically organize the documents. The '/' also has the semantics of a 'new folder', so the paths 'a/b/doc' and 'a/b///doc' are NOT the same (See PushAPI for more information on how to use the hierarchical organization of indexed documents.).
    
    Returns:
    
    the unique identifier of the document.
  - setUri
```
void setUri(java.lang.String uri)
```
    Sets the unique identifier of the document.
    
    Parameters:
    
    uri - the unique document identifier
  - getForcedDid
```
java.lang.String getForcedDid()
```
    Gets the value of the forcedDid directive. The forcedDid directive can be used to specify the value of the internal document identifier used in the EXALEAD CloudView indexing chain. This might be useful for custom applications which do want to have the control over internal document identifiers allocations. Refer to EXALEAD CloudView document for more information on internal document identifiers allocation.
    
    Returns:
    
    the value of the directive forcedDid. Return null if the directive has not been set.
  - setForcedDid
```
void setForcedDid(java.lang.String value)
```
    Sets the value of the forcedDid directive.
    
    Parameters:
    
    value - the internal document identifier to be used (32 bits integer)
  - getForcedSlice
```
java.lang.String getForcedSlice()
```
    Gets the value of the forcedSlice directive. The forcedSlice directive can be used to specify the index slice where the document should reside. This might be useful for custom applications needing to control the physical location of indexed documents (for instance, having all the documents of a given user in the same index slice). See EXALEAD CloudView documentation for more information on index slices and slice numbers allocation.
    
    Returns:
    
    the value of the directive forcedSlice. Return null if the directive has not been set.
  - setForcedSlice
```
void setForcedSlice(java.lang.String value)
```
    Sets the value of the forcedSlice directive. The forcedSlice directive can be used to specify the index slice where the document should reside. This might be useful for custom applications needing to control the physical location of indexed documents (for instance, having all the documents of a given user in the same index slice). See EXALEAD CloudView documentation for more information on index slices and slice numbers allocation.
    
    Parameters:
    
    value - the slice number to be used (32 bits integer).
  - addCustomDirective
```
void addCustomDirective(java.lang.String key,
                        java.lang.String value)
```
    Adds a new custom directive. A directive can be multi-valued. To add several values for the same directive, use as many calls to this method as required.
    A custom directive can be used by a customized indexing chain to alter the default application behavior.
    
    Parameters:
    
    key - the directive name.
    
    value - the directive value.
  - setCustomDirective
```
void setCustomDirective(java.lang.String key,
                        java.lang.String value)
```
    Set the value of a custom directive. If the directive already exists, its values are first reset.
    A custom directive can be used by a customized indexing chain to alter the default application behavior.
    
    Parameters:
    
    key - the directive name.
    
    value - the directive value.
  - setCustomDirectives
```
void setCustomDirectives(java.lang.String key,
                         java.util.List<java.lang.String> values)
```
    Sets the set of values of a custom directive. If the directive already exists, its values are first reset.
    A custom directive can be used by a customized indexing chain to alter the default application behavior.
    
    Parameters:
    
    key - the directive name.
    
    values - the directive values.
  - deleteCustomDirectives
```
void deleteCustomDirectives()
```
    Delete all custom directives of this document.
  - getPartContainer
```
PartContainer getPartContainer()
```
    Gets the part container associated with this document.
    
    Returns:
    
    the part container associated with this document.
  - getMetaContainer
```
MetaContainer getMetaContainer()
```
    Gets the meta container associated with this document.
    
    Returns:
    
    the meta container associated with this document.
  - getDirectiveContainer
```
KeyValuesContainer<java.lang.String,java.lang.String> getDirectiveContainer()
```
    Gets the directives container associated with this document.
    
    Returns:
    
    the directives container associated with this document.
  - toString
```
java.lang.String toString()
```
    Simple document serializer.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of the document.

Interface IDocument

Method Summary

Method Detail

addMeta

addMeta

deleteMeta

deleteMetas

addPart

deletePart

deleteParts

getStamp

setStamp

getUri

setUri

getForcedDid

setForcedDid

getForcedSlice

setForcedSlice

addCustomDirective

setCustomDirective

setCustomDirectives

deleteCustomDirectives

getPartContainer

getMetaContainer

getDirectiveContainer

toString