org.jostraca.transform
Interface TextualTransform

All Known Implementing Classes:

TextualTransformManager, TextualTransformSupport

public interface TextualTransform

A textual tranformation is unary operation on a block of text which returns the block of text modified in some way. For example: the perl subsitution regexp: s/a/b/g which transforms all 'a's into 'b's.

Field Summary

static java.lang.String	ATTR_sectionset
static java.lang.String	ATTR_unit_attr
static java.lang.String	ATTR_unit_origin
static java.lang.String	ATTR_unit_set
static java.lang.String	NEWLINE

Method Summary

java.lang.String	getName() Name of the transform
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	transform(java.lang.String pFrom) Transform the supplied String.

Field Detail

NEWLINE

public static final java.lang.String NEWLINE

See Also:

Constant Field Values

ATTR_unit_origin

public static final java.lang.String ATTR_unit_origin

See Also:

Constant Field Values

ATTR_unit_attr

public static final java.lang.String ATTR_unit_attr

See Also:

Constant Field Values

ATTR_unit_set

public static final java.lang.String ATTR_unit_set

See Also:

Constant Field Values

ATTR_sectionset

public static final java.lang.String ATTR_sectionset

See Also:

Constant Field Values

Method Detail

transform

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

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

Parameters:

pFrom - String to transform. Assume non null.

Throws:

TransformException

setParameters

public void setParameters(PropertySet pPropertySet)
                   throws TransformException

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

Parameters:

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

Throws:

TransformException

setParameters

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

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

Parameters:

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

pAttributes - arbitrary parameter objects

Throws:

TransformException

needsReparse

public boolean needsReparse()

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

getName

public java.lang.String getName()

Name of the transform