|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.saxon.Filter
public class Filter
Filter is an XMLFilter (a SAX2 filter) that performs a transformation taking a SAX stream as input and producing a SAX stream as output.
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. |
Transformer |
getTransformer()
Get the underlying Transformer. |
void |
parse(InputSource input)
Parse an XML document - In the context of a Transformer, this means perform a transformation. |
void |
parse(String systemId)
Parse (that is, transform) an XML document given 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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Filter(Controller controller)
Method Detail |
---|
public void setParent(XMLReader parent)
This method allows the application to link the filter to a parent reader (which may be another filter). The argument may not be null.
setParent
in interface XMLFilter
parent
- The parent reader (the supplier of SAX events).public XMLReader getParent()
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.
getParent
in interface XMLFilter
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException
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.
getFeature
in interface XMLReader
name
- The feature name, which is a fully-qualified URI.
SAXNotRecognizedException
- When the
XMLReader does not recognize the feature name.
SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot determine its value at this time.setFeature(java.lang.String, boolean)
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException
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.
setFeature
in interface XMLReader
name
- The feature name, which is a fully-qualified URI.value
- The requested state of the feature (true or false).
SAXNotRecognizedException
- When the
XMLReader does not recognize the feature name.
SAXNotSupportedException
- When the
XMLReader recognizes the feature name but
cannot set the requested value.getFeature(java.lang.String)
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException
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.
getProperty
in interface XMLReader
name
- The property name, which is a fully-qualified URI.
SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.
SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot determine its value at this time.setProperty(java.lang.String, java.lang.Object)
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException
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.
setProperty
in interface XMLReader
name
- The property name, which is a fully-qualified URI.value
- The requested value for the property.
SAXNotRecognizedException
- When the
XMLReader does not recognize the property name.
SAXNotSupportedException
- When the
XMLReader recognizes the property name but
cannot set the requested value.public void setContentHandler(ContentHandler handler)
setContentHandler
in interface XMLReader
public ContentHandler getContentHandler()
getContentHandler
in interface XMLReader
public void setEntityResolver(EntityResolver 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.
setEntityResolver
in interface XMLReader
resolver
- The entity resolver.
NullPointerException
- If the resolver
argument is null.getEntityResolver()
public EntityResolver getEntityResolver()
getEntityResolver
in interface XMLReader
setEntityResolver(org.xml.sax.EntityResolver)
public void setDTDHandler(DTDHandler 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.
setDTDHandler
in interface XMLReader
handler
- The DTD handler.
NullPointerException
- If the handler
argument is null.getDTDHandler()
public DTDHandler getDTDHandler()
getDTDHandler
in interface XMLReader
setDTDHandler(org.xml.sax.DTDHandler)
public void setErrorHandler(ErrorHandler 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.
setErrorHandler
in interface XMLReader
handler
- The error handler.
NullPointerException
- If the handler
argument is null.getErrorHandler()
public ErrorHandler getErrorHandler()
getErrorHandler
in interface XMLReader
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(InputSource input) throws IOException, SAXException
parse
in interface XMLReader
input
- The input source (the XML document to be transformed)
SAXException
- Any SAX exception, possibly
wrapping another exception.
IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.InputSource
,
parse(java.lang.String)
,
setEntityResolver(org.xml.sax.EntityResolver)
,
setDTDHandler(org.xml.sax.DTDHandler)
,
setContentHandler(org.xml.sax.ContentHandler)
,
setErrorHandler(org.xml.sax.ErrorHandler)
public void parse(String systemId) throws IOException, SAXException
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.
parse
in interface XMLReader
systemId
- The system identifier (URI).
SAXException
- Any SAX exception, possibly
wrapping another exception.
IOException
- An IO exception from the parser,
possibly from a byte stream or character stream
supplied by the application.parse(org.xml.sax.InputSource)
public Transformer getTransformer()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |