com.exalead.pdoc.flea

Class FleaProcessableDocument

java.lang.Object

com.exalead.pdoc.flea.FleaProcessableDocument

All Implemented Interfaces:

com.exalead.flea.FleaMessage, ProcessableDocument

public class FleaProcessableDocument
extends java.lang.Object
implements ProcessableDocument, com.exalead.flea.FleaMessage

A Processable Document backed by a FLEA-serializable Document. 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/interfaces inherited from interface com.exalead.pdoc.ProcessableDocument

ProcessableDocument.Operation

Constructor Summary

Constructors

Constructor and Description
FleaProcessableDocument()
FleaProcessableDocument(Document document)
FleaProcessableDocument(ProcessableDocument pdoc)
FleaProcessableDocument(java.lang.String source, java.lang.String uri)
FleaProcessableDocument(java.lang.String source, java.lang.String uri, java.lang.String stamp)

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 the document and returns it.
DocumentPart	addPart(java.lang.String name, byte[] content) Create a new part inside the document and returns it.
DocumentPart	addPart(java.lang.String name, java.nio.ByteBuffer content) Create a new part inside the document and returns it.
void	clearCustomDirectives()
void	clearMetas()
void	clearParts()
void	fleaDeserialize(byte[] data)
void	fleaDeserialize(com.exalead.flea.FleaInputStream fis)
byte[]	fleaSerialize()
void	fleaSerialize(com.exalead.flea.FleaOutputStream fos)
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.
static FleaProcessableDocument	getOrCreateFrom(ProcessableDocument pdoc)
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	getStamp()
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.
void	setSource(java.lang.String value)
void	setStamp(java.lang.String stamp)
void	setURI(java.lang.String value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FleaProcessableDocument

public FleaProcessableDocument()

FleaProcessableDocument

public FleaProcessableDocument(ProcessableDocument pdoc)

FleaProcessableDocument

public FleaProcessableDocument(Document document)

FleaProcessableDocument

public FleaProcessableDocument(java.lang.String source,
                               java.lang.String uri)

FleaProcessableDocument

public FleaProcessableDocument(java.lang.String source,
                               java.lang.String uri,
                               java.lang.String stamp)

Method Detail

getOrCreateFrom

public static FleaProcessableDocument getOrCreateFrom(ProcessableDocument pdoc)

getURI

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

Specified by:

getURI in interface ProcessableDocument

setURI

public void setURI(java.lang.String value)

getStamp

public java.lang.String getStamp()

setStamp

public void setStamp(java.lang.String stamp)

getSource

public java.lang.String getSource()

Get the source that generated this document

Specified by:

getSource in interface ProcessableDocument

setSource

public void setSource(java.lang.String value)

getMetas

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

Get all metas of this document.

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Get the metas of this document with a given name.

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Get the metas of this document with one of the given names.

Specified by:

getMetas in interface ProcessableDocument

getMetas

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

Specified by:

getMetas in interface ProcessableDocument

getMetaValues

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

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

removeMetas

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

Specified by:

removeMetas in interface ProcessableDocument

removeMetas

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

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)

Remove all metas with one of the given name.

Specified by:

removeMetas in interface ProcessableDocument

clearMetas

public void clearMetas()

addMeta

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

Add a new meta for the document.

Specified by:

addMeta in interface ProcessableDocument

getParts

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

Get the Binary Parts associated to the document.

Specified by:

getParts in interface ProcessableDocument

Returns:

getPart

public DocumentPart getPart(java.lang.String name)

Get the Binary Part with the given name.

Specified by:

getPart in interface ProcessableDocument

Returns:

nbParts

public int nbParts()

Get the number of parts

Specified by:

nbParts in interface ProcessableDocument

removePart

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

Specified by:

removePart in interface ProcessableDocument

clearParts

public void clearParts()

addPart

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

Add a part.

Specified by:

addPart in interface ProcessableDocument

Throws:

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

addPart

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

Create a new part inside the document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part's name

Throws:

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

addPart

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

Create a new part inside the document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part's name

content - the part's content

Throws:

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

addPart

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

Create a new part inside the document and returns it.

Specified by:

addPart in interface ProcessableDocument

Parameters:

name - the part name

Throws:

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

getCustomDirectives

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

Document-level directives

Specified by:

getCustomDirectives in interface ProcessableDocument

addCustomDirective

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

Add a custom document-level directive

Specified by:

addCustomDirective in interface ProcessableDocument

removeCustomDirective

public void removeCustomDirective(java.lang.String key)

Remove all custom document-level directives associated to this key

Specified by:

removeCustomDirective in interface ProcessableDocument

clearCustomDirectives

public void clearCustomDirectives()

setProcessingFlag

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

Specified by:

setProcessingFlag in interface ProcessableDocument

getProcessingFlag

public ProcessableDocument.Operation getProcessingFlag()

Get the global processing flag of the document.

Specified by:

getProcessingFlag in interface ProcessableDocument

fleaDeserialize

public void fleaDeserialize(com.exalead.flea.FleaInputStream fis)
                     throws java.io.IOException

Specified by:

fleaDeserialize in interface com.exalead.flea.FleaMessage

Throws:

java.io.IOException

fleaDeserialize

public void fleaDeserialize(byte[] data)
                     throws java.io.IOException

Specified by:

fleaDeserialize in interface com.exalead.flea.FleaMessage

Throws:

java.io.IOException

fleaSerialize

public void fleaSerialize(com.exalead.flea.FleaOutputStream fos)
                   throws java.io.IOException

Specified by:

fleaSerialize in interface com.exalead.flea.FleaMessage

Throws:

java.io.IOException

fleaSerialize

public byte[] fleaSerialize()
                     throws java.io.IOException

Specified by:

fleaSerialize in interface com.exalead.flea.FleaMessage

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object