com.exalead.papi.helper

Class Document

java.lang.Object

com.exalead.papi.helper.Document

All Implemented Interfaces:

IDocument, java.io.Serializable

Direct Known Subclasses:

JDBCDocument

public class Document
extends java.lang.Object
implements java.io.Serializable, IDocument

Class representing a document to be indexed. A document contains the following information

• uri: the document unique identifier
• stamp: the document stamp
• metas: a set of meta data associated with the document
• parts: a set of parts (raw binary content) associated with the document
• directives: a set of meta information used optionally as hints by the indexing chain to control the indexing of the document (for instance, force an internal identifier, force the slice on which the document should be pushed ...)

A document can be pushed using a push client (PushAPI).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.DidAndSlice Internal identifier of a document in the CloudView system.

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyValuesContainer<java.lang.String,java.lang.String>	directives Document directives.
protected static java.lang.String	FORCED_DID_NAME
protected static java.lang.String	FORCED_SLICE_NAME
protected MetaContainer	metaContainer Document meta data.
protected PartContainer	partContainer Document parts.
protected java.lang.String	stamp Document stamp.
protected java.lang.String	uri Unique identifier of the document.

Constructor Summary

Constructors

Constructor and Description
Document(java.lang.String uri) Document constructor specifying the document unique identifier
Document(java.lang.String uri, java.lang.String stamp) Document constructor specifying the document unique identifier and the document stamp.
Document(java.lang.String uri, java.lang.String stamp, PartContainer partContainer, MetaContainer metaContainer) Document constructor specifying the whole document content.

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

uri

protected java.lang.String uri

Unique identifier of the document.

stamp

protected java.lang.String stamp

Document stamp.

partContainer

protected PartContainer partContainer

Document parts.

metaContainer

protected MetaContainer metaContainer

Document meta data.

directives

protected KeyValuesContainer<java.lang.String,java.lang.String> directives

Document directives.

FORCED_DID_NAME

protected static final java.lang.String FORCED_DID_NAME

See Also:

Constant Field Values

FORCED_SLICE_NAME

protected static final java.lang.String FORCED_SLICE_NAME

See Also:

Constant Field Values

Constructor Detail

Document

public Document(java.lang.String uri,
                java.lang.String stamp,
                PartContainer partContainer,
                MetaContainer metaContainer)
         throws PushAPIException

Document constructor specifying the whole document content.

Parameters:

uri - the unique identifier of the document.

stamp - the stamp of the document.

partContainer - the container of parts of the document - cannot be null.

metaContainer - the container of meta data of the document - cannot be null.

Throws:

PushAPIException - if one of uri, stamp, partContainer, or metaContainer is null.

Document

public Document(java.lang.String uri,
                java.lang.String stamp)

Document constructor specifying the document unique identifier and the document stamp.

Parameters:

uri - the unique identifier of the document.

stamp - the stamp of the document.

Document

public Document(java.lang.String uri)

Document constructor specifying the document unique identifier

Parameters:

uri - the unique identifier of the document.

Method Detail

addMeta

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

Specified by:

addMeta in interface IDocument

Parameters:

meta - The meta that should be added.

addMeta

public 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

Specified by:

addMeta in interface IDocument

Parameters:

name - The name of the meta that should be added

value - The value of the meta that should be added

deleteMeta

public void deleteMeta(java.lang.String name)

Delete all the Meta that match the given meta data name.

Specified by:

deleteMeta in interface IDocument

Parameters:

name - the meta data name to delete.

addPart

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

Specified by:

addPart in interface IDocument

Parameters:

part - Data to add.

Throws:

MultiplePartException

deletePart

public void deletePart(java.lang.String name)

Delete all the Part that match the given part name.

Specified by:

deletePart in interface IDocument

Parameters:

name - the part name to delete.

getStamp

public 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).

Specified by:

getStamp in interface IDocument

Returns:

the document stamp.

setStamp

public void setStamp(java.lang.String stamp)

Sets the document stamp.

Specified by:

setStamp in interface IDocument

Parameters:

stamp - the document stamp

getUri

public 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.).

Specified by:

getUri in interface IDocument

Returns:

the unique identifier of the document.

setUri

public void setUri(java.lang.String uri)

Sets the unique identifier of the document.

Specified by:

setUri in interface IDocument

Parameters:

uri - the unique document identifier

getForcedDid

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

Specified by:

getForcedDid in interface IDocument

Returns:

the value of the directive forcedDid. Return null if the directive has not been set.

setForcedDid

public void setForcedDid(java.lang.String value)

Sets the value of the forcedDid directive.

Specified by:

setForcedDid in interface IDocument

Parameters:

value - the internal document identifier to be used (32 bits integer)

getForcedSlice

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

Specified by:

getForcedSlice in interface IDocument

Returns:

the value of the directive forcedSlice. Return null if the directive has not been set.

setForcedSlice

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

Specified by:

setForcedSlice in interface IDocument

Parameters:

value - the slice number to be used (32 bits integer).

addCustomDirective

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

Specified by:

addCustomDirective in interface IDocument

Parameters:

key - the directive name.

value - the directive value.

setCustomDirective

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

Specified by:

setCustomDirective in interface IDocument

Parameters:

key - the directive name.

value - the directive value.

setCustomDirectives

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

Specified by:

setCustomDirectives in interface IDocument

Parameters:

key - the directive name.

values - the directive values.

getPartContainer

public PartContainer getPartContainer()

Gets the part container associated with this document.

Specified by:

getPartContainer in interface IDocument

Returns:

the part container associated with this document.

getMetaContainer

public MetaContainer getMetaContainer()

Gets the meta container associated with this document.

Specified by:

getMetaContainer in interface IDocument

Returns:

the meta container associated with this document.

getDirectiveContainer

public KeyValuesContainer<java.lang.String,java.lang.String> getDirectiveContainer()

Gets the directives container associated with this document.

Specified by:

getDirectiveContainer in interface IDocument

Returns:

the directives container associated with this document.

deleteMetas

public void deleteMetas()

Description copied from interface: IDocument

Delete all metas of this document.

Specified by:

deleteMetas in interface IDocument

deleteParts

public void deleteParts()

Description copied from interface: IDocument

Delete all the part of this document.

Specified by:

deleteParts in interface IDocument

deleteCustomDirectives

public void deleteCustomDirectives()

Description copied from interface: IDocument

Delete all custom directives of this document.

Specified by:

deleteCustomDirectives in interface IDocument

toString

public java.lang.String toString()

Simple document serializer.

Specified by:

toString in interface IDocument

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the document.