| java.lang.Object
 net.sf.saxon.Filter
| Filter | | public class Filter implements XMLFilter(Code) | | Filter is an XMLFilter (a SAX2 filter) that performs a transformation
taking a SAX stream as input and producing a SAX stream as output.
author:
Michael H. Kay |
| Constructor Summary | |
| protected | Filter(Controller controller)
Create a Filter and initialise variables. |
| Method Summary | |
| public ContentHandler | getContentHandler()
| | public DTDHandler | getDTDHandler()
Return the current DTD handler. | | public EntityResolver | getEntityResolver()
Return the current entity resolver. | | public ErrorHandler | getErrorHandler()
Return the current error handler. | | public boolean | getFeature(String name)
Look up the value of a feature.
The feature name is any fully-qualified URI. | | public XMLReader | getParent()
Get the parent reader.
This method allows the application to query the parent
reader (which may be another filter). | | public Object | getProperty(String name)
Look up the value of a property.
The property name is any fully-qualified URI. | | public Transformer | getTransformer()
Get the underlying Transformer. | | public void | parse(InputSource input)
Parse an XML document - In the context of a Transformer, this means
perform a transformation. | | public void | parse(String systemId)
Parse (that is, transform) an XML document given a system identifier (URI).
This method is a shortcut for the common case of reading a
document from a system identifier. | | public void | setContentHandler(ContentHandler handler)
Register a content handler to receive the output of the transformation
filter. | | public void | setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event handler. | | public void | setEntityResolver(EntityResolver resolver)
Allow an application to register an entity resolver. | | public void | setErrorHandler(ErrorHandler handler)
Allow an application to register an error event handler.
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. | | public void | setFeature(String name, boolean value)
Set the state of a feature.
The feature name is any fully-qualified URI. | | public void | setParent(XMLReader parent)
Set the parent reader.
This method allows the application to link the filter to
a parent reader (which may be another filter). | | public void | setProperty(String name, Object value)
Set the value of a property.
The property name is any fully-qualified URI. |
| Filter | | protected Filter(Controller controller)(Code) | | Create a Filter and initialise variables. The constructor is protected, because
the Filter should be created using newXMLFilter() in the SAXTransformerFactory
class
|
| getContentHandler | | public ContentHandler getContentHandler()(Code) | | Get the ContentHandler registered using setContentHandler()
|
| getDTDHandler | | public DTDHandler getDTDHandler()(Code) | | Return the current DTD handler.
Always null, since no DTD handler is used even if one has beensupplied.
See Also: Filter.setDTDHandler |
| getFeature | | public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Look up the value of a feature.
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. The current state of the feature (true or false).
exception:
org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the feature name.
exception:
org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name butcannot determine its value at this time.
See Also: Filter.setFeature |
| getParent | | public XMLReader getParent()(Code) | | Get the parent reader.
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.
The parent filter, or null if none has been set. |
| getProperty | | public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Look up the value of a property.
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.
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. The current value of the property.
exception:
org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the property name.
exception:
org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name butcannot determine its value at this time.
See Also: Filter.setProperty |
| getTransformer | | public Transformer getTransformer()(Code) | | Get the underlying Transformer. This is a Saxon-specific method that allows the
user to set parameters on the transformation, set a URIResolver or ErrorListener, etc.
New in Saxon 7.2
|
| parse | | public void parse(String systemId) throws IOException, SAXException(Code) | | Parse (that is, transform) an XML document given a system identifier (URI).
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).
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
exception:
java.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application.
See Also: Filter.parse(org.xml.sax.InputSource) |
| setContentHandler | | public void setContentHandler(ContentHandler handler)(Code) | | Register a content handler to receive the output of the transformation
filter. If the content handler is also a LexicalHandler, and if no LexicalHandler
is separately registered, the ContentHandler will also act as the LexicalHandler
|
| setDTDHandler | | public void setDTDHandler(DTDHandler handler)(Code) | | Allow an application to register a DTD event handler.
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.
exception:
java.lang.NullPointerException - If the handlerargument is null.
See Also: Filter.getDTDHandler |
| setEntityResolver | | public void setEntityResolver(EntityResolver resolver)(Code) | | Allow an application to register an entity resolver.
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.
exception:
java.lang.NullPointerException - If the resolverargument is null.
See Also: Filter.getEntityResolver |
| setErrorHandler | | public void setErrorHandler(ErrorHandler handler)(Code) | | Allow an application to register an error event handler.
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.
exception:
java.lang.NullPointerException - If the handlerargument is null.
See Also: Filter.getErrorHandler |
| setFeature | | public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Set the state of a feature.
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
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.
Parameters:
value - The requested state of the feature (true or false).
exception:
org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the feature name.
exception:
org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name butcannot set the requested value.
See Also: Filter.getFeature |
| setParent | | public void setParent(XMLReader parent)(Code) | | Set the parent reader.
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). |
| setProperty | | public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException(Code) | | Set the value of a property.
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.
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.
Parameters:
value - The requested value for the property.
exception:
org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the property name.
exception:
org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name butcannot set the requested value. |
|
|