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

Class ScriptTransformerConfig

java.lang.Object

com.norconex.importer.handler.BaseLabelableConfig

com.norconex.importer.handler.BaseDocHandlerConfig

com.norconex.importer.handler.transformer.impl.ScriptTransformerConfig

All Implemented Interfaces:

Labelable, ChunkedTextSupport

public class ScriptTransformerConfig
extends BaseDocHandlerConfig
implements ChunkedTextSupport

Transform incoming documents using a scripting language.

Refer to ScriptRunner for more information on using a scripting language with Norconex Importer.

How to transform documents with scripting:

The following are variables made available to your script for each document:

• reference: Document unique reference as a string.
• content: Document content, as a string (of maxReadSize length).
• metadata: Document metadata as an Properties object.
• parsed: Whether the document was already parsed, as a boolean.
• sectionIndex: Content section index if it had to be split (as per maxReadSize), as an integer.

The expected return value from your script is a string holding the modified content.

Usage examples:

The following examples replace all occurrences of "Alice" with "Roger" in a document content.

See Also:

• ScriptRunner
• ScriptTransformer configuration reference

Constructor Summary

Constructors

Constructor	Description
ScriptTransformerConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getEngineName()
TextMatcher	getFieldMatcher()	Gets source field matcher for fields on which to execute a script.
int	getMaxReadSize()
String	getScript()
Charset	getSourceCharset()
int	hashCode()
ScriptTransformerConfig	setEngineName(String engineName)
ScriptTransformerConfig	setFieldMatcher(TextMatcher fieldMatcher)	Sets source field matcher for fields on which to execute a script.
ScriptTransformerConfig	setMaxReadSize(int maxReadSize)
ScriptTransformerConfig	setScript(String script)
ScriptTransformerConfig	setSourceCharset(Charset sourceCharset)
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

Constructor Details

ScriptTransformerConfig

public ScriptTransformerConfig()

Method Details

getFieldMatcher

public TextMatcher getFieldMatcher()

Gets source field matcher for fields on which to execute a script.

Specified by:

getFieldMatcher in interface ChunkedTextSupport

Returns:

field matcher

setFieldMatcher

public ScriptTransformerConfig setFieldMatcher(TextMatcher fieldMatcher)

Sets source field matcher for fields on which to execute a script.

Parameters:

fieldMatcher - field matcher

getMaxReadSize

public int getMaxReadSize()

Specified by:

getMaxReadSize in interface ChunkedTextSupport

getSourceCharset

public Charset getSourceCharset()

Specified by:

getSourceCharset in interface ChunkedTextSupport

getEngineName

public String getEngineName()

getScript

public String getScript()

setMaxReadSize

public ScriptTransformerConfig setMaxReadSize(int maxReadSize)

Returns:

this.

setSourceCharset

public ScriptTransformerConfig setSourceCharset(Charset sourceCharset)

Returns:

this.

setEngineName

public ScriptTransformerConfig setEngineName(String engineName)

Returns:

this.

setScript

public ScriptTransformerConfig setScript(String script)

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