ReceivingContentHandler (saxon8 JavaDoc)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.saxon.event
Class ReceivingContentHandler

java.lang.Object
  net.sf.saxon.event.ReceivingContentHandler

All Implemented Interfaces:: javax.xml.transform.SourceLocator, LocationProvider, SaxonLocator, SourceLocationProvider, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.Locator

Direct Known Subclasses:: IdentityTransformerHandler, TemplatesHandlerImpl, TransformerHandlerImpl

public class ReceivingContentHandler
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.DTDHandler, SaxonLocator, SourceLocationProvider
extends java.lang.Object
implements org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.DTDHandler, SaxonLocator, SourceLocationProvider

ReceivingContentHandler is a glue class that provides a standard SAX ContentHandler interface to a Saxon Receiver. To achieve this it needs to map names supplied as strings to numeric name codes, for which purpose it needs access to a name pool. The class also performs the function of assembling adjacent text nodes.

The class was previously named ContentEmitter.

Author:: Michael H. Kay

Constructor Summary
`ReceivingContentHandler()` create a ReceivingContentHandler and initialise variables

Method Summary
`void`	`characters(char[] ch, int start, int length)` Callback interface for SAX: not for application use
`void`	`comment(char[] ch, int start, int length)` Callback interface for SAX (part of LexicalHandler interface): not for application use
`void`	`endCDATA()`
`void`	`endDocument()` Callback interface for SAX: not for application use
`void`	`endDTD()` Register the end of the DTD.
`void`	`endElement(java.lang.String uri, java.lang.String localname, java.lang.String rawname)` Callback interface for SAX: not for application use
`void`	`endEntity(java.lang.String name)`
`void`	`endPrefixMapping(java.lang.String prefix)` Callback interface for SAX: not for application use
`int`	`getColumnNumber()` Return the character position where the current document event ends.
`Configuration`	`getConfiguration()`
`int`	`getLineNumber()` Return the line number where the current document event ends.
`int`	`getLineNumber(int locationId)` Get the line number within the document or module containing a particular location
`PipelineConfiguration`	`getPipelineConfiguration()`
`java.lang.String`	`getPublicId()` Return the public identifier for the current document event.
`java.lang.String`	`getSystemId()` Return the public identifier for the current document event.
`java.lang.String`	`getSystemId(int locationId)` Get the URI of the document or module containing a particular location
`void`	`ignorableWhitespace(char[] ch, int start, int length)` Callback interface for SAX: not for application use
`boolean`	`isIgnoringIgnorableWhitespace()` Determine whether "ignorable whitespace" is ignored.
`void`	`notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)`
`void`	`processingInstruction(java.lang.String name, java.lang.String remainder)` Callback interface for SAX: not for application use
`void`	`reset()` Set the ReceivingContentHandler to its initial state, except for the local name cache, which is retained
`void`	`setDocumentLocator(org.xml.sax.Locator locator)` Callback interface for SAX: not for application use
`void`	`setIgnoreIgnorableWhitespace(boolean ignore)` Set whether "ignorable whitespace" should be ignored.
`void`	`setPipelineConfiguration(PipelineConfiguration pipe)`
`void`	`setReceiver(Receiver e)`
`void`	`skippedEntity(java.lang.String name)`
`void`	`startCDATA()`
`void`	`startDocument()` Callback interface for SAX: not for application use
`void`	`startDTD(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` Register the start of the DTD.
`void`	`startElement(java.lang.String uri, java.lang.String localname, java.lang.String rawname, org.xml.sax.Attributes atts)` Callback interface for SAX: not for application use
`void`	`startEntity(java.lang.String name)`
`void`	`startPrefixMapping(java.lang.String prefix, java.lang.String uri)` Callback interface for SAX: not for application use
`void`	`unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

ReceivingContentHandler

public ReceivingContentHandler()

create a ReceivingContentHandler and initialise variables

Method Detail

reset

public void reset()

Set the ReceivingContentHandler to its initial state, except for the local name cache, which is retained

setReceiver

public void setReceiver(Receiver e)

setPipelineConfiguration

public void setPipelineConfiguration(PipelineConfiguration pipe)

getPipelineConfiguration

public PipelineConfiguration getPipelineConfiguration()

getConfiguration

public Configuration getConfiguration()

setIgnoreIgnorableWhitespace

public void setIgnoreIgnorableWhitespace(boolean ignore)

Set whether "ignorable whitespace" should be ignored. This method is effective only if called after setPipelineConfiguration, since the default value is taken from the configuration.

isIgnoringIgnorableWhitespace

public boolean isIgnoringIgnorableWhitespace()

Determine whether "ignorable whitespace" is ignored. This returns the value that was set using setIgnoreIgnorableWhitespace(boolean) if that has been called; otherwise the value from the configuration.