com.raritantechnologies.xml.sax.filter.replacers
Class AbstractElementReplacer

java.lang.Object
  com.raritantechnologies.xml.sax.filter.replacers.AbstractElementReplacer

All Implemented Interfaces:

org.xml.sax.ContentHandler, ElementComparator, ElementReplacer, IConfigurable

Direct Known Subclasses:

DOMElementReplacer, ElementRemover, ElementTagRemover, SAXElementReplacer, StringElementReplacer, StringFilterElementReplacer

public abstract class AbstractElementReplacer

extends java.lang.Object

implements ElementReplacer

Base class for objects implementing the ElementReplacer interface that plug in to the Raritan ProgrammableSAXFilter to provide replace XML tags "on the fly".

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

AbstractElementReplacer()

AbstractElementReplacer(ElementComparator comp)

Method Summary

void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
void	ignorableWhitespace(char[] ch, int start, int length)
void	initialize(org.w3c.dom.Element elem) subclasses should override this to do XML initialization.
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	processingInstruction(java.lang.String target, java.lang.String data)
void	setDocumentLocator(org.xml.sax.Locator locator)
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.raritantechnologies.xml.sax.filter.ElementReplacer

elementEnding, elementStarting

Constructor Detail

AbstractElementReplacer

public AbstractElementReplacer()

AbstractElementReplacer

public AbstractElementReplacer(ElementComparator comp)

Method Detail

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.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

initialize

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

subclasses should override this to do XML initialization.

Specified by:

initialize in interface ElementComparator