de.opsdesign.yax.types
Class StepType

java.lang.Object
  de.opsdesign.yax.log.LogBuilder
      de.opsdesign.yax.types.ComponentType
          de.opsdesign.yax.types.StepType

All Implemented Interfaces:

Loggable, Run, java.lang.Comparable

Direct Known Subclasses:

FOP, Identity, IdentityOne, Insert, Load, Parse, Rename, Serialize, Store, Validate, XInclude, XSLT

public class StepType
extends ComponentType
implements Run

Field Summary

static java.lang.String

DECLARE_STEP_TYPE

Fields inherited from class de.opsdesign.yax.types.ComponentType

className, description, DESCRIPTION, libraryName, name, NAME, NO, PARAMETER, PORT, REQUIRED, SEQUENCE, TYPE, VALUES, XPROC, YAX, YES

Constructor Summary

StepType()

Method Summary

int	compareTo(java.lang.Object o)
boolean	isUseSuperRun()
protected void	registerStepType(java.lang.String home, java.lang.String name) Registers the step type at the current yax implementation.
protected void	registerStepType(java.lang.String home, java.lang.String name, java.lang.String libraryName) Registers the step type at the current yax implementation.
void	run(Step step) Usually will be overwritten by a step type implementation.
protected Token	setInputToken(Step step)
protected void	setOutputToken(Step step, Token token)
void	setUseSuperRun(boolean useSuperRun)
org.w3c.dom.Element	toElement(org.w3c.dom.Document document)

Methods inherited from class de.opsdesign.yax.types.ComponentType

addImplicitPort, addParameterType, addPortType, addPortType, addPortType, addPortType, addPortType, getClassName, getComponentTypeType, getDescription, getLibraryName, getName, getParameterTypes, getPortTypes, getPrefix, getPrefixedName, getXProcOptionsLibraryName, getXProcStandardLibraryName, getYaxOptionsLibraryName, getYaxStandardLibraryName, isConstructType, isStep, isStepType, setDescription, setLibraryName, setName

Methods inherited from class de.opsdesign.yax.log.LogBuilder

log, log, log, log

Methods inherited from class java.lang.Object

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

Field Detail

DECLARE_STEP_TYPE

public static final java.lang.String DECLARE_STEP_TYPE

See Also:

Constant Field Values

Constructor Detail

StepType

public StepType()

Method Detail

run

public void run(Step step)
         throws RunException

Usually will be overwritten by a step type implementation. If used without any changes logs a warning message for indicating that the default (Identity) implementation is used. If the default implemenation is enough set 'useSuperRun' to 'true'.

Specified by:

run in interface Run

Throws:

RunException

setInputToken

protected Token setInputToken(Step step)
                       throws RunException

Throws:

RunException

setOutputToken

protected void setOutputToken(Step step,
                              Token token)
                       throws RunException

Throws:

RunException

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document document)

registerStepType

protected void registerStepType(java.lang.String home,
                                java.lang.String name)

Registers the step type at the current yax implementation.

Parameters:

home - indicates whether this step type is part of

a) core implementation (constant XPROC with the value of 'xproc')

b) custom implementation (constant YAX with the value of 'yax')

name - name of the step. This name will be in conjunction with the appropriate namespace prefix within XProc scripts.

registerStepType

protected void registerStepType(java.lang.String home,
                                java.lang.String name,
                                java.lang.String libraryName)

Registers the step type at the current yax implementation.

Parameters:

home - indicates whether this step type is part of

a) core implementation (constant XPROC with the value of 'xproc')

b) custom implementation (constant YAX with the value of 'yax')

name - name of the step. This name will be in conjunction with the appropriate namespace prefix within XProc scripts.

libraryName - name of library the step is part of.

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

isUseSuperRun

public boolean isUseSuperRun()

setUseSuperRun

public void setUseSuperRun(boolean useSuperRun)