com.raritantechnologies.xml.sax.filter.comparators
Class TagComparator

java.lang.Object
  com.raritantechnologies.xml.sax.filter.comparators.TagComparator

All Implemented Interfaces:

ElementComparator

public class TagComparator

extends java.lang.Object

implements ElementComparator

Implementation of ElementComparator that matches on the tag Name. "Remembers" the path at match time so that the ProgrammableSAXFilter can match start and end events.

XML Configuration Template:

    <Comparator class="com.raritantechnologies.xml.sax.filter.comparators.TagComparator" >
      <TagName>[ tag name to match ]</TagName>
    </Comparator>
  

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

static boolean

INCLUDE_CHILDREN

Constructor Summary

TagComparator()

TagComparator(java.lang.String tagName)

TagComparator(java.lang.String tagName, boolean includeChildren)

Method Summary

void	initialize(org.w3c.dom.Element compElem)
boolean	matchesData(char[] data, int start, int length) Checks if the character data matches the criteria of this comparator.
boolean	matchesPath(java.lang.String path) Checks if the XML tag at the specified path matches the criteria of this comparator.
boolean	matchesTag(java.lang.String path, org.xml.sax.Attributes atts) Checks if the XML tag at the specified path with given attribute list matches the criteria of this comparator.
boolean	needsData() Checks if this comparator needs to see the data section to make a decision.
void	setTagName(java.lang.String tagName)

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDE_CHILDREN

public static final boolean INCLUDE_CHILDREN

See Also:

Constant Field Values

Constructor Detail

TagComparator

public TagComparator()

TagComparator

public TagComparator(java.lang.String tagName)

TagComparator

public TagComparator(java.lang.String tagName,
                     boolean includeChildren)

Method Detail

setTagName

public void setTagName(java.lang.String tagName)

matchesTag

public boolean matchesTag(java.lang.String path,
                          org.xml.sax.Attributes atts)

Description copied from interface: ElementComparator

Checks if the XML tag at the specified path with given attribute list matches the criteria of this comparator.

Specified by:

matchesTag in interface ElementComparator

Parameters:

path - XML path to the element.

atts - Attribute list of the element.

Returns:

true if parameters match criteria of this comparator, false otherwise.

matchesPath

public boolean matchesPath(java.lang.String path)

Description copied from interface: ElementComparator

Checks if the XML tag at the specified path matches the criteria of this comparator.

Specified by:

matchesPath in interface ElementComparator

Parameters:

path - XML path to the element.

Returns:

true if path matches criteria of this comparator, false otherwise.

needsData

public boolean needsData()

Description copied from interface: ElementComparator

Checks if this comparator needs to see the data section to make a decision.

Specified by:

needsData in interface ElementComparator

Returns:

true if this comparator requires character data to match, false otherwise.

matchesData

public boolean matchesData(char[] data,
                           int start,
                           int length)

Description copied from interface: ElementComparator

Checks if the character data matches the criteria of this comparator.

Specified by:

matchesData in interface ElementComparator

Parameters:

data - source character array.

start - start position of source characters.

length - number of source characters.

Returns:

true if data matches criteria of this comparator, false otherwise.

initialize

public void initialize(org.w3c.dom.Element compElem)

Specified by:

initialize in interface ElementComparator