com.exalead.pdoc.papi

Class PAPIProcessableDocument

java.lang.Object

com.exalead.pdoc.papi.PAPIProcessableDocument

All Implemented Interfaces:

ProcessableDocument

public class PAPIProcessableDocument
extends java.lang.Object
implements ProcessableDocument

Wrap a FleaProcessableDocument + its did/slice/stamp

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.pdoc.ProcessableDocument

ProcessableDocument.Operation

Constructor Summary

Constructors

Constructor and Description
PAPIProcessableDocument(FleaProcessableDocument pdoc) Build a new PAPIProcessableDocument
PAPIProcessableDocument(FleaProcessableDocument pdoc, int did, int slice) Build a new PAPIProcessableDocument with its did/slice infos

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.
void	clearCustomDirectives()
void	clearMetas()
void	clearParts()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getCustomDirectives() Document-level directives
int	getDid()
long	getEstimatedInputSize()
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.
int	getSlice()
java.lang.String	getSource() Get the source that generated this document
java.lang.String	getStamp()
FleaProcessableDocument	getUnderlyingFleaProcessableDocument() Get the underlying FleaProcessableDocument
java.lang.String	getURI() Get the URI of the Document.
boolean	isUpdate()
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	setDid(int did)
void	setProcessingFlag(ProcessableDocument.Operation op) Set the global processing flag of the document.
void	setSlice(int slice)
void	setStamp(java.lang.String stamp)
void	setUpdate(boolean update)
void	setURI(java.lang.String uri) Set the URI of the underlying FleaProcessableDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

PAPIProcessableDocument

public PAPIProcessableDocument(FleaProcessableDocument pdoc)

Build a new PAPIProcessableDocument

PAPIProcessableDocument

public PAPIProcessableDocument(FleaProcessableDocument pdoc,
                               int did,
                               int slice)

Build a new PAPIProcessableDocument with its did/slice infos

Method Detail

getUnderlyingFleaProcessableDocument

public FleaProcessableDocument getUnderlyingFleaProcessableDocument()

Get the underlying FleaProcessableDocument

setURI

public void setURI(java.lang.String uri)

Set the URI of the underlying FleaProcessableDocument

isUpdate

public boolean isUpdate()

setUpdate

public void setUpdate(boolean update)

getSlice

public int getSlice()

setSlice

public void setSlice(int slice)

getDid

public int getDid()

setDid

public void setDid(int did)

getStamp

public java.lang.String getStamp()

setStamp

public void setStamp(java.lang.String stamp)

getEstimatedInputSize

public long getEstimatedInputSize()

Returns:

sum of name length and value length of parts and metas in bytes

addMeta

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

Description copied from interface: ProcessableDocument

Add a new meta for the document.

Specified by:

addMeta in interface ProcessableDocument

getMetaValues

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

Description copied from interface: ProcessableDocument

Get the values for the metas with a given name.

Specified by:

getMetaValues in interface ProcessableDocument

Returns:

The list of values for this meta.

getFirstMetaValue

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

Description copied from interface: ProcessableDocument

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

Specified by:

getFirstMetaValue in interface ProcessableDocument

Returns:

null if this meta does not exist

getMetas

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

Description copied from interface: ProcessableDocument

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.

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Description copied from interface: ProcessableDocument

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

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Description copied from interface: ProcessableDocument

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

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Description copied from interface: ProcessableDocument

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

Specified by:

getMetas in interface ProcessableDocument

getParts

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

Description copied from interface: ProcessableDocument

Get the Binary Parts associated to the document.

Specified by:

getParts in interface ProcessableDocument

Returns:

getSource

public java.lang.String getSource()

Description copied from interface: ProcessableDocument

Get the source that generated this document

Specified by:

getSource in interface ProcessableDocument

getURI

public java.lang.String getURI()

Description copied from interface: ProcessableDocument

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.

Specified by:

getURI in interface ProcessableDocument

removeMetas

public void removeMetas(java.lang.String name)

Description copied from interface: ProcessableDocument

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

Specified by:

removeMetas in interface ProcessableDocument

removeMetas

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

Description copied from interface: ProcessableDocument

Remove all metas with one of the given name.

Specified by:

removeMetas in interface ProcessableDocument

removeMetas

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

Description copied from interface: ProcessableDocument

Remove all metas with one of the given name.

Specified by:

removeMetas in interface ProcessableDocument

removePart

public void removePart(java.lang.String name)

Description copied from interface: ProcessableDocument

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

Specified by:

removePart in interface ProcessableDocument

clearMetas

public void clearMetas()

clearParts

public void clearParts()

nbParts

public int nbParts()

Description copied from interface: ProcessableDocument

Get the number of parts

Specified by:

nbParts in interface ProcessableDocument

setProcessingFlag

public void setProcessingFlag(ProcessableDocument.Operation op)

Description copied from interface: ProcessableDocument

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

Specified by:

setProcessingFlag in interface ProcessableDocument

getProcessingFlag

public ProcessableDocument.Operation getProcessingFlag()

Description copied from interface: ProcessableDocument

Get the global processing flag of the document.

Specified by:

getProcessingFlag in interface ProcessableDocument

addPart

public void addPart(DocumentPart part)

Description copied from interface: ProcessableDocument

Add a part.

Specified by:

addPart in interface ProcessableDocument

addPart

public DocumentPart addPart(java.lang.String name)

Description copied from interface: ProcessableDocument

Create a new part inside document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part's name

addPart

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

Description copied from interface: ProcessableDocument

Create a new part inside document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part's name

content - the part's content

addPart

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

Description copied from interface: ProcessableDocument

Create a new part inside document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part name

getCustomDirectives

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

Description copied from interface: ProcessableDocument

Document-level directives

Specified by:

getCustomDirectives in interface ProcessableDocument

addCustomDirective

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

Description copied from interface: ProcessableDocument

Add a custom document-level directive

Specified by:

addCustomDirective in interface ProcessableDocument

removeCustomDirective

public void removeCustomDirective(java.lang.String key)

Description copied from interface: ProcessableDocument

Remove all custom document-level directives associated to this key

Specified by:

removeCustomDirective in interface ProcessableDocument

clearCustomDirectives

public void clearCustomDirectives()

getPart

public DocumentPart getPart(java.lang.String name)

Description copied from interface: ProcessableDocument

Get the Binary Part with the given name.

Specified by:

getPart in interface ProcessableDocument

Returns: