com.exalead.mercury.mami.convert.v10

Class ConvertDocumentInputSettings

java.lang.Object

com.exalead.mercury.mami.convert.v10.ConvertDocumentInputSettings

All Implemented Interfaces:

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

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

Configuration of convert inputs handling.
Parameters to accept inputs for conversion.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_SIZE_FOR_TEXT_DOCUMENTS_K_B
static int	DEFAULT_MAX_SIZE_K_B
static int	DEFAULT_MIN_SIZE_K_B
int	maxSizeForTextDocumentsKB
int	maxSizeKB
int	minSizeKB

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConvertDocumentInputSettings.
static ConvertDocumentInputSettings	fromString(java.lang.String s) String representation of this ConvertDocumentInputSettings.
int	getMaxSizeForTextDocumentsKB() Default maximum size in kilobytes for textual (html, xml, text) documents to be converted.
int	getMaxSizeKB() Default maximumm size in kilobytes for a document to be converted. The default is -1 which means use program defaults (250MB). Note: This setting defines the process default value, which can be overridden for each conversion command.
int	getMinSizeKB() Default minimum size in kilobytes for a document to be converted. The default is -1 which means no limit. Note: This setting defines the process default value, which can be overridden for each conversion command.
ConvertDocumentInputSettings	makeCopy() Creates and returns a deep copy of this ConvertDocumentInputSettings.
static ConvertDocumentInputSettings	readFrom(java.io.InputStream is) Read this ConvertDocumentInputSettings from an XML fragment.
void	setMaxSizeForTextDocumentsKB(int maxSizeForTextDocumentsKB) Default maximum size in kilobytes for textual (html, xml, text) documents to be converted.
void	setMaxSizeKB(int maxSizeKB) Default maximumm size in kilobytes for a document to be converted. The default is -1 which means use program defaults (250MB). Note: This setting defines the process default value, which can be overridden for each conversion command.
void	setMinSizeKB(int minSizeKB) Default minimum size in kilobytes for a document to be converted. 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 ConvertDocumentInputSettings.
ConvertDocumentInputSettings	withMaxSizeForTextDocumentsKB(int maxSizeForTextDocumentsKB)
ConvertDocumentInputSettings	withMaxSizeForTextDocumentsKB(java.lang.Integer maxSizeForTextDocumentsKB)
ConvertDocumentInputSettings	withMaxSizeKB(int maxSizeKB)
ConvertDocumentInputSettings	withMaxSizeKB(java.lang.Integer maxSizeKB)
ConvertDocumentInputSettings	withMinSizeKB(int minSizeKB)
ConvertDocumentInputSettings	withMinSizeKB(java.lang.Integer minSizeKB)
void	writeTo(java.io.OutputStream os) Write this ConvertDocumentInputSettings as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

minSizeKB

public int minSizeKB

DEFAULT_MIN_SIZE_K_B

public static final int DEFAULT_MIN_SIZE_K_B

See Also:

Constant Field Values

maxSizeKB

public int maxSizeKB

DEFAULT_MAX_SIZE_K_B

public static final int DEFAULT_MAX_SIZE_K_B

See Also:

Constant Field Values

maxSizeForTextDocumentsKB

public int maxSizeForTextDocumentsKB

DEFAULT_MAX_SIZE_FOR_TEXT_DOCUMENTS_K_B

public static final int DEFAULT_MAX_SIZE_FOR_TEXT_DOCUMENTS_K_B

See Also:

Constant Field Values

Constructor Detail

ConvertDocumentInputSettings

public ConvertDocumentInputSettings()

ConvertDocumentInputSettings

public ConvertDocumentInputSettings(ConvertDocumentInputSettings o)

Copy constructor

Method Detail

setMinSizeKB

public void setMinSizeKB(int minSizeKB)

Default minimum size in kilobytes for a document to be converted.
The default is -1 which means no limit.
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMinSizeKB

public int getMinSizeKB()

Default minimum size in kilobytes for a document to be converted.
The default is -1 which means no limit.
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMinSizeKB

public ConvertDocumentInputSettings withMinSizeKB(int minSizeKB)

withMinSizeKB

public ConvertDocumentInputSettings withMinSizeKB(java.lang.Integer minSizeKB)

setMaxSizeKB

public void setMaxSizeKB(int maxSizeKB)

Default maximumm size in kilobytes for a document to be converted.
The default is -1 which means use program defaults (250MB).
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMaxSizeKB

public int getMaxSizeKB()

Default maximumm size in kilobytes for a document to be converted.
The default is -1 which means use program defaults (250MB).
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMaxSizeKB

public ConvertDocumentInputSettings withMaxSizeKB(int maxSizeKB)

withMaxSizeKB

public ConvertDocumentInputSettings withMaxSizeKB(java.lang.Integer maxSizeKB)

setMaxSizeForTextDocumentsKB

public void setMaxSizeForTextDocumentsKB(int maxSizeForTextDocumentsKB)

Default maximum size in kilobytes for textual (html, xml, text) documents to be converted.
The default is -1 which means use program defaults (250MB).
Note: This setting defines the process default value, which can be overridden for each conversion command.

getMaxSizeForTextDocumentsKB

public int getMaxSizeForTextDocumentsKB()

Default maximum size in kilobytes for textual (html, xml, text) documents to be converted.
The default is -1 which means use program defaults (250MB).
Note: This setting defines the process default value, which can be overridden for each conversion command.

withMaxSizeForTextDocumentsKB

public ConvertDocumentInputSettings withMaxSizeForTextDocumentsKB(int maxSizeForTextDocumentsKB)

withMaxSizeForTextDocumentsKB

public ConvertDocumentInputSettings withMaxSizeForTextDocumentsKB(java.lang.Integer maxSizeForTextDocumentsKB)

makeCopy

public ConvertDocumentInputSettings makeCopy()

Creates and returns a deep copy of this ConvertDocumentInputSettings.

readFrom

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

Read this ConvertDocumentInputSettings 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 ConvertDocumentInputSettings as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConvertDocumentInputSettings.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConvertDocumentInputSettings.

Overrides:

toString in class java.lang.Object

check

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

Checks this ConvertDocumentInputSettings.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException