ConvertDocumentProcessingSettings (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.mercury.mami.convert.v10.ConvertDocumentProcessingSettings

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class ConvertDocumentProcessingSettings
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
```
Configuration of conversion settings in processing stage.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`allowDocumentChars`
`boolean`	`allowUnicode32`
`int`	`conversionGraceTimeoutS`
`int`	`conversionTimeoutPerMegabyteS`
`int`	`conversionTimeoutS`
`static boolean`	`DEFAULT_ALLOW_DOCUMENT_CHARS`
`static boolean`	`DEFAULT_ALLOW_UNICODE32`
`static int`	`DEFAULT_CONVERSION_GRACE_TIMEOUT_S`
`static int`	`DEFAULT_CONVERSION_TIMEOUT_PER_MEGABYTE_S`
`static int`	`DEFAULT_CONVERSION_TIMEOUT_S`
`static boolean`	`DEFAULT_ENABLE_IMAGE_RESIZING`
`static int`	`DEFAULT_EXCEL_DATE_FORMAT`
`static boolean`	`DEFAULT_INDEX_SINGLE_CONTAINERS_AS_ONE_DOCUMENT`
`static java.lang.String`	`DEFAULT_META_SEPARATOR`
`static int`	`DEFAULT_NETCAM_ASYNC_TIMEOUT_S`
`static int`	`DEFAULT_NETCAM_JOBS_PER_MINION`
`static int`	`DEFAULT_NETCAM_JOBS_RETRIES`
`static int`	`DEFAULT_NETCAM_MAX_JOBS_PER_MINION`
`static java.lang.String`	`DEFAULT_NETCAM_MODE`
`static int`	`DEFAULT_NETCAM_TIMEOUT_S`
`static int`	`DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DEPTH`
`static int`	`DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS`
`static int`	`DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS_TOTAL`
`boolean`	`enableImageResizing`
`int`	`excelDateFormat`
`java.lang.String`	`iFilterExtensions`
`boolean`	`indexSingleContainersAsOneDocument`
`java.lang.String`	`metaSeparator`
`int`	`netcamAsyncTimeoutS`
`int`	`netcamJobsPerMinion`
`int`	`netcamJobsRetries`
`int`	`netcamMaxJobsPerMinion`
`java.lang.String`	`netcamMode`
`java.lang.String`	`netcamProxy`
`int`	`netcamTimeoutS`
`int`	`singleContainersMaxRecursionDepth`
`int`	`singleContainersMaxRecursionDocuments`
`int`	`singleContainersMaxRecursionDocumentsTotal`
`java.lang.String`	`ttfDir`

Constructor Summary

Constructors
Constructor and Description

ConvertDocumentProcessingSettings()

ConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings o)
Copy constructor

Constructors
Constructor and Description
`ConvertDocumentProcessingSettings()`
`ConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this ConvertDocumentProcessingSettings.
`static ConvertDocumentProcessingSettings`	`fromString(java.lang.String s)` String representation of this ConvertDocumentProcessingSettings.
`int`	`getConversionGraceTimeoutS()` Global conversion grace timeout value in seconds.
`int`	`getConversionTimeoutPerMegabyteS()` Default timeout in seconds per megabyte for conversion. The conversion fails if it takes more than conversionTimeout * (size of document in Megabytes). The default is -1 which means "undefined". Note: This setting defines the process default value, which can be overridden for each conversion command.
`int`	`getConversionTimeoutS()` Default timeout in seconds for conversion. The default is -1 which means use program defaults (30 seconds). The conversion will be considered as failed if it takes longer than conversionTimeout. Note: This setting defines the process default value, which can be overridden for each conversion command.
`int`	`getExcelDateFormat()` Date default format to be used to interpret date cells in excel: 0:MM/DD/YYYY, 1:YYYY/MM/DD, 2:DD/MM/YYYY
`java.lang.String`	`getIFilterExtensions()` Comma-separated list of extensions to be processed through the Windows IFilter interface. Only available on Windows.
`java.lang.String`	`getMetaSeparator()` Character separator for meta-data namespaces. Note: MUST be a printable ascii character (Unicode codepoint must be higher than 32 and strictly lower than 128)
`int`	`getNetcamAsyncTimeoutS()` Netcam asynchronous command timeout in seconds. It should be set to a low value, as it is applied to async commands. The default is -1 which means use program defaults (10 seconds).
`int`	`getNetcamJobsPerMinion()` The number of Netcam jobs per minion thread. The default is -1 which means use program defaults (4).
`int`	`getNetcamJobsRetries()` Number of Netcam jobs retries if a remote exception occurs. The default is -1 which means use program defaults (4).
`int`	`getNetcamMaxJobsPerMinion()` Total number of jobs a minion can process before being recycled. The default is -1 which means use program defaults (128).
`java.lang.String`	`getNetcamMode()` Enables Netcam feature: disabled: Disables the feature enabled: Enables the feature optional: Enables the feature if available `enum("disabled", "enabled", "optional")`
`java.lang.String`	`getNetcamProxy()` Optional proxy, or null if undefined.
`int`	`getNetcamTimeoutS()` Default Netcam conversion timeout in seconds. The default is -1 which means use program defaults (30 seconds). Note: This setting defines the process default value, which can be overridden for each conversion command.
`int`	`getSingleContainersMaxRecursionDepth()` Default maximum recursion depth (for containers, or containers inside containers).
`int`	`getSingleContainersMaxRecursionDocuments()` Default maximum number of documents that can be indexed in a container. Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command.
`int`	`getSingleContainersMaxRecursionDocumentsTotal()` Default maximum number of documents that can be indexed in a container and all its children (for containers inside containers). Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command.
`java.lang.String`	`getTtfDir()` The font path (necessary on UNIX).
`boolean`	`isAllowDocumentChars()` Allows the use of Unicode private range characters (E0XX) for separators (keyword, sentence, paragraph separators, ...)
`boolean`	`isAllowUnicode32()` Allows the use of 32-bit unicode points when processing documents. This will allow to produce Unicode characters greater than 65536.
`boolean`	`isEnableImageResizing()` Enables commands related to images resizing (used in thumbnails computation).
`boolean`	`isIndexSingleContainersAsOneDocument()` Default indexing mode for containers (ZIP, TAR, PST, ...) to be converted as a single document, instead of indexing the directory only. By default, it indexes only the container directory. Note: This function has no impact on container commands (i.e., opening, listing, ...).
`ConvertDocumentProcessingSettings`	`makeCopy()` Creates and returns a deep copy of this ConvertDocumentProcessingSettings.
`static ConvertDocumentProcessingSettings`	`readFrom(java.io.InputStream is)` Read this ConvertDocumentProcessingSettings from an XML fragment.
`void`	`setAllowDocumentChars(boolean allowDocumentChars)` Allows the use of Unicode private range characters (E0XX) for separators (keyword, sentence, paragraph separators, ...)
`void`	`setAllowUnicode32(boolean allowUnicode32)` Allows the use of 32-bit unicode points when processing documents. This will allow to produce Unicode characters greater than 65536.
`void`	`setConversionGraceTimeoutS(int conversionGraceTimeoutS)` Global conversion grace timeout value in seconds.
`void`	`setConversionTimeoutPerMegabyteS(int conversionTimeoutPerMegabyteS)` Default timeout in seconds per megabyte for conversion. The conversion fails if it takes more than conversionTimeout * (size of document in Megabytes). The default is -1 which means "undefined". Note: This setting defines the process default value, which can be overridden for each conversion command.
`void`	`setConversionTimeoutS(int conversionTimeoutS)` Default timeout in seconds for conversion. The default is -1 which means use program defaults (30 seconds). The conversion will be considered as failed if it takes longer than conversionTimeout. Note: This setting defines the process default value, which can be overridden for each conversion command.
`void`	`setEnableImageResizing(boolean enableImageResizing)` Enables commands related to images resizing (used in thumbnails computation).
`void`	`setExcelDateFormat(int excelDateFormat)` Date default format to be used to interpret date cells in excel: 0:MM/DD/YYYY, 1:YYYY/MM/DD, 2:DD/MM/YYYY
`void`	`setIFilterExtensions(java.lang.String iFilterExtensions)` Comma-separated list of extensions to be processed through the Windows IFilter interface. Only available on Windows.
`void`	`setIndexSingleContainersAsOneDocument(boolean indexSingleContainersAsOneDocument)` Default indexing mode for containers (ZIP, TAR, PST, ...) to be converted as a single document, instead of indexing the directory only. By default, it indexes only the container directory. Note: This function has no impact on container commands (i.e., opening, listing, ...).
`void`	`setMetaSeparator(java.lang.String metaSeparator)` Character separator for meta-data namespaces. Note: MUST be a printable ascii character (Unicode codepoint must be higher than 32 and strictly lower than 128)
`void`	`setNetcamAsyncTimeoutS(int netcamAsyncTimeoutS)` Netcam asynchronous command timeout in seconds. It should be set to a low value, as it is applied to async commands. The default is -1 which means use program defaults (10 seconds).
`void`	`setNetcamJobsPerMinion(int netcamJobsPerMinion)` The number of Netcam jobs per minion thread. The default is -1 which means use program defaults (4).
`void`	`setNetcamJobsRetries(int netcamJobsRetries)` Number of Netcam jobs retries if a remote exception occurs. The default is -1 which means use program defaults (4).
`void`	`setNetcamMaxJobsPerMinion(int netcamMaxJobsPerMinion)` Total number of jobs a minion can process before being recycled. The default is -1 which means use program defaults (128).
`void`	`setNetcamMode(java.lang.String netcamMode)` Enables Netcam feature: disabled: Disables the feature enabled: Enables the feature optional: Enables the feature if available `enum("disabled", "enabled", "optional")`
`void`	`setNetcamProxy(java.lang.String netcamProxy)` Optional proxy, or null if undefined.
`void`	`setNetcamTimeoutS(int netcamTimeoutS)` Default Netcam conversion timeout in seconds. The default is -1 which means use program defaults (30 seconds). Note: This setting defines the process default value, which can be overridden for each conversion command.
`void`	`setSingleContainersMaxRecursionDepth(int singleContainersMaxRecursionDepth)` Default maximum recursion depth (for containers, or containers inside containers).
`void`	`setSingleContainersMaxRecursionDocuments(int singleContainersMaxRecursionDocuments)` Default maximum number of documents that can be indexed in a container. Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command.
`void`	`setSingleContainersMaxRecursionDocumentsTotal(int singleContainersMaxRecursionDocumentsTotal)` Default maximum number of documents that can be indexed in a container and all its children (for containers inside containers). Only taken in account if indexSingleContainersAsOneDocument = true Note: This setting defines the process default value, which can be overridden for each conversion command.
`void`	`setTtfDir(java.lang.String ttfDir)` The font path (necessary on UNIX).
`java.lang.String`	`toString()` String representation of this ConvertDocumentProcessingSettings.
`ConvertDocumentProcessingSettings`	`withAllowDocumentChars(boolean allowDocumentChars)`
`ConvertDocumentProcessingSettings`	`withAllowDocumentChars(java.lang.Boolean allowDocumentChars)`
`ConvertDocumentProcessingSettings`	`withAllowUnicode32(boolean allowUnicode32)`
`ConvertDocumentProcessingSettings`	`withAllowUnicode32(java.lang.Boolean allowUnicode32)`
`ConvertDocumentProcessingSettings`	`withConversionGraceTimeoutS(int conversionGraceTimeoutS)`
`ConvertDocumentProcessingSettings`	`withConversionGraceTimeoutS(java.lang.Integer conversionGraceTimeoutS)`
`ConvertDocumentProcessingSettings`	`withConversionTimeoutPerMegabyteS(int conversionTimeoutPerMegabyteS)`
`ConvertDocumentProcessingSettings`	`withConversionTimeoutPerMegabyteS(java.lang.Integer conversionTimeoutPerMegabyteS)`
`ConvertDocumentProcessingSettings`	`withConversionTimeoutS(int conversionTimeoutS)`
`ConvertDocumentProcessingSettings`	`withConversionTimeoutS(java.lang.Integer conversionTimeoutS)`
`ConvertDocumentProcessingSettings`	`withEnableImageResizing(boolean enableImageResizing)`
`ConvertDocumentProcessingSettings`	`withEnableImageResizing(java.lang.Boolean enableImageResizing)`
`ConvertDocumentProcessingSettings`	`withExcelDateFormat(int excelDateFormat)`
`ConvertDocumentProcessingSettings`	`withExcelDateFormat(java.lang.Integer excelDateFormat)`
`ConvertDocumentProcessingSettings`	`withIFilterExtensions(java.lang.String iFilterExtensions)`
`ConvertDocumentProcessingSettings`	`withIndexSingleContainersAsOneDocument(boolean indexSingleContainersAsOneDocument)`
`ConvertDocumentProcessingSettings`	`withIndexSingleContainersAsOneDocument(java.lang.Boolean indexSingleContainersAsOneDocument)`
`ConvertDocumentProcessingSettings`	`withMetaSeparator(java.lang.String metaSeparator)`
`ConvertDocumentProcessingSettings`	`withNetcamAsyncTimeoutS(int netcamAsyncTimeoutS)`
`ConvertDocumentProcessingSettings`	`withNetcamAsyncTimeoutS(java.lang.Integer netcamAsyncTimeoutS)`
`ConvertDocumentProcessingSettings`	`withNetcamJobsPerMinion(int netcamJobsPerMinion)`
`ConvertDocumentProcessingSettings`	`withNetcamJobsPerMinion(java.lang.Integer netcamJobsPerMinion)`
`ConvertDocumentProcessingSettings`	`withNetcamJobsRetries(int netcamJobsRetries)`
`ConvertDocumentProcessingSettings`	`withNetcamJobsRetries(java.lang.Integer netcamJobsRetries)`
`ConvertDocumentProcessingSettings`	`withNetcamMaxJobsPerMinion(int netcamMaxJobsPerMinion)`
`ConvertDocumentProcessingSettings`	`withNetcamMaxJobsPerMinion(java.lang.Integer netcamMaxJobsPerMinion)`
`ConvertDocumentProcessingSettings`	`withNetcamMode(java.lang.String netcamMode)`
`ConvertDocumentProcessingSettings`	`withNetcamProxy(java.lang.String netcamProxy)`
`ConvertDocumentProcessingSettings`	`withNetcamTimeoutS(int netcamTimeoutS)`
`ConvertDocumentProcessingSettings`	`withNetcamTimeoutS(java.lang.Integer netcamTimeoutS)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDepth(int singleContainersMaxRecursionDepth)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDepth(java.lang.Integer singleContainersMaxRecursionDepth)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDocuments(int singleContainersMaxRecursionDocuments)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDocuments(java.lang.Integer singleContainersMaxRecursionDocuments)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDocumentsTotal(int singleContainersMaxRecursionDocumentsTotal)`
`ConvertDocumentProcessingSettings`	`withSingleContainersMaxRecursionDocumentsTotal(java.lang.Integer singleContainersMaxRecursionDocumentsTotal)`
`ConvertDocumentProcessingSettings`	`withTtfDir(java.lang.String ttfDir)`
`void`	`writeTo(java.io.OutputStream os)` Write this ConvertDocumentProcessingSettings as an XML fragment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - conversionTimeoutS
```
public int conversionTimeoutS
```
  - DEFAULT_CONVERSION_TIMEOUT_S
```
public static final int DEFAULT_CONVERSION_TIMEOUT_S
```
    See Also:
    
    Constant Field Values
  - conversionTimeoutPerMegabyteS
```
public int conversionTimeoutPerMegabyteS
```
  - DEFAULT_CONVERSION_TIMEOUT_PER_MEGABYTE_S
```
public static final int DEFAULT_CONVERSION_TIMEOUT_PER_MEGABYTE_S
```
    See Also:
    
    Constant Field Values
  - conversionGraceTimeoutS
```
public int conversionGraceTimeoutS
```
  - DEFAULT_CONVERSION_GRACE_TIMEOUT_S
```
public static final int DEFAULT_CONVERSION_GRACE_TIMEOUT_S
```
    See Also:
    
    Constant Field Values
  - enableImageResizing
```
public boolean enableImageResizing
```
  - DEFAULT_ENABLE_IMAGE_RESIZING
```
public static final boolean DEFAULT_ENABLE_IMAGE_RESIZING
```
    See Also:
    
    Constant Field Values
  - netcamMode
```
public java.lang.String netcamMode
```
  - DEFAULT_NETCAM_MODE
```
public static final java.lang.String DEFAULT_NETCAM_MODE
```
    See Also:
    
    Constant Field Values
  - netcamTimeoutS
```
public int netcamTimeoutS
```
  - DEFAULT_NETCAM_TIMEOUT_S
```
public static final int DEFAULT_NETCAM_TIMEOUT_S
```
    See Also:
    
    Constant Field Values
  - netcamAsyncTimeoutS
```
public int netcamAsyncTimeoutS
```
  - DEFAULT_NETCAM_ASYNC_TIMEOUT_S
```
public static final int DEFAULT_NETCAM_ASYNC_TIMEOUT_S
```
    See Also:
    
    Constant Field Values
  - netcamJobsPerMinion
```
public int netcamJobsPerMinion
```
  - DEFAULT_NETCAM_JOBS_PER_MINION
```
public static final int DEFAULT_NETCAM_JOBS_PER_MINION
```
    See Also:
    
    Constant Field Values
  - netcamMaxJobsPerMinion
```
public int netcamMaxJobsPerMinion
```
  - DEFAULT_NETCAM_MAX_JOBS_PER_MINION
```
public static final int DEFAULT_NETCAM_MAX_JOBS_PER_MINION
```
    See Also:
    
    Constant Field Values
  - netcamJobsRetries
```
public int netcamJobsRetries
```
  - DEFAULT_NETCAM_JOBS_RETRIES
```
public static final int DEFAULT_NETCAM_JOBS_RETRIES
```
    See Also:
    
    Constant Field Values
  - netcamProxy
```
public java.lang.String netcamProxy
```
  - ttfDir
```
public java.lang.String ttfDir
```
  - indexSingleContainersAsOneDocument
```
public boolean indexSingleContainersAsOneDocument
```
  - DEFAULT_INDEX_SINGLE_CONTAINERS_AS_ONE_DOCUMENT
```
public static final boolean DEFAULT_INDEX_SINGLE_CONTAINERS_AS_ONE_DOCUMENT
```
    See Also:
    
    Constant Field Values
  - singleContainersMaxRecursionDepth
```
public int singleContainersMaxRecursionDepth
```
  - DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DEPTH
```
public static final int DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DEPTH
```
    See Also:
    
    Constant Field Values
  - singleContainersMaxRecursionDocuments
```
public int singleContainersMaxRecursionDocuments
```
  - DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS
```
public static final int DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS
```
    See Also:
    
    Constant Field Values
  - singleContainersMaxRecursionDocumentsTotal
```
public int singleContainersMaxRecursionDocumentsTotal
```
  - DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS_TOTAL
```
public static final int DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS_TOTAL
```
    See Also:
    
    Constant Field Values
  - allowUnicode32
```
public boolean allowUnicode32
```
  - DEFAULT_ALLOW_UNICODE32
```
public static final boolean DEFAULT_ALLOW_UNICODE32
```
    See Also:
    
    Constant Field Values
  - allowDocumentChars
```
public boolean allowDocumentChars
```
  - DEFAULT_ALLOW_DOCUMENT_CHARS
```
public static final boolean DEFAULT_ALLOW_DOCUMENT_CHARS
```
    See Also:
    
    Constant Field Values
  - metaSeparator
```
public java.lang.String metaSeparator
```
  - DEFAULT_META_SEPARATOR
```
public static final java.lang.String DEFAULT_META_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - iFilterExtensions
```
public java.lang.String iFilterExtensions
```
  - excelDateFormat
```
public int excelDateFormat
```
  - DEFAULT_EXCEL_DATE_FORMAT
```
public static final int DEFAULT_EXCEL_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConvertDocumentProcessingSettings
```
public ConvertDocumentProcessingSettings()
```
  - ConvertDocumentProcessingSettings
```
public ConvertDocumentProcessingSettings(ConvertDocumentProcessingSettings o)
```
    Copy constructor
- Method Detail
  - setConversionTimeoutS
```
public void setConversionTimeoutS(int conversionTimeoutS)
```
    Default timeout in seconds for conversion.
    The default is -1 which means use program defaults (30 seconds).
    The conversion will be considered as failed if it takes longer than conversionTimeout.
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getConversionTimeoutS
```
public int getConversionTimeoutS()
```
    Default timeout in seconds for conversion.
    The default is -1 which means use program defaults (30 seconds).
    The conversion will be considered as failed if it takes longer than conversionTimeout.
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withConversionTimeoutS
```
public ConvertDocumentProcessingSettings withConversionTimeoutS(int conversionTimeoutS)
```
  - withConversionTimeoutS
```
public ConvertDocumentProcessingSettings withConversionTimeoutS(java.lang.Integer conversionTimeoutS)
```
  - setConversionTimeoutPerMegabyteS
```
public void setConversionTimeoutPerMegabyteS(int conversionTimeoutPerMegabyteS)
```
    Default timeout in seconds per megabyte for conversion.
    The conversion fails if it takes more than conversionTimeout * (size of document in Megabytes).
    The default is -1 which means "undefined".
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getConversionTimeoutPerMegabyteS
```
public int getConversionTimeoutPerMegabyteS()
```
    Default timeout in seconds per megabyte for conversion.
    The conversion fails if it takes more than conversionTimeout * (size of document in Megabytes).
    The default is -1 which means "undefined".
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withConversionTimeoutPerMegabyteS
```
public ConvertDocumentProcessingSettings withConversionTimeoutPerMegabyteS(int conversionTimeoutPerMegabyteS)
```
  - withConversionTimeoutPerMegabyteS
```
public ConvertDocumentProcessingSettings withConversionTimeoutPerMegabyteS(java.lang.Integer conversionTimeoutPerMegabyteS)
```
  - setConversionGraceTimeoutS
```
public void setConversionGraceTimeoutS(int conversionGraceTimeoutS)
```
    Global conversion grace timeout value in seconds.
    The convert process will kill a non-responding minion thread after this timeout.
    The default is -1 which means use program defaults (30 seconds).
  - getConversionGraceTimeoutS
```
public int getConversionGraceTimeoutS()
```
    Global conversion grace timeout value in seconds.
    The convert process will kill a non-responding minion thread after this timeout.
    The default is -1 which means use program defaults (30 seconds).
  - withConversionGraceTimeoutS
```
public ConvertDocumentProcessingSettings withConversionGraceTimeoutS(int conversionGraceTimeoutS)
```
  - withConversionGraceTimeoutS
```
public ConvertDocumentProcessingSettings withConversionGraceTimeoutS(java.lang.Integer conversionGraceTimeoutS)
```
  - setEnableImageResizing
```
public void setEnableImageResizing(boolean enableImageResizing)
```
    Enables commands related to images resizing (used in thumbnails computation).
  - isEnableImageResizing
```
public boolean isEnableImageResizing()
```
    Enables commands related to images resizing (used in thumbnails computation).
  - withEnableImageResizing
```
public ConvertDocumentProcessingSettings withEnableImageResizing(boolean enableImageResizing)
```
  - withEnableImageResizing
```
public ConvertDocumentProcessingSettings withEnableImageResizing(java.lang.Boolean enableImageResizing)
```
  - setNetcamMode
```
public void setNetcamMode(java.lang.String netcamMode)
```
    Enables Netcam feature:
    disabled: Disables the feature
    enabled: Enables the feature
    optional: Enables the feature if available
    enum("disabled", "enabled", "optional")
  - getNetcamMode
```
public java.lang.String getNetcamMode()
```
    Enables Netcam feature:
    disabled: Disables the feature
    enabled: Enables the feature
    optional: Enables the feature if available
    enum("disabled", "enabled", "optional")
  - withNetcamMode
```
public ConvertDocumentProcessingSettings withNetcamMode(java.lang.String netcamMode)
```
  - setNetcamTimeoutS
```
public void setNetcamTimeoutS(int netcamTimeoutS)
```
    Default Netcam conversion timeout in seconds.
    The default is -1 which means use program defaults (30 seconds).
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getNetcamTimeoutS
```
public int getNetcamTimeoutS()
```
    Default Netcam conversion timeout in seconds.
    The default is -1 which means use program defaults (30 seconds).
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withNetcamTimeoutS
```
public ConvertDocumentProcessingSettings withNetcamTimeoutS(int netcamTimeoutS)
```
  - withNetcamTimeoutS
```
public ConvertDocumentProcessingSettings withNetcamTimeoutS(java.lang.Integer netcamTimeoutS)
```
  - setNetcamAsyncTimeoutS
```
public void setNetcamAsyncTimeoutS(int netcamAsyncTimeoutS)
```
    Netcam asynchronous command timeout in seconds.
    It should be set to a low value, as it is applied to async commands.
    The default is -1 which means use program defaults (10 seconds).
  - getNetcamAsyncTimeoutS
```
public int getNetcamAsyncTimeoutS()
```
    Netcam asynchronous command timeout in seconds.
    It should be set to a low value, as it is applied to async commands.
    The default is -1 which means use program defaults (10 seconds).
  - withNetcamAsyncTimeoutS
```
public ConvertDocumentProcessingSettings withNetcamAsyncTimeoutS(int netcamAsyncTimeoutS)
```
  - withNetcamAsyncTimeoutS
```
public ConvertDocumentProcessingSettings withNetcamAsyncTimeoutS(java.lang.Integer netcamAsyncTimeoutS)
```
  - setNetcamJobsPerMinion
```
public void setNetcamJobsPerMinion(int netcamJobsPerMinion)
```
    The number of Netcam jobs per minion thread.
    The default is -1 which means use program defaults (4).
  - getNetcamJobsPerMinion
```
public int getNetcamJobsPerMinion()
```
    The number of Netcam jobs per minion thread.
    The default is -1 which means use program defaults (4).
  - withNetcamJobsPerMinion
```
public ConvertDocumentProcessingSettings withNetcamJobsPerMinion(int netcamJobsPerMinion)
```
  - withNetcamJobsPerMinion
```
public ConvertDocumentProcessingSettings withNetcamJobsPerMinion(java.lang.Integer netcamJobsPerMinion)
```
  - setNetcamMaxJobsPerMinion
```
public void setNetcamMaxJobsPerMinion(int netcamMaxJobsPerMinion)
```
    Total number of jobs a minion can process before being recycled.
    The default is -1 which means use program defaults (128).
  - getNetcamMaxJobsPerMinion
```
public int getNetcamMaxJobsPerMinion()
```
    Total number of jobs a minion can process before being recycled.
    The default is -1 which means use program defaults (128).
  - withNetcamMaxJobsPerMinion
```
public ConvertDocumentProcessingSettings withNetcamMaxJobsPerMinion(int netcamMaxJobsPerMinion)
```
  - withNetcamMaxJobsPerMinion
```
public ConvertDocumentProcessingSettings withNetcamMaxJobsPerMinion(java.lang.Integer netcamMaxJobsPerMinion)
```
  - setNetcamJobsRetries
```
public void setNetcamJobsRetries(int netcamJobsRetries)
```
    Number of Netcam jobs retries if a remote exception occurs.
    The default is -1 which means use program defaults (4).
  - getNetcamJobsRetries
```
public int getNetcamJobsRetries()
```
    Number of Netcam jobs retries if a remote exception occurs.
    The default is -1 which means use program defaults (4).
  - withNetcamJobsRetries
```
public ConvertDocumentProcessingSettings withNetcamJobsRetries(int netcamJobsRetries)
```
  - withNetcamJobsRetries
```
public ConvertDocumentProcessingSettings withNetcamJobsRetries(java.lang.Integer netcamJobsRetries)
```
  - setNetcamProxy
```
public void setNetcamProxy(java.lang.String netcamProxy)
```
    Optional proxy, or null if undefined.
  - getNetcamProxy
```
public java.lang.String getNetcamProxy()
```
    Optional proxy, or null if undefined.
  - withNetcamProxy
```
public ConvertDocumentProcessingSettings withNetcamProxy(java.lang.String netcamProxy)
```
  - setTtfDir
```
public void setTtfDir(java.lang.String ttfDir)
```
    The font path (necessary on UNIX). Used for thumbnail generation.
  - getTtfDir
```
public java.lang.String getTtfDir()
```
    The font path (necessary on UNIX). Used for thumbnail generation.
  - withTtfDir
```
public ConvertDocumentProcessingSettings withTtfDir(java.lang.String ttfDir)
```
  - setIndexSingleContainersAsOneDocument
```
public void setIndexSingleContainersAsOneDocument(boolean indexSingleContainersAsOneDocument)
```
    Default indexing mode for containers (ZIP, TAR, PST, ...) to be converted as a single document, instead of indexing the directory only.
    By default, it indexes only the container directory.
    Note: This function has no impact on container commands (i.e., opening, listing, ...). Note: This setting defines the process default value, which can be overridden for each conversion command.
  - isIndexSingleContainersAsOneDocument
```
public boolean isIndexSingleContainersAsOneDocument()
```
    Default indexing mode for containers (ZIP, TAR, PST, ...) to be converted as a single document, instead of indexing the directory only.
    By default, it indexes only the container directory.
    Note: This function has no impact on container commands (i.e., opening, listing, ...). Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withIndexSingleContainersAsOneDocument
```
public ConvertDocumentProcessingSettings withIndexSingleContainersAsOneDocument(boolean indexSingleContainersAsOneDocument)
```
  - withIndexSingleContainersAsOneDocument
```
public ConvertDocumentProcessingSettings withIndexSingleContainersAsOneDocument(java.lang.Boolean indexSingleContainersAsOneDocument)
```
  - setSingleContainersMaxRecursionDepth
```
public void setSingleContainersMaxRecursionDepth(int singleContainersMaxRecursionDepth)
```
    Default maximum recursion depth (for containers, or containers inside containers).
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getSingleContainersMaxRecursionDepth
```
public int getSingleContainersMaxRecursionDepth()
```
    Default maximum recursion depth (for containers, or containers inside containers).
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withSingleContainersMaxRecursionDepth
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDepth(int singleContainersMaxRecursionDepth)
```
  - withSingleContainersMaxRecursionDepth
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDepth(java.lang.Integer singleContainersMaxRecursionDepth)
```
  - setSingleContainersMaxRecursionDocuments
```
public void setSingleContainersMaxRecursionDocuments(int singleContainersMaxRecursionDocuments)
```
    Default maximum number of documents that can be indexed in a container.
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getSingleContainersMaxRecursionDocuments
```
public int getSingleContainersMaxRecursionDocuments()
```
    Default maximum number of documents that can be indexed in a container.
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withSingleContainersMaxRecursionDocuments
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDocuments(int singleContainersMaxRecursionDocuments)
```
  - withSingleContainersMaxRecursionDocuments
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDocuments(java.lang.Integer singleContainersMaxRecursionDocuments)
```
  - setSingleContainersMaxRecursionDocumentsTotal
```
public void setSingleContainersMaxRecursionDocumentsTotal(int singleContainersMaxRecursionDocumentsTotal)
```
    Default maximum number of documents that can be indexed in a container and all its children (for containers inside containers).
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - getSingleContainersMaxRecursionDocumentsTotal
```
public int getSingleContainersMaxRecursionDocumentsTotal()
```
    Default maximum number of documents that can be indexed in a container and all its children (for containers inside containers).
    Only taken in account if indexSingleContainersAsOneDocument = true
    Note: This setting defines the process default value, which can be overridden for each conversion command.
  - withSingleContainersMaxRecursionDocumentsTotal
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDocumentsTotal(int singleContainersMaxRecursionDocumentsTotal)
```
  - withSingleContainersMaxRecursionDocumentsTotal
```
public ConvertDocumentProcessingSettings withSingleContainersMaxRecursionDocumentsTotal(java.lang.Integer singleContainersMaxRecursionDocumentsTotal)
```
  - setAllowUnicode32
```
public void setAllowUnicode32(boolean allowUnicode32)
```
    Allows the use of 32-bit unicode points when processing documents.
    This will allow to produce Unicode characters greater than 65536.
  - isAllowUnicode32
```
public boolean isAllowUnicode32()
```
    Allows the use of 32-bit unicode points when processing documents.
    This will allow to produce Unicode characters greater than 65536.
  - withAllowUnicode32
```
public ConvertDocumentProcessingSettings withAllowUnicode32(boolean allowUnicode32)
```
  - withAllowUnicode32
```
public ConvertDocumentProcessingSettings withAllowUnicode32(java.lang.Boolean allowUnicode32)
```
  - setAllowDocumentChars
```
public void setAllowDocumentChars(boolean allowDocumentChars)
```
    Allows the use of Unicode private range characters (E0XX) for separators
    (keyword, sentence, paragraph separators, ...)
  - isAllowDocumentChars
```
public boolean isAllowDocumentChars()
```
    Allows the use of Unicode private range characters (E0XX) for separators
    (keyword, sentence, paragraph separators, ...)
  - withAllowDocumentChars
```
public ConvertDocumentProcessingSettings withAllowDocumentChars(boolean allowDocumentChars)
```
  - withAllowDocumentChars
```
public ConvertDocumentProcessingSettings withAllowDocumentChars(java.lang.Boolean allowDocumentChars)
```
  - setMetaSeparator
```
public void setMetaSeparator(java.lang.String metaSeparator)
```
    Character separator for meta-data namespaces.
    Note: MUST be a printable ascii character (Unicode codepoint must be higher than 32 and strictly lower than 128)
  - getMetaSeparator
```
public java.lang.String getMetaSeparator()
```
    Character separator for meta-data namespaces.
    Note: MUST be a printable ascii character (Unicode codepoint must be higher than 32 and strictly lower than 128)
  - withMetaSeparator
```
public ConvertDocumentProcessingSettings withMetaSeparator(java.lang.String metaSeparator)
```
  - setIFilterExtensions
```
public void setIFilterExtensions(java.lang.String iFilterExtensions)
```
    Comma-separated list of extensions to be processed through the Windows IFilter interface.
    Only available on Windows.
  - getIFilterExtensions
```
public java.lang.String getIFilterExtensions()
```
    Comma-separated list of extensions to be processed through the Windows IFilter interface.
    Only available on Windows.
  - withIFilterExtensions
```
public ConvertDocumentProcessingSettings withIFilterExtensions(java.lang.String iFilterExtensions)
```
  - setExcelDateFormat
```
public void setExcelDateFormat(int excelDateFormat)
```
    Date default format to be used to interpret date cells in excel: 0:MM/DD/YYYY, 1:YYYY/MM/DD, 2:DD/MM/YYYY
  - getExcelDateFormat
```
public int getExcelDateFormat()
```
    Date default format to be used to interpret date cells in excel: 0:MM/DD/YYYY, 1:YYYY/MM/DD, 2:DD/MM/YYYY
  - withExcelDateFormat
```
public ConvertDocumentProcessingSettings withExcelDateFormat(int excelDateFormat)
```
  - withExcelDateFormat
```
public ConvertDocumentProcessingSettings withExcelDateFormat(java.lang.Integer excelDateFormat)
```
  - makeCopy
```
public ConvertDocumentProcessingSettings makeCopy()
```
    Creates and returns a deep copy of this ConvertDocumentProcessingSettings.
  - readFrom
```
public static ConvertDocumentProcessingSettings readFrom(java.io.InputStream is)
                                                  throws javax.xml.bind.JAXBException
```
    Read this ConvertDocumentProcessingSettings 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 ConvertDocumentProcessingSettings as an XML fragment
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static ConvertDocumentProcessingSettings fromString(java.lang.String s)
                                                    throws javax.xml.bind.JAXBException,
                                                           java.io.UnsupportedEncodingException
```
    String representation of this ConvertDocumentProcessingSettings.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this ConvertDocumentProcessingSettings.
    
    Overrides:
    
    toString in class java.lang.Object
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this ConvertDocumentProcessingSettings.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Throws:
    
    com.exalead.util.TypedException

Class ConvertDocumentProcessingSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

conversionTimeoutS

DEFAULT_CONVERSION_TIMEOUT_S

conversionTimeoutPerMegabyteS

DEFAULT_CONVERSION_TIMEOUT_PER_MEGABYTE_S

conversionGraceTimeoutS

DEFAULT_CONVERSION_GRACE_TIMEOUT_S

enableImageResizing

DEFAULT_ENABLE_IMAGE_RESIZING

netcamMode

DEFAULT_NETCAM_MODE

netcamTimeoutS

DEFAULT_NETCAM_TIMEOUT_S

netcamAsyncTimeoutS

DEFAULT_NETCAM_ASYNC_TIMEOUT_S

netcamJobsPerMinion

DEFAULT_NETCAM_JOBS_PER_MINION

netcamMaxJobsPerMinion

DEFAULT_NETCAM_MAX_JOBS_PER_MINION

netcamJobsRetries

DEFAULT_NETCAM_JOBS_RETRIES

netcamProxy

ttfDir

indexSingleContainersAsOneDocument

DEFAULT_INDEX_SINGLE_CONTAINERS_AS_ONE_DOCUMENT

singleContainersMaxRecursionDepth

DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DEPTH

singleContainersMaxRecursionDocuments

DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS

singleContainersMaxRecursionDocumentsTotal

DEFAULT_SINGLE_CONTAINERS_MAX_RECURSION_DOCUMENTS_TOTAL

allowUnicode32

DEFAULT_ALLOW_UNICODE32

allowDocumentChars

DEFAULT_ALLOW_DOCUMENT_CHARS

metaSeparator

DEFAULT_META_SEPARATOR

iFilterExtensions

excelDateFormat

DEFAULT_EXCEL_DATE_FORMAT

Constructor Detail

ConvertDocumentProcessingSettings

ConvertDocumentProcessingSettings

Method Detail

setConversionTimeoutS

getConversionTimeoutS

withConversionTimeoutS

withConversionTimeoutS

setConversionTimeoutPerMegabyteS

getConversionTimeoutPerMegabyteS

withConversionTimeoutPerMegabyteS

withConversionTimeoutPerMegabyteS

setConversionGraceTimeoutS

getConversionGraceTimeoutS

withConversionGraceTimeoutS

withConversionGraceTimeoutS

setEnableImageResizing

isEnableImageResizing

withEnableImageResizing

withEnableImageResizing

setNetcamMode

getNetcamMode

withNetcamMode

setNetcamTimeoutS

getNetcamTimeoutS

withNetcamTimeoutS

withNetcamTimeoutS

setNetcamAsyncTimeoutS

getNetcamAsyncTimeoutS

withNetcamAsyncTimeoutS

withNetcamAsyncTimeoutS

setNetcamJobsPerMinion

getNetcamJobsPerMinion

withNetcamJobsPerMinion

withNetcamJobsPerMinion