com.googlecode.fascinator.transformer

Class ScriptingTransformer

java.lang.Object

com.googlecode.fascinator.transformer.ScriptingTransformer

All Implemented Interfaces:

com.googlecode.fascinator.api.Plugin, com.googlecode.fascinator.api.transformer.Transformer

public class ScriptingTransformer
extends Object
implements com.googlecode.fascinator.api.transformer.Transformer

This plugin provides method to execute Transformers using scripts written in Jython or Groovy

Configuration

Standard configuration table:

Option	Description	Required	Default
id	Transformer Id	Yes	scripting

Examples

1. Scripting transformer attached to the transformer list in The Fascinator

         "scripting": {
                "id": "scripting",
                "scriptType": "groovy",
                "scriptPath": "${fascinator.home}/transformer-scripts/exampleScript.groovy"
            }
    

Author:

Andrew Brazzatti

Constructor Summary

Constructors

Constructor and Description
ScriptingTransformer() Extractor Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Overridden method getId
String	getName() Overridden method getName
com.googlecode.fascinator.api.PluginDescription	getPluginDetails() Gets a PluginDescription object relating to this plugin.
void	init(File jsonFile) Overridden method init to initialize
void	init(String jsonString) Overridden method init to initialize
void	shutdown() Overridden method shutdown method
com.googlecode.fascinator.api.storage.DigitalObject	transform(com.googlecode.fascinator.api.storage.DigitalObject in, String jsonConfig) Overridden transform method

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptingTransformer

public ScriptingTransformer()

Extractor Constructor

Method Detail

init

public void init(String jsonString)
          throws com.googlecode.fascinator.api.PluginException

Overridden method init to initialize

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Parameters:

jsonString - of configuration for Extractor

Throws:

com.googlecode.fascinator.api.PluginException - if fail to parse the config

init

public void init(File jsonFile)
          throws com.googlecode.fascinator.api.PluginException

Overridden method init to initialize

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Parameters:

jsonFile - to retrieve the configuration for Extractor

Throws:

com.googlecode.fascinator.api.PluginException - if fail to read the config file

getId

public String getId()

Overridden method getId

Specified by:

getId in interface com.googlecode.fascinator.api.Plugin

Returns:

plugin id

getName

public String getName()

Overridden method getName

Specified by:

getName in interface com.googlecode.fascinator.api.Plugin

Returns:

plugin name

getPluginDetails

public com.googlecode.fascinator.api.PluginDescription getPluginDetails()

Gets a PluginDescription object relating to this plugin.

Specified by:

getPluginDetails in interface com.googlecode.fascinator.api.Plugin

Returns:

a PluginDescription

shutdown

public void shutdown()
              throws com.googlecode.fascinator.api.PluginException

Overridden method shutdown method

Specified by:

shutdown in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.PluginException

transform

public com.googlecode.fascinator.api.storage.DigitalObject transform(com.googlecode.fascinator.api.storage.DigitalObject in,
                                                            String jsonConfig)
                                                              throws com.googlecode.fascinator.api.transformer.TransformerException

Overridden transform method

Specified by:

transform in interface com.googlecode.fascinator.api.transformer.Transformer

Parameters:

DigitalObject - to be processed

Returns:

processed DigitalObject with the rdf metadata

Throws:

com.googlecode.fascinator.api.transformer.TransformerException