com.exalead.pdoc

Interface DocumentPart

All Known Subinterfaces:

RWDocumentPart

All Known Implementing Classes:

AnalysisDocumentPart, KVPDoc.KVPart

public interface DocumentPart

A binary part associated to a document. The content of this part can only be accessed in read-only mode.

Method Summary

Modifier and Type	Method and Description
void	addCustomDirective(java.lang.String name, 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<? extends 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 mimeHint) 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)

Method Detail

getName

java.lang.String getName()

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

setName

void setName(java.lang.String name)

See Also:

getName

getFilename

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.

setFilename

void setFilename(java.lang.String filename)

See Also:

getFilename

getEncoding

java.lang.String getEncoding()

Get the encoding

Returns:

the encoding

setEncoding

void setEncoding(java.lang.String encoding)

Set the encoding

Parameters:

encoding - the encoding

getForcedMime

java.lang.String getForcedMime()

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

Returns:

the forced MIME type

setForcedMime

void setForcedMime(java.lang.String forcedMime)

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

Parameters:

forcedMime - the forced MIME type

getMimeHint

java.lang.String getMimeHint()

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

Returns:

the MIME hint

setMimeHint

void setMimeHint(java.lang.String mimeHint)

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

Parameters:

mimeHint - the MIME hint

getEncodingHint

java.lang.String getEncodingHint()

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

Returns:

the encodin hint

setEncodingHint

void setEncodingHint(java.lang.String mimeHint)

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

Parameters:

mimeHint - the encoding hint

getCustomDirectives

java.util.List<? extends Directive> getCustomDirectives()

Get the list of custom directives

Returns:

the list of custom directives

addCustomDirective

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

Add a custom directive

Parameters:

name - The custom directive name

value - The custom directive value

getComputedMime

java.lang.String getComputedMime()

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

setContent

void setContent(byte[] bytes)

Set the content of this part, as a Java array

setContent

void setContent(java.nio.ByteBuffer buffer)

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

setContent

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

Set the content of this part, as a Java InputStream

getContentAsInputStream

java.io.InputStream getContentAsInputStream()

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.

Returns:

An input stream to read the part bytes.

getContentLength

long getContentLength()

Get the part content length, in bytes.

Returns:

The part length.

getContentAsBytes

byte[] getContentAsBytes()

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

getContentAsByteBuffer

java.nio.ByteBuffer getContentAsByteBuffer()

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