com.exalead.pdoc.kv

Class KVPDoc.KVPart

java.lang.Object

com.exalead.pdoc.kv.KVPDoc.KVPart

All Implemented Interfaces:

DocumentPart

Enclosing class:

KVPDoc

public static class KVPDoc.KVPart
extends java.lang.Object
implements DocumentPart

Constructor Summary

Constructors

Constructor and Description
KVPart()
KVPart(java.lang.String filename, java.lang.String mime, byte[] bytes)

Method Summary

Modifier and Type	Method and Description
void	addCustomDirective(java.lang.String key, java.lang.String value) Add a custom directive
java.lang.String	getComputedMime() This is only available after MIME detection: TODO: maybe only in AnalysisDocumentPart ??
java.nio.ByteBuffer	getContentAsByteBuffer() Create a new java.nio ByteBuffer containing the part's data
byte[]	getContentAsBytes() Get the part content as bytes.
java.io.InputStream	getContentAsInputStream() Get the part content as an input stream.
long	getContentLength() Get the part content length, in bytes.
java.util.List<Directive>	getCustomDirectives() Get the list of custom directives
java.lang.String	getEncoding() Get the encoding
java.lang.String	getEncodingHint() Get the encoding hint (encoding which may be the actual encoding)
java.lang.String	getFilename() Get the filename hint of the document part. If it can be known, it's always better to specify a filename, as it helps some processing elements understand the type of the part.
java.lang.String	getForcedMime() Get the forced MIME type (MIME type known to be valid, or enforced)
java.lang.String	getMimeHint() Get the MIME hint (MIME which may be the valid MIME)
java.lang.String	getName() Get the name of this part.
void	setContent(byte[] bytes) Set the content of this part, as a Java array
void	setContent(java.nio.ByteBuffer buffer) Set the content of this part, as a Java NIO ByteBuffer
void	setContent(java.io.InputStream stream, long streamSize) Set the content of this part, as a Java InputStream
void	setEncoding(java.lang.String encoding) Set the encoding
void	setEncodingHint(java.lang.String encodingHint) Set the encoding hint (encoding which may be the actual encoding)
void	setFilename(java.lang.String filename)
void	setForcedMime(java.lang.String forcedMime) Set the forced MIME type (MIME type known to be valid, or enforced)
void	setMimeHint(java.lang.String mimeHint) Set the MIME hint (MIME which may be the valid MIME)
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

KVPart

public KVPart()

KVPart

public KVPart(java.lang.String filename,
              java.lang.String mime,
              byte[] bytes)

Method Detail

getComputedMime

public java.lang.String getComputedMime()

Description copied from interface: DocumentPart

This is only available after MIME detection: TODO: maybe only in AnalysisDocumentPart ??

Specified by:

getComputedMime in interface DocumentPart

getContentAsByteBuffer

public java.nio.ByteBuffer getContentAsByteBuffer()

Description copied from interface: DocumentPart

Create a new java.nio ByteBuffer containing the part's data

Specified by:

getContentAsByteBuffer in interface DocumentPart

getContentAsBytes

public byte[] getContentAsBytes()

Description copied from interface: DocumentPart

Get the part content as bytes. This method should be used with caution, because of performance considerations

Specified by:

getContentAsBytes in interface DocumentPart

getContentAsInputStream

public java.io.InputStream getContentAsInputStream()

Description copied from interface: DocumentPart

Get the part content as an input stream. Warning This does not work in the PAPI if the part was created with a content stream.

Specified by:

getContentAsInputStream in interface DocumentPart

Returns:

An input stream to read the part bytes.

getCustomDirectives

public java.util.List<Directive> getCustomDirectives()

Description copied from interface: DocumentPart

Get the list of custom directives

Specified by:

getCustomDirectives in interface DocumentPart

Returns:

the list of custom directives

addCustomDirective

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

Description copied from interface: DocumentPart

Add a custom directive

Specified by:

addCustomDirective in interface DocumentPart

Parameters:

key - The custom directive name

value - The custom directive value

getEncoding

public java.lang.String getEncoding()

Description copied from interface: DocumentPart

Get the encoding

Specified by:

getEncoding in interface DocumentPart

Returns:

the encoding

getFilename

public java.lang.String getFilename()

Description copied from interface: DocumentPart

Get the filename hint of the document part.
If it can be known, it's always better to specify a filename, as it helps some processing elements understand the type of the part.

Specified by:

getFilename in interface DocumentPart

getForcedMime

public java.lang.String getForcedMime()

Description copied from interface: DocumentPart

Get the forced MIME type (MIME type known to be valid, or enforced)

Specified by:

getForcedMime in interface DocumentPart

Returns:

the forced MIME type

getMimeHint

public java.lang.String getMimeHint()

Description copied from interface: DocumentPart

Get the MIME hint (MIME which may be the valid MIME)

Specified by:

getMimeHint in interface DocumentPart

Returns:

the MIME hint

getEncodingHint

public java.lang.String getEncodingHint()

Description copied from interface: DocumentPart

Get the encoding hint (encoding which may be the actual encoding)

Specified by:

getEncodingHint in interface DocumentPart

Returns:

the encodin hint

getName

public java.lang.String getName()

Description copied from interface: DocumentPart

Get the name of this part. The name is only used for identification purposes

Specified by:

getName in interface DocumentPart

setContent

public void setContent(byte[] bytes)

Description copied from interface: DocumentPart

Set the content of this part, as a Java array

Specified by:

setContent in interface DocumentPart

setContent

public void setContent(java.nio.ByteBuffer buffer)

Description copied from interface: DocumentPart

Set the content of this part, as a Java NIO ByteBuffer

Specified by:

setContent in interface DocumentPart

getContentLength

public long getContentLength()

Description copied from interface: DocumentPart

Get the part content length, in bytes.

Specified by:

getContentLength in interface DocumentPart

Returns:

The part length.

setContent

public void setContent(java.io.InputStream stream,
                       long streamSize)

Description copied from interface: DocumentPart

Set the content of this part, as a Java InputStream

Specified by:

setContent in interface DocumentPart

setEncoding

public void setEncoding(java.lang.String encoding)

Description copied from interface: DocumentPart

Set the encoding

Specified by:

setEncoding in interface DocumentPart

Parameters:

encoding - the encoding

setFilename

public void setFilename(java.lang.String filename)

Specified by:

setFilename in interface DocumentPart

See Also:

getFilename

setForcedMime

public void setForcedMime(java.lang.String forcedMime)

Description copied from interface: DocumentPart

Set the forced MIME type (MIME type known to be valid, or enforced)

Specified by:

setForcedMime in interface DocumentPart

Parameters:

forcedMime - the forced MIME type

setMimeHint

public void setMimeHint(java.lang.String mimeHint)

Description copied from interface: DocumentPart

Set the MIME hint (MIME which may be the valid MIME)

Specified by:

setMimeHint in interface DocumentPart

Parameters:

mimeHint - the MIME hint

setEncodingHint

public void setEncodingHint(java.lang.String encodingHint)

Description copied from interface: DocumentPart

Set the encoding hint (encoding which may be the actual encoding)

Specified by:

setEncodingHint in interface DocumentPart

Parameters:

encodingHint - the encoding hint

setName

public void setName(java.lang.String name)

Specified by:

setName in interface DocumentPart

See Also:

getName