public class ScriptCondition extends AbstractStringCondition
A condition formulated using a scripting language.
The default script engine is JavaScript
.
Refer to ScriptRunner
for more information on using a scripting
language with Norconex Importer.
The following are variables made available to your script for each document:
maxReadSize
length).Properties
object.The expected return value from your script is a boolean indicating whether the document was matched or not.
<condition
class="com.norconex.importer.handler.condition.impl.ScriptCondition"
maxReadSize="(max characters to read at once)"
sourceCharset="(character encoding)"
engineName="(script engine name)">
(your script)
</condition>
<!-- Javascript: -->
<condition
class="ScriptCondition">
<![CDATA[
var isAppleDoc = metadata.getString('fruit') == 'apple'
|| content.indexOf('Apple') > -1;
// Return value:
isAppleDoc;
]]>
</condition>
<!-- Lua: -->
<condition
class="ScriptCondition"
engineName="lua">
<![CDATA[
local isAppleDoc = metadata:getString('fruit') == 'apple'
and content:find('Apple') ~= nil;
return isAppleDoc;
]]>
</condition>
ScriptRunner
Constructor and Description |
---|
ScriptCondition() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object other) |
String |
getEngineName() |
String |
getScript() |
int |
hashCode() |
protected void |
loadStringConditionFromXML(XML xml)
Loads configuration settings specific to the implementing class.
|
protected void |
saveStringConditionToXML(XML xml)
Saves configuration settings specific to the implementing class.
|
void |
setEngineName(String engineName) |
void |
setScript(String script) |
protected boolean |
testDocument(HandlerDoc doc,
String input,
ParseState parseState,
int sectionIndex) |
String |
toString() |
getMaxReadSize, loadCharStreamConditionFromXML, saveCharStreamConditionToXML, setMaxReadSize, testDocument
getSourceCharset, loadFromXML, saveToXML, setSourceCharset, testDocument
public String getEngineName()
public void setEngineName(String engineName)
public String getScript()
public void setScript(String script)
protected boolean testDocument(HandlerDoc doc, String input, ParseState parseState, int sectionIndex) throws ImporterHandlerException
testDocument
in class AbstractStringCondition
ImporterHandlerException
protected void loadStringConditionFromXML(XML xml)
AbstractStringCondition
loadStringConditionFromXML
in class AbstractStringCondition
xml
- XML configurationprotected void saveStringConditionToXML(XML xml)
AbstractStringCondition
saveStringConditionToXML
in class AbstractStringCondition
xml
- the XMLpublic boolean equals(Object other)
equals
in class AbstractStringCondition
public int hashCode()
hashCode
in class AbstractStringCondition
public String toString()
toString
in class AbstractStringCondition
Copyright © 2009–2023 Norconex Inc.. All rights reserved.