Java Doc for Filter.java in  » XML » saxonb » net » sf » saxon » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » saxonb » net.sf.saxon 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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  ContentHandlergetContentHandler()
    
public  DTDHandlergetDTDHandler()
     Return the current DTD handler.
public  EntityResolvergetEntityResolver()
     Return the current entity resolver.
public  ErrorHandlergetErrorHandler()
     Return the current error handler.
public  booleangetFeature(String name)
     Look up the value of a feature.

The feature name is any fully-qualified URI.

public  XMLReadergetParent()
     Get the parent reader.

This method allows the application to query the parent reader (which may be another filter).

public  ObjectgetProperty(String name)
     Look up the value of a property.

The property name is any fully-qualified URI.

public  TransformergetTransformer()
     Get the underlying Transformer.
public  voidparse(InputSource input)
     Parse an XML document - In the context of a Transformer, this means perform a transformation.
public  voidparse(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  voidsetContentHandler(ContentHandler handler)
     Register a content handler to receive the output of the transformation filter.
public  voidsetDTDHandler(DTDHandler handler)
     Allow an application to register a DTD event handler.
public  voidsetEntityResolver(EntityResolver resolver)
     Allow an application to register an entity resolver.
public  voidsetErrorHandler(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  voidsetFeature(String name, boolean value)
     Set the state of a feature.

The feature name is any fully-qualified URI.

public  voidsetParent(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  voidsetProperty(String name, Object value)
     Set the value of a property.

The property name is any fully-qualified URI.



Constructor Detail
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




Method Detail
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



getEntityResolver
public EntityResolver getEntityResolver()(Code)
Return the current entity resolver. Always null, since no entity resolver is used even if oneis supplied.
See Also:   Filter.setEntityResolver



getErrorHandler
public ErrorHandler getErrorHandler()(Code)
Return the current error handler. The current error handler, or null if nonehas been registered.
See Also:   Filter.setErrorHandler



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(InputSource input) throws IOException, SAXException(Code)
Parse an XML document - In the context of a Transformer, this means perform a transformation. The method is equivalent to transform().
Parameters:
  input - The input source (the XML document to be transformed)
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:   org.xml.sax.InputSource
See Also:   Filter.parse(java.lang.String)
See Also:   Filter.setEntityResolver
See Also:   Filter.setDTDHandler
See Also:   Filter.setContentHandler
See Also:   Filter.setErrorHandler



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.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.