com.exalead.mercury.mami.convert.v10

Class ConvertConfig

java.lang.Object

exa.bee.config.Versioned

com.exalead.mercury.mami.convert.v10.ConvertConfig

All Implemented Interfaces:

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

public class ConvertConfig
extends exa.bee.config.Versioned
implements com.exalead.util.Checkable, java.io.Serializable

Global configuration for document conversion.
This configuration impacts how binary files
(e.g. images, office documents, ...) are handled during:
- Indexing, Analysis, when using the ConvertDocumentProcessor
- Document Preview.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ConvertDocumentInputSettings	convertDocumentInputSettings
ConvertDocumentOutputSettings	convertDocumentOutputSettings
ConvertDocumentProcessingSettings	convertDocumentProcessingSettings
ConvertInternalSettings	convertInternalSettings
ConvertJavaPluginsSettings	convertJavaPluginsSettings

Fields inherited from class exa.bee.config.Versioned

version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ConvertConfig.
static ConvertConfig	fromString(java.lang.String s) String representation of this ConvertConfig.
ConvertDocumentInputSettings	getConvertDocumentInputSettings()
ConvertDocumentOutputSettings	getConvertDocumentOutputSettings()
ConvertDocumentProcessingSettings	getConvertDocumentProcessingSettings()
ConvertInternalSettings	getConvertInternalSettings()
ConvertJavaPluginsSettings	getConvertJavaPluginsSettings()
ConvertConfig	makeCopy() Creates and returns a deep copy of this ConvertConfig.
static ConvertConfig	readFrom(java.io.InputStream is) Read this ConvertConfig from an XML fragment.
void	setConvertDocumentInputSettings(ConvertDocumentInputSettings convertDocumentInputSettings)
void	setConvertDocumentOutputSettings(ConvertDocumentOutputSettings convertDocumentOutputSettings)
void	setConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings convertDocumentProcessingSettings)
void	setConvertInternalSettings(ConvertInternalSettings convertInternalSettings)
void	setConvertJavaPluginsSettings(ConvertJavaPluginsSettings convertJavaPluginsSettings)
java.lang.String	toString() String representation of this ConvertConfig.
ConvertConfig	withConvertDocumentInputSettings(ConvertDocumentInputSettings convertDocumentInputSettings)
ConvertConfig	withConvertDocumentOutputSettings(ConvertDocumentOutputSettings convertDocumentOutputSettings)
ConvertConfig	withConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings convertDocumentProcessingSettings)
ConvertConfig	withConvertInternalSettings(ConvertInternalSettings convertInternalSettings)
ConvertConfig	withConvertJavaPluginsSettings(ConvertJavaPluginsSettings convertJavaPluginsSettings)
ConvertConfig	withVersion(long version)
ConvertConfig	withVersion(java.lang.Long version)
void	writeTo(java.io.OutputStream os) Write this ConvertConfig as an XML fragment

Methods inherited from class exa.bee.config.Versioned

clone, getVersion, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

convertDocumentInputSettings

public ConvertDocumentInputSettings convertDocumentInputSettings

convertDocumentOutputSettings

public ConvertDocumentOutputSettings convertDocumentOutputSettings

convertDocumentProcessingSettings

public ConvertDocumentProcessingSettings convertDocumentProcessingSettings

convertInternalSettings

public ConvertInternalSettings convertInternalSettings

convertJavaPluginsSettings

public ConvertJavaPluginsSettings convertJavaPluginsSettings

Constructor Detail

ConvertConfig

public ConvertConfig()

ConvertConfig

public ConvertConfig(ConvertConfig o)

Copy constructor

Method Detail

withVersion

public ConvertConfig withVersion(long version)

Overrides:

withVersion in class exa.bee.config.Versioned

withVersion

public ConvertConfig withVersion(java.lang.Long version)

Overrides:

withVersion in class exa.bee.config.Versioned

setConvertDocumentInputSettings

public void setConvertDocumentInputSettings(ConvertDocumentInputSettings convertDocumentInputSettings)

getConvertDocumentInputSettings

public ConvertDocumentInputSettings getConvertDocumentInputSettings()

withConvertDocumentInputSettings

public ConvertConfig withConvertDocumentInputSettings(ConvertDocumentInputSettings convertDocumentInputSettings)

setConvertDocumentOutputSettings

public void setConvertDocumentOutputSettings(ConvertDocumentOutputSettings convertDocumentOutputSettings)

getConvertDocumentOutputSettings

public ConvertDocumentOutputSettings getConvertDocumentOutputSettings()

withConvertDocumentOutputSettings

public ConvertConfig withConvertDocumentOutputSettings(ConvertDocumentOutputSettings convertDocumentOutputSettings)

setConvertDocumentProcessingSettings

public void setConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings convertDocumentProcessingSettings)

getConvertDocumentProcessingSettings

public ConvertDocumentProcessingSettings getConvertDocumentProcessingSettings()

withConvertDocumentProcessingSettings

public ConvertConfig withConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings convertDocumentProcessingSettings)

setConvertInternalSettings

public void setConvertInternalSettings(ConvertInternalSettings convertInternalSettings)

getConvertInternalSettings

public ConvertInternalSettings getConvertInternalSettings()

withConvertInternalSettings

public ConvertConfig withConvertInternalSettings(ConvertInternalSettings convertInternalSettings)

setConvertJavaPluginsSettings

public void setConvertJavaPluginsSettings(ConvertJavaPluginsSettings convertJavaPluginsSettings)

getConvertJavaPluginsSettings

public ConvertJavaPluginsSettings getConvertJavaPluginsSettings()

withConvertJavaPluginsSettings

public ConvertConfig withConvertJavaPluginsSettings(ConvertJavaPluginsSettings convertJavaPluginsSettings)

makeCopy

public ConvertConfig makeCopy()

Creates and returns a deep copy of this ConvertConfig.

Overrides:

makeCopy in class exa.bee.config.Versioned

readFrom

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

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

Overrides:

writeTo in class exa.bee.config.Versioned

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConvertConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConvertConfig.

Overrides:

toString in class exa.bee.config.Versioned

check

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

Checks this ConvertConfig.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class exa.bee.config.Versioned

Throws:

com.exalead.util.TypedException