com.icl.saxon
public class Filter extends Object implements XMLFilter
Field Summary | |
---|---|
ContentHandler | contentHandler |
Controller | controller |
LexicalHandler | lexicalHandler |
XMLReader | parser |
Constructor Summary | |
---|---|
protected | Filter(Controller controller)
Create a Filter and initialise variables. |
Method Summary | |
---|---|
ContentHandler | getContentHandler()
Get the ContentHandler registered using setContentHandler() |
DTDHandler | getDTDHandler()
Return the current DTD handler.
|
EntityResolver | getEntityResolver()
Return the current entity resolver.
|
ErrorHandler | getErrorHandler()
Return the current error handler.
|
boolean | getFeature(String name)
Look up the value of a feature.
|
XMLReader | getParent()
Get the parent reader.
|
Object | getProperty(String name)
Look up the value of a property.
|
void | parse(InputSource input)
"Parse an XML document." In the context of a Transformer, this means
perform a transformation. |
void | parse(String systemId)
Parse (i.e. transform) an XML document from a system identifier (URI).
|
void | setContentHandler(ContentHandler handler)
Register a content handler to receive the output of the transformation
filter. |
void | setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event handler.
|
void | setEntityResolver(EntityResolver resolver)
Allow an application to register an entity resolver.
|
void | setErrorHandler(ErrorHandler handler)
Allow an application to register an error event handler.
|
void | setFeature(String name, boolean value)
Set the state of a feature.
|
void | setParent(XMLReader parent)
Set the parent reader.
|
void | setProperty(String name, Object value)
Set the value of a property.
|
Returns: Always null, since no DTD handler is used even if one has been supplied.
See Also: Filter
Returns: Always null, since no entity resolver is used even if one is supplied.
See Also: Filter
Returns: The current error handler, or null if none has been registered.
See Also: Filter
The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.
All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.
Parameters: name The feature name, which is a fully-qualified URI.
Returns: The current state of the feature (true or false).
Throws: org.xml.sax.SAXNotRecognizedException When the XMLReader does not recognize the feature name. org.xml.sax.SAXNotSupportedException When the XMLReader recognizes the feature name but cannot determine its value at this time.
See Also: Filter
This method allows the application to query the parent reader (which may be another filter). It is generally a bad idea to perform any operations on the parent reader directly: they should all pass through this filter.
Returns: The parent filter, or null if none has been set.
The property name is any fully-qualified URI. It is
possible for an XMLReader to recognize a property name but
to be unable to return its state; this is especially true
in the case of an adapter for a SAX1 org.xml.sax.Parser
Parser
.
XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.
Some property values may be available only in specific contexts, such as before, during, or after a parse.
Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.
Parameters: name The property name, which is a fully-qualified URI.
Returns: The current value of the property.
Throws: org.xml.sax.SAXNotRecognizedException When the XMLReader does not recognize the property name. org.xml.sax.SAXNotSupportedException When the XMLReader recognizes the property name but cannot determine its value at this time.
See Also: Filter
Parameters: source The input source (the XML document to be transformed)
Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. java.io.IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also: org.xml.sax.InputSource Filter Filter Filter Filter Filter
This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:
parse(new InputSource(systemId));
If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.
Parameters: systemId The system identifier (URI).
Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. java.io.IOException An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also: Filter
If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
Parameters: handler The DTD handler.
Throws: java.lang.NullPointerException If the handler argument is null.
See Also: Filter
If the application does not register an entity resolver, the XMLReader will perform its own default resolution.
Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.
Parameters: resolver The entity resolver.
Throws: java.lang.NullPointerException If the resolver argument is null.
See Also: Filter
If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.
Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.
Parameters: handler The error handler.
Throws: java.lang.NullPointerException If the handler argument is null.
See Also: Filter
The feature name is any fully-qualified URI. It is
possible for an XMLReader to recognize a feature name but
to be unable to set its value; this is especially true
in the case of an adapter for a SAX1 org.xml.sax.Parser Parser
,
which has no way of affecting whether the underlying parser is
validating, for example.
All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.
Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
Parameters: name The feature name, which is a fully-qualified URI. state The requested state of the feature (true or false).
Throws: org.xml.sax.SAXNotRecognizedException When the XMLReader does not recognize the feature name. org.xml.sax.SAXNotSupportedException When the XMLReader recognizes the feature name but cannot set the requested value.
See Also: Filter
This method allows the application to link the filter to a parent reader (which may be another filter). The argument may not be null.
Parameters: parent The parent reader (the supplier of SAX events).
The property name is any fully-qualified URI. It is
possible for an XMLReader to recognize a property name but
to be unable to set its value; this is especially true
in the case of an adapter for a SAX1 org.xml.sax.Parser
Parser
.
XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.
Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.
This method is also the standard mechanism for setting extended handlers.
Parameters: name The property name, which is a fully-qualified URI. state The requested value for the property.
Throws: org.xml.sax.SAXNotRecognizedException When the XMLReader does not recognize the property name. org.xml.sax.SAXNotSupportedException When the XMLReader recognizes the property name but cannot set the requested value.