Package com.norconex.importer

Class ImporterConfig

java.lang.Object

com.norconex.importer.ImporterConfig

public class ImporterConfig
extends Object

Importer configuration. Refer to DefaultParser for parse-specific configuration documentation.

See Also:

• DefaultParser
• ImporterConfig configuration reference

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_MAX_STREAM_CACHE_POOL_SIZE	100 MB.
static final long	DEFAULT_MAX_STREAM_CACHE_SIZE	1 GB.
static final String	DEFAULT_TEMP_DIR_PATH

Constructor Summary

Constructors

Constructor	Description
ImporterConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<DocHandler>	getHandlers()
long	getMaxMemoryInstance()	The maximum number of bytes used for memory caching of a single documents being processed.
long	getMaxMemoryPool()	The maximum number of bytes used for memory caching of data for all documents concurrently being processed.
List<ImporterResponseProcessor>	getResponseProcessors()
Path	getTempDir()	The temporary directory where files can be deleted safely by the OS or any other processes when the Importer is not running.
int	hashCode()
ImporterConfig	setHandlers(List<DocHandler> handlers)
ImporterConfig	setMaxMemoryInstance(long maxMemoryInstance)	The maximum number of bytes used for memory caching of a single documents being processed.
ImporterConfig	setMaxMemoryPool(long maxMemoryPool)	The maximum number of bytes used for memory caching of data for all documents concurrently being processed.
ImporterConfig	setResponseProcessors(List<ImporterResponseProcessor> responseProcessors)
ImporterConfig	setTempDir(Path tempDir)	The temporary directory where files can be deleted safely by the OS or any other processes when the Importer is not running.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_TEMP_DIR_PATH

public static final String DEFAULT_TEMP_DIR_PATH

DEFAULT_MAX_STREAM_CACHE_POOL_SIZE

public static final long DEFAULT_MAX_STREAM_CACHE_POOL_SIZE

100 MB.

DEFAULT_MAX_STREAM_CACHE_SIZE

public static final long DEFAULT_MAX_STREAM_CACHE_SIZE

1 GB.

Constructor Details

ImporterConfig

public ImporterConfig()

Method Details

getHandlers

public List<DocHandler> getHandlers()

setHandlers

public ImporterConfig setHandlers(List<DocHandler> handlers)

getResponseProcessors

public List<ImporterResponseProcessor> getResponseProcessors()

setResponseProcessors

public ImporterConfig setResponseProcessors(List<ImporterResponseProcessor> responseProcessors)

getTempDir

public Path getTempDir()

The temporary directory where files can be deleted safely by the OS or any other processes when the Importer is not running. When not set, the importer will use the system temporary directory.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Returns:

path to temporary directory

getMaxMemoryInstance

public long getMaxMemoryInstance()

The maximum number of bytes used for memory caching of a single documents being processed. Default is DEFAULT_MAX_STREAM_CACHE_POOL_SIZE.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Returns:

max document memory cache size

getMaxMemoryPool

public long getMaxMemoryPool()

The maximum number of bytes used for memory caching of data for all documents concurrently being processed. Default is DEFAULT_MAX_STREAM_CACHE_SIZE.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Returns:

max documents memory pool cache size

setTempDir

public ImporterConfig setTempDir(Path tempDir)

The temporary directory where files can be deleted safely by the OS or any other processes when the Importer is not running. When not set, the importer will use the system temporary directory.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Parameters:

tempDir - path to temporary directory

Returns:

this.

setMaxMemoryInstance

public ImporterConfig setMaxMemoryInstance(long maxMemoryInstance)

The maximum number of bytes used for memory caching of a single documents being processed. Default is DEFAULT_MAX_STREAM_CACHE_POOL_SIZE.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Parameters:

maxMemoryInstance - max document memory cache size

Returns:

this.

setMaxMemoryPool

public ImporterConfig setMaxMemoryPool(long maxMemoryPool)

The maximum number of bytes used for memory caching of data for all documents concurrently being processed. Default is DEFAULT_MAX_STREAM_CACHE_SIZE.

This only get used when the Importer launched directly from the command-line or when importing documents via Importer.importDocument(ImporterRequest). Documents imported via Importer.importDocument(com.norconex.importer.doc.Doc) already have their temp/cache directory built-in.

Parameters:

maxMemoryPool - max documents memory pool cache size

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object