com.googlecode.fascinator.redbox.plugins.local
Class LocalTransformer

java.lang.Object
  com.googlecode.fascinator.redbox.plugins.local.LocalTransformer

All Implemented Interfaces:

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

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

Create and store Persistent Identifiers based on configurable templates.

Configuration

Keep in mind that each data source can provide an overriding template.

Option	Description	Required	Default
id	Id of the transformer	Yes	local
template	The template to evaluate in creating Persistent IDs. Supports placeholder values: [[OID]] - The Object ID being transformed [[INC]] - An auto-incrementing number (if configured)	No	pid:[[OID]]
useIncrements	Boolean flag to decide if auto-incrementing numbers are in use.	No	false
incrementingFile	If the above flag is set, this File is used to store/read the current value of the sequence.	Yes (if 'useIncrements' is set)	N/A

There is also some related configuration in the Curation Manager that this Transformer looks for under "curation" > "pidProperty". This value decides on the metadata property where the Persistent IDs should be stored.

Author:

Greg Pendlebury

Constructor Summary

LocalTransformer()
Constructor

Method Summary

String	getId() Get Transformer ID
String	getName() Get Transformer Name
com.googlecode.fascinator.api.PluginDescription	getPluginDetails() Gets a PluginDescription object relating to this plugin.
void	init(File jsonFile) Init method from file
void	init(String jsonString) Init method from String
void	shutdown() Shut down the transformer plugin
com.googlecode.fascinator.api.storage.DigitalObject	transform(com.googlecode.fascinator.api.storage.DigitalObject in, String jsonConfig) Transform method

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalTransformer

public LocalTransformer()

Constructor

Method Detail

init

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

Init method from file

Specified by:

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

Parameters:

jsonFile -

Throws:

IOException

com.googlecode.fascinator.api.PluginException

init

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

Init method from String

Specified by:

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

Parameters:

jsonString -

Throws:

IOException

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

Transform method

Specified by:

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

Parameters:

object - : DigitalObject to be transformed

jsonConfig - : String containing configuration for this item

Returns:

DigitalObject The object after being transformed

Throws:

com.googlecode.fascinator.api.transformer.TransformerException

getId

public String getId()

Get Transformer ID

Specified by:

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

Returns:

id

getName

public String getName()

Get Transformer Name

Specified by:

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

Returns:

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

Shut down the transformer plugin

Specified by:

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

Throws:

com.googlecode.fascinator.api.PluginException