com.exalead.pdoc

Interface ProcessableDocument

All Known Implementing Classes:

AnalysisProcessableDocument, FleaProcessableDocument, KVPDoc, PAPIProcessableDocument

public interface ProcessableDocument

A Processable Document (also referred as PDoc) is a representation of a CloudView document. The structure of this Document is very similar to the PAPI Document. This type of document is used in several places (including the analysis pipeline) and has several implementations. A document is made of

• Several binary parts
• Several multi-valued metas. Each meta is identified by a name and a value. Several metas can have the same name.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProcessableDocument.Operation

Method Summary

Modifier and Type	Method and Description
void	addCustomDirective(java.lang.String key, java.lang.String value) Add a custom document-level directive
void	addMeta(java.lang.String name, java.lang.String value) Add a new meta for the document.
void	addPart(DocumentPart part) Add a part.
DocumentPart	addPart(java.lang.String name) Create a new part inside document and returns it.
DocumentPart	addPart(java.lang.String name, byte[] content) Create a new part inside document and returns it.
DocumentPart	addPart(java.lang.String name, java.nio.ByteBuffer content) Create a new part inside document and returns it.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getCustomDirectives() Document-level directives
java.lang.String	getFirstMetaValue(java.lang.String name) Get the first value for the metas with a given name.
java.lang.Iterable<? extends Meta>	getMetas() Get all metas of this document.
java.lang.Iterable<? extends Meta>	getMetas(java.util.Collection<java.lang.String> names) Get the metas of this document with one of the given names.
java.lang.Iterable<? extends Meta>	getMetas(java.lang.String name) Get the metas of this document with a given name.
java.lang.Iterable<? extends Meta>	getMetas(java.lang.String[] names) Get the metas of this document with one of the given names.
java.lang.Iterable<java.lang.String>	getMetaValues(java.lang.String name) Get the values for the metas with a given name.
DocumentPart	getPart(java.lang.String name) Get the Binary Part with the given name.
java.lang.Iterable<? extends DocumentPart>	getParts() Get the Binary Parts associated to the document.
ProcessableDocument.Operation	getProcessingFlag() Get the global processing flag of the document.
java.lang.String	getSource() Get the source that generated this document
java.lang.String	getURI() Get the URI of the Document.
int	nbParts() Get the number of parts
void	removeCustomDirective(java.lang.String key) Remove all custom document-level directives associated to this key
void	removeMetas(java.util.Collection<java.lang.String> names) Remove all metas with one of the given name.
void	removeMetas(java.lang.String name) Remove all metas with a given name.
void	removeMetas(java.lang.String[] names) Remove all metas with one of the given name.
void	removePart(java.lang.String name) Remove the part from the document.
void	setProcessingFlag(ProcessableDocument.Operation op) Set the global processing flag of the document.

Method Detail

getURI

java.lang.String getURI()

Get the URI of the Document. The URI of the document is an internal identifier. It does not always represent a valid URL for fetching the document.

getSource

java.lang.String getSource()

Get the source that generated this document

getMetas

java.lang.Iterable<? extends Meta> getMetas()

Get all metas of this document. In the analysis pipeline, this matches the document chunks. In the analysis pipeline, this will only return the "text" metas. To access the advanced "separator" and "MOT" metas, use the ndoc API.

getMetas

java.lang.Iterable<? extends Meta> getMetas(java.lang.String name)

Get the metas of this document with a given name. In the analysis pipeline, this matches the document chunks

getMetas

java.lang.Iterable<? extends Meta> getMetas(java.lang.String[] names)

Get the metas of this document with one of the given names. In the analysis pipeline, this matches the document chunks

getMetas

java.lang.Iterable<? extends Meta> getMetas(java.util.Collection<java.lang.String> names)

Get the metas of this document with one of the given names. In the analysis pipeline, this matches the document chunks

getMetaValues

java.lang.Iterable<java.lang.String> getMetaValues(java.lang.String name)

Get the values for the metas with a given name.

Returns:

The list of values for this meta.

getFirstMetaValue

java.lang.String getFirstMetaValue(java.lang.String name)

Get the first value for the metas with a given name.

Returns:

null if this meta does not exist

removeMetas

void removeMetas(java.lang.String name)

Remove all metas with a given name. If you want to remove a single meta value, use getMetas() and mark the metas as deleted.

removeMetas

void removeMetas(java.lang.String[] names)

Remove all metas with one of the given name.

removeMetas

void removeMetas(java.util.Collection<java.lang.String> names)

Remove all metas with one of the given name.

addMeta

void addMeta(java.lang.String name,
             java.lang.String value)

Add a new meta for the document.

getParts

java.lang.Iterable<? extends DocumentPart> getParts()

Get the Binary Parts associated to the document.

Returns:

getPart

DocumentPart getPart(java.lang.String name)

Get the Binary Part with the given name.

Returns:

nbParts

int nbParts()

Get the number of parts

removePart

void removePart(java.lang.String name)

Remove the part from the document. Depending on the implementation, this can free the resources associated to the part.

addPart

void addPart(DocumentPart part)
      throws java.lang.IllegalArgumentException

Add a part.

Throws:

java.lang.IllegalArgumentException - a part with the same name already exists

addPart

DocumentPart addPart(java.lang.String name,
                     java.nio.ByteBuffer content)
              throws java.lang.IllegalArgumentException

Create a new part inside document and returns it.

Parameters:

name - the part name

Throws:

java.lang.IllegalArgumentException - a part with the same name already exists

addPart

DocumentPart addPart(java.lang.String name,
                     byte[] content)
              throws java.lang.IllegalArgumentException

Create a new part inside document and returns it.

Parameters:

name - the part's name

content - the part's content

Throws:

java.lang.IllegalArgumentException - a part with the same name already exists

addPart

DocumentPart addPart(java.lang.String name)
              throws java.lang.IllegalArgumentException

Create a new part inside document and returns it.

Parameters:

name - the part's name

content - the part's content

Throws:

java.lang.IllegalArgumentException - a part with the same name already exists

getCustomDirectives

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCustomDirectives()

Document-level directives

addCustomDirective

void addCustomDirective(java.lang.String key,
                        java.lang.String value)

Add a custom document-level directive

removeCustomDirective

void removeCustomDirective(java.lang.String key)

Remove all custom document-level directives associated to this key

setProcessingFlag

void setProcessingFlag(ProcessableDocument.Operation op)

Set the global processing flag of the document. This allows you to set how the next steps of the pipeline should handle this document.

getProcessingFlag

ProcessableDocument.Operation getProcessingFlag()

Get the global processing flag of the document.