org.nuxeo.ecm.platform.transform.plugin
Class AbstractPlugin

java.lang.Object
  org.nuxeo.ecm.platform.transform.plugin.AbstractPlugin

All Implemented Interfaces:

Serializable, Plugin

Direct Known Subclasses:

ImagingTransformPluginImpl, JOOoConvertPluginImpl, MultipleResultsEchoPlugin, PDF2ImagePluginImpl, PDFBoxPluginImpl, WordMLDataInjectPluginImpl, WordToTextPlugin, XSLTPluginImpl

public abstract class AbstractPlugin
extends Object
implements Plugin

Plugin abstract class.

Default plugin behavior.

Author:

Julien Anguenot

See Also:

Plugin, Serialized Form

Field Summary

protected Map<String,Serializable>	defaultOptions
protected String	destinationMimeType
protected String	name
protected List<String>	sourceMimeTypes

Constructor Summary

protected	AbstractPlugin()
protected	AbstractPlugin(String name)
protected	AbstractPlugin(String name, List<String> sourceMimeTypes, String destinationMimeType)
protected	AbstractPlugin(String name, List<String> sourceMimeTypes, String destinationMimeType, Map<String,Serializable> defaultOptions)

Method Summary

Map<String,Serializable>	getDefaultOptions() Returns the default options.
String	getDestinationMimeType() Gets the destination mimetype.
String	getName() Gets the plugin name.
List<String>	getSourceMimeTypes() Gets mimetypes for source.
boolean	isSourceCandidate(Blob blob) Is a given streaming blob instance a candidate for this plugin.
boolean	isSourceCandidate(TransformDocument doc) Is a given transform document a candidate for this plugin.
void	setDefaultOptions(Map<String,Serializable> defaultOptions) Sets default options.
void	setDestinationMimeType(String destinationMimeType) Sets the destination mimetype.
void	setName(String name) Sets plugin name.
void	setSourceMimeTypes(List<String> sourceMimeTypes) Sets source mimetypes.
void	setSpecificOptions(Map<String,Serializable> options) Sets specific options.
List<TransformDocument>	transform(Map<String,Serializable> options, Blob... blobs) Transforms sources given specific plugin options.
List<TransformDocument>	transform(Map<String,Serializable> options, TransformDocument... sources) Transforms sources given specific plugin options.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

sourceMimeTypes

protected List<String> sourceMimeTypes

destinationMimeType

protected String destinationMimeType

defaultOptions

protected Map<String,Serializable> defaultOptions

Constructor Detail

AbstractPlugin

protected AbstractPlugin()

AbstractPlugin

protected AbstractPlugin(String name)

AbstractPlugin

protected AbstractPlugin(String name,
                         List<String> sourceMimeTypes,
                         String destinationMimeType)

AbstractPlugin

protected AbstractPlugin(String name,
                         List<String> sourceMimeTypes,
                         String destinationMimeType,
                         Map<String,Serializable> defaultOptions)

Method Detail

getDefaultOptions

public Map<String,Serializable> getDefaultOptions()

Description copied from interface: Plugin

Returns the default options.

Specified by:

getDefaultOptions in interface Plugin

Returns:

a map holding the default plugin options.

getDestinationMimeType

public String getDestinationMimeType()

Description copied from interface: Plugin

Gets the destination mimetype.

Specified by:

getDestinationMimeType in interface Plugin

Returns:

a string holding the destination mimetype

getName

public String getName()

Description copied from interface: Plugin

Gets the plugin name.

Specified by:

getName in interface Plugin

Returns:

a string holding the plugin name

getSourceMimeTypes

public List<String> getSourceMimeTypes()

Description copied from interface: Plugin

Gets mimetypes for source.

The source mimetypes are all the formats this plugin can deal with.

Specified by:

getSourceMimeTypes in interface Plugin

Returns:

list of string holding each mimetype.

setDefaultOptions

public void setDefaultOptions(Map<String,Serializable> defaultOptions)

Description copied from interface: Plugin

Sets default options.

Specified by:

setDefaultOptions in interface Plugin

Parameters:

defaultOptions - a map of string to objects holding the default plugin options.

setDestinationMimeType

public void setDestinationMimeType(String destinationMimeType)

Description copied from interface: Plugin

Sets the destination mimetype.

The destination mimetype is the format the result of the plugin transformation.

Specified by:

setDestinationMimeType in interface Plugin

Parameters:

destinationMimeType - a string holding the destination mimetype

setName

public void setName(String name)

Description copied from interface: Plugin

Sets plugin name.

Specified by:

setName in interface Plugin

Parameters:

name - a string holding the name

setSourceMimeTypes

public void setSourceMimeTypes(List<String> sourceMimeTypes)

Description copied from interface: Plugin

Sets source mimetypes.

The source mimetypes are all the formats this plugin can deal with.

Specified by:

setSourceMimeTypes in interface Plugin

Parameters:

sourceMimeTypes - a list of strings representing each mimetype

setSpecificOptions

public void setSpecificOptions(Map<String,Serializable> options)

Sets specific options.

Override default plugin options.

Specified by:

setSpecificOptions in interface Plugin

Parameters:

options - a map from from string to serializable.

transform

public List<TransformDocument> transform(Map<String,Serializable> options,
                                         TransformDocument... sources)
                                  throws Exception

Description copied from interface: Plugin

Transforms sources given specific plugin options.

Specified by:

transform in interface Plugin

Parameters:

options - plugin options

sources - list of sources as TransformDocument instances

Returns:

list of TransformDocument instances

Throws:

Exception

transform

public List<TransformDocument> transform(Map<String,Serializable> options,
                                         Blob... blobs)
                                  throws Exception

Description copied from interface: Plugin

Transforms sources given specific plugin options.

Specified by:

transform in interface Plugin

Parameters:

options - plugin options

blobs - list of sources as streaming blob instance.

Returns:

list of TransformDocument instances

Throws:

Exception

isSourceCandidate

public boolean isSourceCandidate(TransformDocument doc)

Description copied from interface: Plugin

Is a given transform document a candidate for this plugin.

Specified by:

isSourceCandidate in interface Plugin

Parameters:

doc - : a transform document instance.

Returns:

true if candidate / false if not.

isSourceCandidate

public boolean isSourceCandidate(Blob blob)

Description copied from interface: Plugin

Is a given streaming blob instance a candidate for this plugin.

Specified by:

isSourceCandidate in interface Plugin

Parameters:

blob - : a streaming blob instance

Returns:

true if candidate / false if not.