Package eu.bandm.tools.util.xml

Class SaxLocatorMapper

java.lang.Object

eu.bandm.tools.util.xml.ContentProxy

eu.bandm.tools.util.xml.SaxLocatorMapper

All Implemented Interfaces:

ContentHandler

public class SaxLocatorMapper
extends ContentProxy

Replaces all setDocumentLocator(Locator) SAX calls by an intercepting Locator, which re-maps location info according to the LocationMap,

In SAX, normally a parser invokes this method on the consumer to tell it where to get the location info by active inquiry. This consumer intercepts this call and substitutes a new Locator which prepends the mapping of the locations.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Opt Location<XMLDocumentIdentifier>	cache	Cache for the location of the very last SAX event.
(package private) @Opt Locator	incomingLocs	Set by the intercepted "setDocumentLocator" call.
(package private) final LocationMap<XMLDocumentIdentifier,XMLDocumentIdentifier>	map	The mapping to apply to the SAX location info.
protected final Locator	newlocs	The visible locator which will be inquired by the SAX consumer for the mapped location info.
static final int	NO_NUMBER_AVAILABLE	Evident
static final @Opt String	NO_PUB_ID_AVAILABLE	Evident
static final String	NO_SYS_ID_AVAILABLE	Evident
(package private) final boolean	robust	If failed attempt to map returns a "value unknown" data instead of an Exception.

Fields inherited from class eu.bandm.tools.util.xml.ContentProxy

out

Constructor Summary

Constructors

Constructor	Description
SaxLocatorMapper(LocationMap<XMLDocumentIdentifier,XMLDocumentIdentifier> map, boolean robust, ContentHandler out)	Only constructor.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int end)
void	endDocument()
void	endElement(String uri, String localName, String qName)
void	endPrefixMapping(String prefix)
void	ignorableWhitespace(char[] ch, int start, int end)
protected void	invalidate()	Internally called with every SAX event which changes the location info.
void	processingInstruction(String target, String data)
void	setDocumentLocator(@Opt Locator loc)	Intercept the call of the SAX supplier, which declares the target of all location inquiry method invocations, and stores it locally.
void	skippedEntity(String name)
void	startDocument()
void	startElement(String uri, String localName, String qName, Attributes attrs)
void	startPrefixMapping(String prefix, String uri)
protected void	updateCache()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

map

final LocationMap<XMLDocumentIdentifier,XMLDocumentIdentifier> map

The mapping to apply to the SAX location info.

robust

final boolean robust

If failed attempt to map returns a "value unknown" data instead of an Exception.

incomingLocs

@Opt
@Opt Locator incomingLocs

Set by the intercepted "setDocumentLocator" call.

cache

@Opt
@Opt Location<XMLDocumentIdentifier> cache

Cache for the location of the very last SAX event.

NO_NUMBER_AVAILABLE

public static final int NO_NUMBER_AVAILABLE

Evident

See Also:

• Constant Field Values

NO_SYS_ID_AVAILABLE

public static final String NO_SYS_ID_AVAILABLE

Evident

See Also:

• Constant Field Values

NO_PUB_ID_AVAILABLE

@Opt
public static final @Opt String NO_PUB_ID_AVAILABLE

Evident

newlocs

protected final Locator newlocs

The visible locator which will be inquired by the SAX consumer for the mapped location info.

Constructor Details

SaxLocatorMapper

public SaxLocatorMapper(LocationMap<XMLDocumentIdentifier,XMLDocumentIdentifier> map,
 boolean robust,
 ContentHandler out)

Only constructor. Calls to setDocumentLocator(Locator) are intercepted and the info inquired from this locator is mapped according to map whenever the locator proxy (as passed to ContentProxy.out) is asked for a position.

Parameters:

robust - whether the failure of a mapping attempt simply returns "no info" instead of throwing an IllegalArgumentException.

Method Details

invalidate

protected void invalidate()

Internally called with every SAX event which changes the location info.

updateCache

protected void updateCache()

characters

public void characters(char[] ch,
 int start,
 int end)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class ContentProxy

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class ContentProxy

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class ContentProxy

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class ContentProxy

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int end)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class ContentProxy

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
 String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class ContentProxy

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(@Opt
 @Opt Locator loc)

Intercept the call of the SAX supplier, which declares the target of all location inquiry method invocations, and stores it locally. It is asked whenever the visible Locator is asked for a re-mapped location.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class ContentProxy

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Overrides:

skippedEntity in class ContentProxy

Throws:

SAXException

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class ContentProxy

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attrs)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class ContentProxy

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class ContentProxy

Throws:

SAXException