org.jostraca.transform
Class ReplaceTransform

java.lang.Object
  org.jostraca.transform.TextualTransformSupport
      org.jostraca.transform.ReplaceTransform

All Implemented Interfaces:

TextualTransform

Direct Known Subclasses:

ReplaceRegExpTransform

public class ReplaceTransform

extends TextualTransformSupport

Description:
Perform text substitutions in the template text.

Nested Class Summary

class

ReplaceTransform.Replacement

Field Summary

protected java.util.Vector	iReplacements
static java.lang.String	MODIFIER_first
static java.lang.String	NAME

Fields inherited from class org.jostraca.transform.TextualTransformSupport

iAttributes, iNeedsReparse, iOpenScriptMarker

Fields inherited from interface org.jostraca.transform.TextualTransform

ATTR_sectionset, ATTR_unit_attr, ATTR_unit_origin, ATTR_unit_set, NEWLINE

Constructor Summary

ReplaceTransform()

Method Summary

void	addReplacement(java.lang.String pFrom, java.lang.String pTo)
void	addReplacement(java.lang.String pFrom, java.lang.String pTo, java.lang.String pModifier)
void	clean()
java.lang.String	getName() Name of the transform
protected ReplaceTransform.Replacement	makeReplacement(java.lang.String pFrom, java.lang.String pTo, java.lang.String pModifier)
protected void	sortReplacements()
java.lang.String	toString()
java.lang.String	transform(java.lang.String pFrom) Transform the supplied String.

Methods inherited from class org.jostraca.transform.TextualTransformSupport

checkForReparse, needsReparse, setParameters, setParameters, setParametersImpl

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

MODIFIER_first

public static final java.lang.String MODIFIER_first

See Also:

Constant Field Values

iReplacements

protected java.util.Vector iReplacements

Constructor Detail

ReplaceTransform

public ReplaceTransform()

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

Specified by:

transform in class TextualTransformSupport

Throws:

TransformException

See Also:

TextualTransform

getName

public java.lang.String getName()

Description copied from interface: TextualTransform

Name of the transform

Specified by:

getName in interface TextualTransform

Overrides:

getName in class TextualTransformSupport

clean

public void clean()

addReplacement

public void addReplacement(java.lang.String pFrom,
                           java.lang.String pTo)
                    throws TransformException

Throws:

TransformException

addReplacement

public void addReplacement(java.lang.String pFrom,
                           java.lang.String pTo,
                           java.lang.String pModifier)
                    throws TransformException

Throws:

TransformException

toString

public java.lang.String toString()

makeReplacement

protected ReplaceTransform.Replacement makeReplacement(java.lang.String pFrom,
                                                       java.lang.String pTo,
                                                       java.lang.String pModifier)
                                                throws TransformException

Throws:

TransformException

sortReplacements

protected void sortReplacements()