com.exalead.mercury.mami.convert.v10

Class ConvertDocumentOutputSettings

java.lang.Object

com.exalead.mercury.mami.convert.v10.ConvertDocumentOutputSettings

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ConvertDocumentOutputSettings
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Configuration of convert outputs handling.
Parameters to tune conversion outputs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CONVERTED_PAGES_FOR_HTML_OUTPUT
static int	DEFAULT_MAX_CONVERTED_PAGES_FOR_XML_OUTPUT
static int	DEFAULT_MAX_SIZE_K_B
int	maxConvertedPagesForHtmlOutput
int	maxConvertedPagesForXmlOutput
int	maxSizeKB

Constructor Summary

Constructors

Constructor and Description
ConvertDocumentOutputSettings()
ConvertDocumentOutputSettings(ConvertDocumentOutputSettings o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConvertDocumentOutputSettings.
static ConvertDocumentOutputSettings	fromString(java.lang.String s) String representation of this ConvertDocumentOutputSettings.
int	getMaxConvertedPagesForHtmlOutput() Default maximum number of document pages to be converted into html. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command.
int	getMaxConvertedPagesForXmlOutput() Default maximum number of document pages to be converted into xml. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command.
int	getMaxSizeKB() Default maximum size in bytes for converted documents. The default is -1 which means no limit. Note: This setting defines the process default value, which can be overridden for each conversion command.
ConvertDocumentOutputSettings	makeCopy() Creates and returns a deep copy of this ConvertDocumentOutputSettings.
static ConvertDocumentOutputSettings	readFrom(java.io.InputStream is) Read this ConvertDocumentOutputSettings from an XML fragment.
void	setMaxConvertedPagesForHtmlOutput(int maxConvertedPagesForHtmlOutput) Default maximum number of document pages to be converted into html. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command.
void	setMaxConvertedPagesForXmlOutput(int maxConvertedPagesForXmlOutput) Default maximum number of document pages to be converted into xml. The default is -1 which means no limit. The definition of a page is tightly linked to document type: (pdf page, doc page, etc) Note: This setting defines the process default value, which can be overridden for each conversion command.
void	setMaxSizeKB(int maxSizeKB) Default maximum size in bytes for converted documents. The default is -1 which means no limit. Note: This setting defines the process default value, which can be overridden for each conversion command.
java.lang.String	toString() String representation of this ConvertDocumentOutputSettings.
ConvertDocumentOutputSettings	withMaxConvertedPagesForHtmlOutput(int maxConvertedPagesForHtmlOutput)
ConvertDocumentOutputSettings	withMaxConvertedPagesForHtmlOutput(java.lang.Integer maxConvertedPagesForHtmlOutput)
ConvertDocumentOutputSettings	withMaxConvertedPagesForXmlOutput(int maxConvertedPagesForXmlOutput)
ConvertDocumentOutputSettings	withMaxConvertedPagesForXmlOutput(java.lang.Integer maxConvertedPagesForXmlOutput)
ConvertDocumentOutputSettings	withMaxSizeKB(int maxSizeKB)
ConvertDocumentOutputSettings	withMaxSizeKB(java.lang.Integer maxSizeKB)
void	writeTo(java.io.OutputStream os) Write this ConvertDocumentOutputSettings as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

maxSizeKB

public int maxSizeKB

DEFAULT_MAX_SIZE_K_B

public static final int DEFAULT_MAX_SIZE_K_B

See Also:

Constant Field Values

maxConvertedPagesForXmlOutput

public int maxConvertedPagesForXmlOutput

DEFAULT_MAX_CONVERTED_PAGES_FOR_XML_OUTPUT

public static final int DEFAULT_MAX_CONVERTED_PAGES_FOR_XML_OUTPUT

See Also:

Constant Field Values

maxConvertedPagesForHtmlOutput

public int maxConvertedPagesForHtmlOutput

DEFAULT_MAX_CONVERTED_PAGES_FOR_HTML_OUTPUT

public static final int DEFAULT_MAX_CONVERTED_PAGES_FOR_HTML_OUTPUT

See Also:

Constant Field Values

Constructor Detail

ConvertDocumentOutputSettings

public ConvertDocumentOutputSettings()

ConvertDocumentOutputSettings

public ConvertDocumentOutputSettings(ConvertDocumentOutputSettings o)

Copy constructor

Method Detail

setMaxSizeKB

public void setMaxSizeKB(int maxSizeKB)

Default maximum size in bytes for converted documents.
The default is -1 which means no limit.
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMaxSizeKB

public int getMaxSizeKB()

Default maximum size in bytes for converted documents.
The default is -1 which means no limit.
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMaxSizeKB

public ConvertDocumentOutputSettings withMaxSizeKB(int maxSizeKB)

withMaxSizeKB

public ConvertDocumentOutputSettings withMaxSizeKB(java.lang.Integer maxSizeKB)

setMaxConvertedPagesForXmlOutput

public void setMaxConvertedPagesForXmlOutput(int maxConvertedPagesForXmlOutput)

Default maximum number of document pages to be converted into xml.
The default is -1 which means no limit.
The definition of a page is tightly linked to document type: (pdf page, doc page, etc)
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMaxConvertedPagesForXmlOutput

public int getMaxConvertedPagesForXmlOutput()

Default maximum number of document pages to be converted into xml.
The default is -1 which means no limit.
The definition of a page is tightly linked to document type: (pdf page, doc page, etc)
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMaxConvertedPagesForXmlOutput

public ConvertDocumentOutputSettings withMaxConvertedPagesForXmlOutput(int maxConvertedPagesForXmlOutput)

withMaxConvertedPagesForXmlOutput

public ConvertDocumentOutputSettings withMaxConvertedPagesForXmlOutput(java.lang.Integer maxConvertedPagesForXmlOutput)

setMaxConvertedPagesForHtmlOutput

public void setMaxConvertedPagesForHtmlOutput(int maxConvertedPagesForHtmlOutput)

Default maximum number of document pages to be converted into html.
The default is -1 which means no limit.
The definition of a page is tightly linked to document type: (pdf page, doc page, etc)
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMaxConvertedPagesForHtmlOutput

public int getMaxConvertedPagesForHtmlOutput()

Default maximum number of document pages to be converted into html.
The default is -1 which means no limit.
The definition of a page is tightly linked to document type: (pdf page, doc page, etc)
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMaxConvertedPagesForHtmlOutput

public ConvertDocumentOutputSettings withMaxConvertedPagesForHtmlOutput(int maxConvertedPagesForHtmlOutput)

withMaxConvertedPagesForHtmlOutput

public ConvertDocumentOutputSettings withMaxConvertedPagesForHtmlOutput(java.lang.Integer maxConvertedPagesForHtmlOutput)

makeCopy

public ConvertDocumentOutputSettings makeCopy()

Creates and returns a deep copy of this ConvertDocumentOutputSettings.

readFrom

public static ConvertDocumentOutputSettings readFrom(java.io.InputStream is)
                                              throws javax.xml.bind.JAXBException

Read this ConvertDocumentOutputSettings from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ConvertDocumentOutputSettings as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ConvertDocumentOutputSettings fromString(java.lang.String s)
                                                throws javax.xml.bind.JAXBException,
                                                       java.io.UnsupportedEncodingException

String representation of this ConvertDocumentOutputSettings.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConvertDocumentOutputSettings.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ConvertDocumentOutputSettings.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException