org.jostraca.transform
Class TextualTransformManager

java.lang.Object
  org.jostraca.util.SimpleObjectManager
      org.jostraca.transform.TextualTransformManager

All Implemented Interfaces:

TextualTransform

public class TextualTransformManager

extends SimpleObjectManager

implements TextualTransform

Manages an ordered set of TextualTransform objects. These can be applied in order to a given String.

Field Summary

static java.lang.String

CN

Fields inherited from class org.jostraca.util.SimpleObjectManager

DEFAULT_JAVA_PACKAGE, iClassList, iClassType, iDefaultJavaPackage, iObjects

Fields inherited from interface org.jostraca.transform.TextualTransform

ATTR_sectionset, ATTR_unit_attr, ATTR_unit_origin, ATTR_unit_set, NEWLINE

Constructor Summary

TextualTransformManager(java.lang.String pName)
Constructor.

Method Summary

void	activate(java.lang.String pTransformName)
void	deactivate(java.lang.String pTransformName)
java.lang.String	getName() Name of the transform
void	loadClasses(java.lang.String pClassList) Load classes specified by comma separated list.
boolean	needsReparse() Request a reparse of the From text, as a script marker was inserted
void	setParameters(PropertySet pPropertySet) Set the parameters, if any, that this transform uses.
void	setParameters(PropertySet pPropertySet, java.util.Hashtable pAttributes) Set the parameters, if any, that this transform uses.
java.lang.String	toString() Includes name, @see org.jostraca.util.SimpleObjectManager
java.lang.String	transform(java.lang.String pFrom) Transform the supplied String.

Methods inherited from class org.jostraca.util.SimpleObjectManager

append, contains, getDefaultJavaPackage, loadClasses, prepend, remove, setDefaultJavaPackage

Methods inherited from class java.lang.Object

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

Field Detail

CN

public static final java.lang.String CN

Constructor Detail

TextualTransformManager

public TextualTransformManager(java.lang.String pName)

Constructor. @see org.jostraca.util.SimpleObjectManager

Method Detail

transform

public java.lang.String transform(java.lang.String pFrom)
                           throws TransformException

Description copied from interface: TextualTransform

Transform the supplied String. Return Standard.EMPTY as default in case of failure.

Specified by:

transform in interface TextualTransform

Parameters:

pFrom - String to transform. Assume non null.

Throws:

TransformException

See Also:

TextualTransform.transform(java.lang.String)

setParameters

public void setParameters(PropertySet pPropertySet)
                   throws TransformException

Description copied from interface: TextualTransform

Set the parameters, if any, that this transform uses. Throw org.jostraca.transform.TextualTransformException if parameters are invalid.

Specified by:

setParameters in interface TextualTransform

Parameters:

pPropertySet - Parameters are taken from this PropertySet. Assume non null.

Throws:

TransformException

See Also:

TextualTransform

setParameters

public void setParameters(PropertySet pPropertySet,
                          java.util.Hashtable pAttributes)
                   throws TransformException

Description copied from interface: TextualTransform

Set the parameters, if any, that this transform uses. Throw org.jostraca.transform.TextualTransformException if parameters are invalid.

Specified by:

setParameters in interface TextualTransform

Parameters:

pPropertySet - parameters are taken from this PropertySet. Assume non null.

pAttributes - arbitrary parameter objects

Throws:

TransformException

See Also:

TextualTransform

needsReparse

public boolean needsReparse()

Description copied from interface: TextualTransform

Request a reparse of the From text, as a script marker was inserted

Specified by:

needsReparse in interface TextualTransform

getName

public java.lang.String getName()

Description copied from interface: TextualTransform

Name of the transform

Specified by:

getName in interface TextualTransform

deactivate

public void deactivate(java.lang.String pTransformName)

activate

public void activate(java.lang.String pTransformName)

loadClasses

public void loadClasses(java.lang.String pClassList)
                 throws TransformException

Description copied from class: SimpleObjectManager

Load classes specified by comma separated list. Note: classes in iDefaultJavaPackage do not need to be fully qualified.

Overrides:

loadClasses in class SimpleObjectManager

Parameters:

pClassList - Comma separated list of class names.

Throws:

TransformException

See Also:

SimpleObjectManager

toString

public java.lang.String toString()

Includes name, @see org.jostraca.util.SimpleObjectManager

Overrides:

toString in class SimpleObjectManager