com.googlecode.fascinator.redbox.plugins.curation.mint
Class IngestedRelationshipsTransformer

java.lang.Object
  com.googlecode.fascinator.redbox.plugins.curation.mint.IngestedRelationshipsTransformer

All Implemented Interfaces:

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

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

This transformer is designed to fire only once after each item is ingested. It is primarily concerned with resolving relationships between parties.

Author:

Greg Pendlebury

Field Summary

static String

PROPERTY_FLAG Property flag to indicate execution

Constructor Summary

IngestedRelationshipsTransformer()
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

Field Detail

PROPERTY_FLAG

public static String PROPERTY_FLAG

Property flag to indicate execution

Constructor Detail

IngestedRelationshipsTransformer

public IngestedRelationshipsTransformer()

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