Package com.norconex.importer.handler.transformer.impl

Class SaveDocumentTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.SaveDocumentTransformerConfig

All Implemented Interfaces:

Labelable

public class SaveDocumentTransformerConfig
extends BaseDocHandlerConfig

Saves a copy of the document at its current processing state in the specified directory. If no directory is specified, the default is "./savedDocuments". It is recommended to use this tagger as a pre-parse handler if you want to save the original file.

Any maximum file path length value below 10 is considered unlimited (the default).

See Also:

• SaveDocumentTransformer configuration reference

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DEFAULT_FILE_NAME
static final String	DEFAULT_SAVE_DIR_PATH
static final String	DEFAULT_SPLIT_PATTERN

Constructor Summary

Constructors

Constructor	Description
SaveDocumentTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDefaultFileName()
String	getDirSplitPattern()
int	getMaxPathLength()
String	getPathToField()
Path	getSaveDir()
int	hashCode()
boolean	isEscape()
SaveDocumentTransformerConfig	setDefaultFileName(String defaultFileName)
SaveDocumentTransformerConfig	setDirSplitPattern(String dirSplitPattern)
SaveDocumentTransformerConfig	setEscape(boolean escape)
SaveDocumentTransformerConfig	setMaxPathLength(int maxPathLength)
SaveDocumentTransformerConfig	setPathToField(String pathToField)
SaveDocumentTransformerConfig	setSaveDir(Path saveDir)
String	toString()

Methods inherited from class com.norconex.importer.handler.BaseLabelableConfig

getLabel, setLabel

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SAVE_DIR_PATH

public static final String DEFAULT_SAVE_DIR_PATH

See Also:

• Constant Field Values

DEFAULT_SPLIT_PATTERN

public static final String DEFAULT_SPLIT_PATTERN

See Also:

• Constant Field Values

DEFAULT_DEFAULT_FILE_NAME

public static final String DEFAULT_DEFAULT_FILE_NAME

See Also:

• Constant Field Values

Constructor Details

SaveDocumentTransformerConfig

public SaveDocumentTransformerConfig()

Method Details

getSaveDir

public Path getSaveDir()

getMaxPathLength

public int getMaxPathLength()

getDirSplitPattern

public String getDirSplitPattern()

isEscape

public boolean isEscape()

getPathToField

public String getPathToField()

getDefaultFileName

public String getDefaultFileName()

setSaveDir

public SaveDocumentTransformerConfig setSaveDir(Path saveDir)

Returns:

this.

setMaxPathLength

public SaveDocumentTransformerConfig setMaxPathLength(int maxPathLength)

Returns:

this.

setDirSplitPattern

public SaveDocumentTransformerConfig setDirSplitPattern(String dirSplitPattern)

Returns:

this.

setEscape

public SaveDocumentTransformerConfig setEscape(boolean escape)

Returns:

this.

setPathToField

public SaveDocumentTransformerConfig setPathToField(String pathToField)

Returns:

this.

setDefaultFileName

public SaveDocumentTransformerConfig setDefaultFileName(String defaultFileName)

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseLabelableConfig

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseLabelableConfig

hashCode

public int hashCode()

Overrides:

hashCode in class BaseLabelableConfig

toString

public String toString()

Overrides:

toString in class BaseLabelableConfig