com.exalead.pdoc.plugins

Interface DocumentPartTransformer.Format

All Known Implementing Classes:

DocumentPartTransformer.Format.DefaultImpl

Enclosing interface:

DocumentPartTransformer

public static interface DocumentPartTransformer.Format

Format transformation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocumentPartTransformer.Format.DefaultImpl Default class implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME_GENERIC MIME type for any type (or unknown types).
static java.lang.String	MIME_HTML MIME type for html documents.
static java.lang.String	MIME_IMAGE_GENERIC MIME type for any type of image within the accepted list.
static java.lang.String	MIME_IMAGE_GIF MIME type for GIF image.
static java.lang.String	MIME_IMAGE_JPG MIME type for Jpeg image.
static java.lang.String	MIME_IMAGE_PNG MIME type for Png image.
static java.lang.String	MIME_NDOC MIME type for ndoc binary documents.
static java.lang.String	MIME_NDOC_XML MIME type for ndoc xml documents.
static java.lang.String	MIME_TEXT MIME type for text documents.

Method Summary

Modifier and Type	Method and Description
java.util.List<exa.bee.KeyValue>	getCustomArgs() Get Key/Value arguments to pass to the transformer.
DocumentPartTransformer.TransformKind	getKind() Get the transformation kind.
java.lang.String	getMime() Get the MIME format requested for the output (or for the main output part).
long	getTimeoutMs() Get the timeout, in milliseconds.
void	setCustomArgs(java.util.List<exa.bee.KeyValue> customArgs) Set Key/Value arguments to pass to the transformer.
void	setKind(DocumentPartTransformer.TransformKind kind) Set the transformation kind.
void	setMime(java.lang.String mime) Set the MIME format requested for the output (or for the main output part).
void	setTimeoutMs(long timeoutMs) Set the timeout, in milliseconds.

Field Detail

MIME_NDOC

static final java.lang.String MIME_NDOC

MIME type for ndoc binary documents.

See Also:

Constant Field Values

MIME_NDOC_XML

static final java.lang.String MIME_NDOC_XML

MIME type for ndoc xml documents.

See Also:

Constant Field Values

MIME_TEXT

static final java.lang.String MIME_TEXT

MIME type for text documents.

See Also:

Constant Field Values

MIME_HTML

static final java.lang.String MIME_HTML

MIME type for html documents.

See Also:

Constant Field Values

MIME_IMAGE_GIF

static final java.lang.String MIME_IMAGE_GIF

MIME type for GIF image.

See Also:

Constant Field Values

MIME_IMAGE_JPG

static final java.lang.String MIME_IMAGE_JPG

MIME type for Jpeg image.

See Also:

Constant Field Values

MIME_IMAGE_PNG

static final java.lang.String MIME_IMAGE_PNG

MIME type for Png image.

See Also:

Constant Field Values

MIME_IMAGE_GENERIC

static final java.lang.String MIME_IMAGE_GENERIC

MIME type for any type of image within the accepted list. The list includes png, jpeg and gif formats. This special type is valid for type argument only, not for return type argument.

See Also:

Constant Field Values

MIME_GENERIC

static final java.lang.String MIME_GENERIC

MIME type for any type (or unknown types). This special type is valid for type argument only, not for return type argument.

See Also:

Constant Field Values

Method Detail

getKind

DocumentPartTransformer.TransformKind getKind()

Get the transformation kind.

setKind

void setKind(DocumentPartTransformer.TransformKind kind)

Set the transformation kind.

getMime

java.lang.String getMime()

Get the MIME format requested for the output (or for the main output part).

setMime

void setMime(java.lang.String mime)

Set the MIME format requested for the output (or for the main output part).

getTimeoutMs

long getTimeoutMs()

Get the timeout, in milliseconds.

setTimeoutMs

void setTimeoutMs(long timeoutMs)

Set the timeout, in milliseconds.

getCustomArgs

java.util.List<exa.bee.KeyValue> getCustomArgs()

Get Key/Value arguments to pass to the transformer. Each key is filter-specific.

setCustomArgs

void setCustomArgs(java.util.List<exa.bee.KeyValue> customArgs)

Set Key/Value arguments to pass to the transformer. Each key is filter-specific.