org.htmlcleaner
Class TagTransformation

java.lang.Object
  org.htmlcleaner.TagTransformation

public class TagTransformation
extends Object

Describes how specified tag is transformed to another one, or is ignored during parsing

Field Summary

static String	VAR_END
static String	VAR_START

Constructor Summary

TagTransformation()

TagTransformation(String sourceTag)
Creates new tag transformation in which specified tag will be skipped (ignored) during parsing process.

TagTransformation(String sourceTag, String destTag)
Creates new tag transformation from source tag to target tag preserving all source tag attributes.

TagTransformation(String sourceTag, String destTag, boolean preserveSourceAttributes)
Creates new tag transformation from source tag to target tag specifying whether source tag attributes are preserved.

Method Summary

void	addAttributePatternTransformation(AttributeTransformation attributeTransformation)
void	addAttributePatternTransformation(Pattern attNamePattern, Pattern attValuePattern, String transformationDesc)
void	addAttributePatternTransformation(Pattern attNamePattern, String transformationDesc)
void	addAttributeTransformation(String targetAttName) Adds new attribute transformation in which destination attrbute will not exists (simply removes it from list of attributes).
void	addAttributeTransformation(String targetAttName, String transformationDesc) Adds new attribute transformation to this tag transformation.
Map<String,String>	applyTagTransformations(Map<String,String> attributes)
String	evaluateTemplate(String template, Map<String,String> variables) Evaluates string template for specified map of variables.

Methods inherited from class java.lang.Object

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

Field Detail

VAR_START

public static String VAR_START

VAR_END

public static String VAR_END

Constructor Detail

TagTransformation

public TagTransformation()

TagTransformation

public TagTransformation(String sourceTag,
                         String destTag,
                         boolean preserveSourceAttributes)

Creates new tag transformation from source tag to target tag specifying whether source tag attributes are preserved.

Parameters:

sourceTag - Name of the tag to be transformed.

destTag - Name of tag to which source tag is to be transformed.

preserveSourceAttributes - Tells whether source tag attributes are preserved in transformation.

TagTransformation

public TagTransformation(String sourceTag,
                         String destTag)

Creates new tag transformation from source tag to target tag preserving all source tag attributes.

Parameters:

sourceTag - Name of the tag to be transformed.

destTag - Name of tag to which source tag is to be transformed.

TagTransformation

public TagTransformation(String sourceTag)

Creates new tag transformation in which specified tag will be skipped (ignored) during parsing process.

Parameters:

sourceTag -

Method Detail

addAttributeTransformation

public void addAttributeTransformation(String targetAttName,
                                       String transformationDesc)

Adds new attribute transformation to this tag transformation. It tells how destination attribute will look like. Small templating mechanism is used to describe attribute value: all names between ${ and } inside the template are evaluated against source tag attributes. That way one can make attribute values consist of mix of source tag attributes.

Parameters:

targetAttName - Name of the destination attribute

transformationDesc - Template describing attribute value.

addAttributePatternTransformation

public void addAttributePatternTransformation(Pattern attNamePattern,
                                              String transformationDesc)

addAttributePatternTransformation

public void addAttributePatternTransformation(Pattern attNamePattern,
                                              Pattern attValuePattern,
                                              String transformationDesc)

addAttributePatternTransformation

public void addAttributePatternTransformation(AttributeTransformation attributeTransformation)

Parameters:

attributeTransformation -

addAttributeTransformation

public void addAttributeTransformation(String targetAttName)

Adds new attribute transformation in which destination attrbute will not exists (simply removes it from list of attributes).

Parameters:

targetAttName -

applyTagTransformations

public Map<String,String> applyTagTransformations(Map<String,String> attributes)

Parameters:

attributes -

evaluateTemplate

public String evaluateTemplate(String template,
                               Map<String,String> variables)

Evaluates string template for specified map of variables. Template string can contain dynamic parts in the form of ${VARNAME}. Each such part is replaced with value of the variable if such exists in the map, or with empty string otherwise.

Parameters:

template - Template string

variables - Map of variables (can be null)

Returns:

Evaluated string