com.norconex.importer.handler.tagger.impl

Class ScriptTagger

java.lang.Object

com.norconex.importer.handler.AbstractImporterHandler

com.norconex.importer.handler.tagger.AbstractDocumentTagger

com.norconex.importer.handler.tagger.AbstractCharStreamTagger

com.norconex.importer.handler.tagger.AbstractStringTagger

com.norconex.importer.handler.tagger.impl.ScriptTagger

All Implemented Interfaces:

IXMLConfigurable, IImporterHandler, IDocumentTagger

public class ScriptTagger
extends AbstractStringTagger

Tag incoming documents using a scripting language. The default script engine is JavaScript.

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

How to tag 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 a ImporterMetadata object.
• parsed: Whether the document was already parsed, as a boolean.
• sectionIndex: Content section index if it had to be split, as an integer.

There are no expected return value from your script. Returning one has no effect.

XML configuration usage:

  <tagger class="com.norconex.importer.handler.tagger.impl.ScriptTagger"
          engineName="(script engine name)"
          sourceCharset="(character encoding)"
          maxReadSize="(max content characters to read at once)" >
          
      <restrictTo caseSensitive="[false|true]"
              field="(name of header/metadata field name to match)">
          (regular expression of value to match)
      </restrictTo>
      <!-- multiple "restrictTo" tags allowed (only one needs to match) -->

      <script>(your script)</script>
 
  </tagger>
 

Usage example:

The following example simply adds new metadata field indicating which fruit is a document about.

JavaScript:

  <tagger class="com.norconex.importer.handler.tagger.impl.ScriptTagger">
    <script><![CDATA[
        metadata.addString('fruit', 'apple');
    ]]></script>
  </tagger>
 

Lua:

  <tagger class="com.norconex.importer.handler.tagger.impl.ScriptTagger"
      engineName="lua">
    <script><![CDATA[
        metadata:addString('fruit', {'apple'});
    ]]></script>
  </tagger>
 

Since:

2.4.0

Author:

Pascal Essiembre

See Also:

ScriptRunner

Constructor Summary

Constructors

Constructor and Description
ScriptTagger()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getEngineName()
String	getScript()
int	hashCode()
protected void	loadStringTaggerFromXML(org.apache.commons.configuration.XMLConfiguration xml) Loads configuration settings specific to the implementing class.
protected void	saveStringTaggerToXML(EnhancedXMLStreamWriter writer) Saves configuration settings specific to the implementing class.
void	setEngineName(String engineName)
void	setScript(String script)
protected void	tagStringContent(String reference, StringBuilder content, ImporterMetadata metadata, boolean parsed, int sectionIndex)
String	toString()

Methods inherited from class com.norconex.importer.handler.tagger.AbstractStringTagger

getMaxReadSize, loadCharStreamTaggerFromXML, saveCharStreamTaggerToXML, setMaxReadSize, tagTextDocument

Methods inherited from class com.norconex.importer.handler.tagger.AbstractCharStreamTagger

getSourceCharset, loadHandlerFromXML, saveHandlerToXML, setSourceCharset, tagApplicableDocument

Methods inherited from class com.norconex.importer.handler.tagger.AbstractDocumentTagger

tagDocument

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

addRestriction, addRestriction, addRestrictions, clearRestrictions, detectCharsetIfBlank, getRestrictions, isApplicable, loadFromXML, removeRestriction, removeRestriction, saveToXML

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptTagger

public ScriptTagger()

Method Detail

getEngineName

public String getEngineName()

setEngineName

public void setEngineName(String engineName)

getScript

public String getScript()

setScript

public void setScript(String script)

tagStringContent

protected void tagStringContent(String reference,
                                StringBuilder content,
                                ImporterMetadata metadata,
                                boolean parsed,
                                int sectionIndex)
                         throws ImporterHandlerException

Specified by:

tagStringContent in class AbstractStringTagger

Throws:

ImporterHandlerException

saveStringTaggerToXML

protected void saveStringTaggerToXML(EnhancedXMLStreamWriter writer)
                              throws XMLStreamException

Description copied from class: AbstractStringTagger

Saves configuration settings specific to the implementing class. The parent tag along with the "class" attribute are already written. Implementors must not close the writer.

Specified by:

saveStringTaggerToXML in class AbstractStringTagger

Parameters:

writer - the xml writer

Throws:

XMLStreamException - could not save to XML

loadStringTaggerFromXML

protected void loadStringTaggerFromXML(org.apache.commons.configuration.XMLConfiguration xml)
                                throws IOException

Description copied from class: AbstractStringTagger

Loads configuration settings specific to the implementing class.

Specified by:

loadStringTaggerFromXML in class AbstractStringTagger

Parameters:

xml - xml configuration

Throws:

IOException - could not load from XML

equals

public boolean equals(Object other)

Overrides:

equals in class AbstractStringTagger

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractStringTagger

toString

public String toString()

Overrides:

toString in class AbstractStringTagger