Package org.htmlcleaner

Class TagTransformation

java.lang.Object

org.htmlcleaner.TagTransformation

public class TagTransformation
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map	attributeTransformations
private java.lang.String	destTag
private boolean	preserveSourceAttributes
private java.lang.String	sourceTag

Constructor Summary

Constructors

Constructor	Description
TagTransformation(java.lang.String sourceTag)	Creates new tag transformation in which specified tag will be skipped (ignored) during parsing process.
TagTransformation(java.lang.String sourceTag, java.lang.String destTag)	Creates new tag transformation from source tag to target tag preserving all source tag attributes.
TagTransformation(java.lang.String sourceTag, java.lang.String destTag, boolean preserveSourceAttributes)	Creates new tag transformation from source tag to target tag specifying whether source tag attributes are preserved.

Method Summary

Modifier and Type	Method	Description
void	addAttributeTransformation(java.lang.String targetAttName)	Adds new attribute transformation in which destination attrbute will not exists (simply removes it from list of attributes).
void	addAttributeTransformation(java.lang.String targetAttName, java.lang.String transformationDesc)	Adds new attribute transformation to this tag transformation.
(package private) java.util.Map	getAttributeTransformations()
(package private) java.lang.String	getDestTag()
(package private) java.lang.String	getSourceTag()
(package private) boolean	hasAttributeTransformations()
(package private) boolean	isPreserveSourceAttributes()

Methods inherited from class java.lang.Object

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

Field Detail

sourceTag

private java.lang.String sourceTag

destTag

private java.lang.String destTag

preserveSourceAttributes

private boolean preserveSourceAttributes

attributeTransformations

private java.util.Map attributeTransformations

Constructor Detail

TagTransformation

public TagTransformation(java.lang.String sourceTag,
                         java.lang.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(java.lang.String sourceTag,
                         java.lang.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(java.lang.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(java.lang.String targetAttName,
                                       java.lang.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.

addAttributeTransformation

public void addAttributeTransformation(java.lang.String targetAttName)

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

Parameters:

targetAttName -

hasAttributeTransformations

boolean hasAttributeTransformations()

getSourceTag

java.lang.String getSourceTag()

getDestTag

java.lang.String getDestTag()

isPreserveSourceAttributes

boolean isPreserveSourceAttributes()

getAttributeTransformations

java.util.Map getAttributeTransformations()