org.ghost4j.modifier

Class AbstractModifier

java.lang.Object

org.ghost4j.AbstractComponent

org.ghost4j.modifier.AbstractModifier

All Implemented Interfaces:

Component, Modifier

public abstract class AbstractModifier
extends AbstractComponent
implements Modifier

Abstract modifier implementation. Contains methods that are common to the different modifier types

Author:

Gilles Grousset (gi.grousset@gmail.com)

Field Summary

Fields inherited from class org.ghost4j.AbstractComponent

supportedDocumentClasses

Constructor Summary

Constructors

Constructor and Description
AbstractModifier()

Method Summary

Methods

Modifier and Type	Method and Description
Document	modify(Document source, Map<String,Serializable> parameters) Modify a document with optional parameters
protected abstract Document	run(Document source, Map<String,Serializable> parameters)

Methods inherited from class org.ghost4j.AbstractComponent

assertDeviceSupported, assertDocumentSupported, copySettings, extractSettings, isDeviceSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModifier

public AbstractModifier()

Method Detail

modify

public Document modify(Document source,
              Map<String,Serializable> parameters)
                throws ModifierException,
                       DocumentException,
                       IOException

Description copied from interface: Modifier

Modify a document with optional parameters

Specified by:

modify in interface Modifier

Parameters:

source - Document to modify

parameters - Modifier parameters

Returns:

Modifier version of the document

Throws:

ModifierException

DocumentException

IOException

run

protected abstract Document run(Document source,
           Map<String,Serializable> parameters)
                         throws ModifierException,
                                DocumentException

Throws:

ModifierException

DocumentException