Java Doc for SAX2FilterImpl.java in  » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » utils » 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 » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal.utils 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jasig.portal.utils.SAX2FilterImpl

All known Subclasses:   org.jasig.portal.CharacterCachingChannelIncorporationFilter,  org.jasig.portal.StructureAttributesIncorporationFilter,  org.jasig.portal.utils.SAXDocumentFilter,  org.jasig.portal.layout.immutable.ImmutableUserLayoutSAXFilter,  org.jasig.portal.utils.SAX2BufferImpl,  org.jasig.portal.utils.AbsoluteURLFilter,  org.jasig.portal.utils.SAX2DuplicatingFilterImpl,  org.jasig.portal.ThemeAttributesIncorporationFilter,  org.jasig.portal.StylesheetSet,  org.jasig.portal.ChannelSAXStreamFilter,  org.jasig.portal.ChannelIncorporationFilter,  org.jasig.portal.channels.webproxy.CWebProxyURLFilter,
SAX2FilterImpl
public class SAX2FilterImpl implements XMLFilter,EntityResolver,DTDHandler,ContentHandler,ErrorHandler,LexicalHandler(Code)
This is a remake of org.xml.sax.helpers.XMLFilterImpl that allows for downward chaining of LexicalHandlers, and further extensions.

Some of the behavior is slightly different from that of hte XMLFilterImpl. For example this implementation allows to set null handlers. It also redirects parent's handlers right after instantiation or setParent() invokation, not just at the parse().


See Also:   org.xml.sax.helpers.XMLFilterImpl


Field Summary
protected  ContentHandlercontentHandler
    
protected  DTDHandlerdtdHandler
    
protected  EntityResolverentityResolver
    
protected  ErrorHandlererrorHandler
    
protected  LexicalHandlerlexicalHandler
    
protected  Locatorlocator
    
final protected  Loglog
    

Constructor Summary
public  SAX2FilterImpl()
     Construct an empty XML filter, with no parent.
public  SAX2FilterImpl(XMLReader parent)
     Construct an XML filter with the specified parent.
public  SAX2FilterImpl(ContentHandler ch, EntityResolver er, ErrorHandler eh, LexicalHandler lh, DTDHandler dh)
     Construct an XML filter with the specified children handlers.
public  SAX2FilterImpl(ContentHandler ch)
     Try to imply all of the handlers from ContentHandler alone.

Method Summary
public  voidcharacters(char ch, int start, int length)
     Filter a character data event.
public  voidcomment(char ch, int start, int length)
     Filter comment event.
public  voidendCDATA()
     Filter endCDATA event.
public  voidendDTD()
    
public  voidendDocument()
     Filter an end document event.
public  voidendElement(String uri, String localName, String qName)
     Filter an end element event.
public  voidendEntity(String name)
     Filter endEntity event.
public  voidendPrefixMapping(String prefix)
     Filter an end Namespace prefix mapping event.
public  voiderror(SAXParseException e)
     Filter an error event.
public  voidfatalError(SAXParseException e)
     Filter a fatal error event.
public  ContentHandlergetContentHandler()
     Get the content event handler.
public  DTDHandlergetDTDHandler()
     Get the current DTD event handler.
public  EntityResolvergetEntityResolver()
     Get the current entity resolver.
public  ErrorHandlergetErrorHandler()
     Get the current error event handler.
public  booleangetFeature(String name)
     Look up the state of a feature.

This will always fail if the parent is null.


Parameters:
  name - The feature name.
public  XMLReadergetParent()
     Get the parent reader.
public  ObjectgetProperty(String name)
     Look up the value of a property.
Parameters:
  name - The property name.
public  voidignorableWhitespace(char ch, int start, int length)
     Filter an ignorable whitespace event.
public  voidnotationDecl(String name, String publicId, String systemId)
     Filter a notation declaration event.
public  voidparse(InputSource input)
     Parse a document.
public  voidparse(String systemId)
     Parse a document.
public  voidprocessingInstruction(String target, String data)
     Filter a processing instruction event.
public  InputSourceresolveEntity(String publicId, String systemId)
     Filter an external entity resolution.
Parameters:
  publicId - The entity's public identifier, or null.
Parameters:
  systemId - The entity's system identifier.
public  voidsetAllHandlers(ContentHandler ch)
     Try to imply all of the handlers from ContentHandler alone.
public  voidsetContentHandler(ContentHandler handler)
     Set the content event handler.
public  voidsetDTDHandler(DTDHandler handler)
     Set the DTD event handler.
public  voidsetDocumentLocator(Locator locator)
     Filter a new document locator event.
public  voidsetEntityResolver(EntityResolver resolver)
     Set the entity resolver.
public  voidsetErrorHandler(ErrorHandler handler)
     Set the error event handler.
public  voidsetFeature(String name, boolean state)
     Set the state of a feature.
public  voidsetLexicalHandler(LexicalHandler handler)
     Set the lexical handler.
public  voidsetParent(XMLReader parent)
     Set the parent reader.

This is the org.xml.sax.XMLReader XMLReader from which this filter will obtain its events and to which it will pass its configuration requests.

public  voidsetProperty(String name, Object value)
     Set the value of a property.
public  voidskippedEntity(String name)
     Filter a skipped entity event.
public  voidstartCDATA()
     Filter startCDATA event.
public  voidstartDTD(String name, String publicId, String systemId)
     Filter startDTD event.
public  voidstartDocument()
     Filter a start document event.
public  voidstartElement(String uri, String localName, String qName, Attributes atts)
     Filter a start element event.
public  voidstartEntity(String name)
     Filter startEntity event.
Parameters:
  name - The name of the entity.
public  voidstartPrefixMapping(String prefix, String uri)
     Filter a start Namespace prefix mapping event.
public  voidunparsedEntityDecl(String name, String publicId, String systemId, String notationName)
     Filter an unparsed entity declaration event.
public  voidwarning(SAXParseException e)
     Filter a warning event.

Field Detail
contentHandler
protected ContentHandler contentHandler(Code)



dtdHandler
protected DTDHandler dtdHandler(Code)



entityResolver
protected EntityResolver entityResolver(Code)



errorHandler
protected ErrorHandler errorHandler(Code)



lexicalHandler
protected LexicalHandler lexicalHandler(Code)



locator
protected Locator locator(Code)



log
final protected Log log(Code)




Constructor Detail
SAX2FilterImpl
public SAX2FilterImpl()(Code)
Construct an empty XML filter, with no parent.

This filter will have no parent: you must assign a parent before you start a parse or do any configuration with setFeature or setProperty.


See Also:   org.xml.sax.XMLReader.setFeature
See Also:   org.xml.sax.XMLReader.setProperty



SAX2FilterImpl
public SAX2FilterImpl(XMLReader parent)(Code)
Construct an XML filter with the specified parent.
See Also:   SAX2FilterImpl.setParent
See Also:   SAX2FilterImpl.getParent



SAX2FilterImpl
public SAX2FilterImpl(ContentHandler ch, EntityResolver er, ErrorHandler eh, LexicalHandler lh, DTDHandler dh)(Code)
Construct an XML filter with the specified children handlers.
See Also:   SAX2FilterImpl.setContentHandler
See Also:   SAX2FilterImpl.setDTDHandler
See Also:   SAX2FilterImpl.setErrorHandler
See Also:   SAX2FilterImpl.setEntityResolver
See Also:   SAX2FilterImpl.setLexicalHandler



SAX2FilterImpl
public SAX2FilterImpl(ContentHandler ch)(Code)
Try to imply all of the handlers from ContentHandler alone.




Method Detail
characters
public void characters(char ch, int start, int length) throws SAXException(Code)
Filter a character data event.
Parameters:
  ch - An array of characters.
Parameters:
  start - The starting position in the array.
Parameters:
  length - The number of characters to use from the array.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.characters



comment
public void comment(char ch, int start, int length) throws SAXException(Code)
Filter comment event.
Parameters:
  ch - An array holding the characters in the comment.
Parameters:
  start - The starting position in the array.
Parameters:
  length - The number of characters to use from the array.
exception:
  SAXException - The application may raise an exception.



endCDATA
public void endCDATA() throws SAXException(Code)
Filter endCDATA event.
exception:
  SAXException - The application may raise an exception.
See Also:   SAX2FilterImpl.startCDATA



endDTD
public void endDTD() throws SAXException(Code)
Filter endDTD event
exception:
  SAXException - The application may raise an exception.
See Also:   SAX2FilterImpl.startDTD



endDocument
public void endDocument() throws SAXException(Code)
Filter an end document event.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.endDocument



endElement
public void endElement(String uri, String localName, String qName) throws SAXException(Code)
Filter an end element event.
Parameters:
  uri - The element's Namespace URI, or the empty string.
Parameters:
  localName - The element's local name, or the empty string.
Parameters:
  qName - The element's qualified (prefixed) name, or the emptystring.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.endElement



endEntity
public void endEntity(String name) throws SAXException(Code)
Filter endEntity event.
Parameters:
  name - The name of the entity that is ending.
exception:
  SAXException - The application may raise an exception.
See Also:   SAX2FilterImpl.startEntity



endPrefixMapping
public void endPrefixMapping(String prefix) throws SAXException(Code)
Filter an end Namespace prefix mapping event.
Parameters:
  prefix - The Namespace prefix.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.endPrefixMapping



error
public void error(SAXParseException e) throws SAXException(Code)
Filter an error event.
Parameters:
  e - The error as an exception.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ErrorHandler.error



fatalError
public void fatalError(SAXParseException e) throws SAXException(Code)
Filter a fatal error event.
Parameters:
  e - The error as an exception.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ErrorHandler.fatalError



getContentHandler
public ContentHandler getContentHandler()(Code)
Get the content event handler. The current content handler, or null if none was set.
See Also:   org.xml.sax.XMLReader.getContentHandler



getDTDHandler
public DTDHandler getDTDHandler()(Code)
Get the current DTD event handler. The current DTD handler, or null if none was set.
See Also:   org.xml.sax.XMLReader.getDTDHandler



getEntityResolver
public EntityResolver getEntityResolver()(Code)
Get the current entity resolver. The current entity resolver, or null if none was set.
See Also:   org.xml.sax.XMLReader.getEntityResolver



getErrorHandler
public ErrorHandler getErrorHandler()(Code)
Get the current error event handler. The current error handler, or null if none was set.
See Also:   org.xml.sax.XMLReader.getErrorHandler



getFeature
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Look up the state of a feature.

This will always fail if the parent is null.


Parameters:
  name - The feature name. The current state of the feature.
exception:
  org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the feature name.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot determine its state at this time.
See Also:   org.xml.sax.XMLReader.getFeature



getParent
public XMLReader getParent()(Code)
Get the parent reader. The parent XML reader, or null if none is set.
See Also:   SAX2FilterImpl.setParent



getProperty
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Look up the value of a property.
Parameters:
  name - The property name. The current value of the property.
exception:
  org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the feature name.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot determine its value at this time.
See Also:   org.xml.sax.XMLReader.setFeature



ignorableWhitespace
public void ignorableWhitespace(char ch, int start, int length) throws SAXException(Code)
Filter an ignorable whitespace event.
Parameters:
  ch - An array of characters.
Parameters:
  start - The starting position in the array.
Parameters:
  length - The number of characters to use from the array.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.ignorableWhitespace



notationDecl
public void notationDecl(String name, String publicId, String systemId) throws SAXException(Code)
Filter a notation declaration event.
Parameters:
  name - The notation name.
Parameters:
  publicId - The notation's public identifier, or null.
Parameters:
  systemId - The notation's system identifier, or null.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.DTDHandler.notationDecl



parse
public void parse(InputSource input) throws SAXException, IOException(Code)
Parse a document.
Parameters:
  input - The input source for the document entity.
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.XMLReader.parse(org.xml.sax.InputSource)



parse
public void parse(String systemId) throws SAXException, IOException(Code)
Parse a document.
Parameters:
  systemId - The system identifier as a fully-qualified 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:   org.xml.sax.XMLReader.parse(java.lang.String)



processingInstruction
public void processingInstruction(String target, String data) throws SAXException(Code)
Filter a processing instruction event.
Parameters:
  target - The processing instruction target.
Parameters:
  data - The text following the target.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.processingInstruction



resolveEntity
public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException(Code)
Filter an external entity resolution.
Parameters:
  publicId - The entity's public identifier, or null.
Parameters:
  systemId - The entity's system identifier. A new InputSource or null for the default.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
exception:
  java.io.IOException - The client may throw anI/O-related exception while obtaining thenew InputSource.
See Also:   org.xml.sax.EntityResolver.resolveEntity



setAllHandlers
public void setAllHandlers(ContentHandler ch)(Code)
Try to imply all of the handlers from ContentHandler alone.



setContentHandler
public void setContentHandler(ContentHandler handler)(Code)
Set the content event handler.
Parameters:
  handler - The new content handler.
See Also:   org.xml.sax.XMLReader.setContentHandler



setDTDHandler
public void setDTDHandler(DTDHandler handler)(Code)
Set the DTD event handler.
Parameters:
  handler - The new DTD handler.
See Also:   org.xml.sax.XMLReader.setDTDHandler



setDocumentLocator
public void setDocumentLocator(Locator locator)(Code)
Filter a new document locator event.
Parameters:
  locator - The document locator.
See Also:   org.xml.sax.ContentHandler.setDocumentLocator



setEntityResolver
public void setEntityResolver(EntityResolver resolver)(Code)
Set the entity resolver.
Parameters:
  resolver - The new entity resolver.
See Also:   org.xml.sax.XMLReader.setEntityResolver



setErrorHandler
public void setErrorHandler(ErrorHandler handler)(Code)
Set the error event handler.
Parameters:
  handler - The new error handler.
See Also:   org.xml.sax.XMLReader.setErrorHandler



setFeature
public void setFeature(String name, boolean state) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Set the state of a feature.

This will always fail if the parent is null.


Parameters:
  name - The feature name.
Parameters:
  state - The requested feature state.
exception:
  org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the feature name.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot set the requested value.
See Also:   org.xml.sax.XMLReader.setFeature



setLexicalHandler
public void setLexicalHandler(LexicalHandler handler)(Code)
Set the lexical handler.
Parameters:
  handler - The new lexical handler.



setParent
public void setParent(XMLReader parent)(Code)
Set the parent reader.

This is the org.xml.sax.XMLReader XMLReader from which this filter will obtain its events and to which it will pass its configuration requests. The parent may itself be another filter.

If there is no parent reader set, any attempt to parse or to set or get a feature or property will fail.


Parameters:
  parent - The parent XML reader.
exception:
  java.lang.NullPointerException - If the parent is null.
See Also:   SAX2FilterImpl.getParent



setProperty
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Set the value of a property.

This will always fail if the parent is null.


Parameters:
  name - The property name.
Parameters:
  value - The requested property value.
exception:
  org.xml.sax.SAXNotRecognizedException - When theXMLReader does not recognize the property name.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot set the requested value.
See Also:   org.xml.sax.XMLReader.setProperty



skippedEntity
public void skippedEntity(String name) throws SAXException(Code)
Filter a skipped entity event.
Parameters:
  name - The name of the skipped entity.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.skippedEntity



startCDATA
public void startCDATA() throws SAXException(Code)
Filter startCDATA event.
exception:
  SAXException - The application may raise an exception.
See Also:   SAX2FilterImpl.endCDATA



startDTD
public void startDTD(String name, String publicId, String systemId) throws SAXException(Code)
Filter startDTD event.
Parameters:
  name - The document type name.
Parameters:
  publicId - The declared public identifier for theexternal DTD subset, or null if none was declared.
Parameters:
  systemId - The declared system identifier for theexternal DTD subset, or null if none was declared.
exception:
  SAXException - The application may raise anexception.
See Also:   SAX2FilterImpl.endDTD
See Also:   SAX2FilterImpl.startEntity



startDocument
public void startDocument() throws SAXException(Code)
Filter a start document event.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.startDocument



startElement
public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException(Code)
Filter a start element event.
Parameters:
  uri - The element's Namespace URI, or the empty string.
Parameters:
  localName - The element's local name, or the empty string.
Parameters:
  qName - The element's qualified (prefixed) name, or the emptystring.
Parameters:
  atts - The element's attributes.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.startElement



startEntity
public void startEntity(String name) throws SAXException(Code)
Filter startEntity event.
Parameters:
  name - The name of the entity. If it is a parameterentity, the name will begin with '%'.
exception:
  SAXException - The application may raise an exception.
See Also:   SAX2FilterImpl.endEntity
See Also:   org.xml.sax.ext.DeclHandler.internalEntityDecl
See Also:   org.xml.sax.ext.DeclHandler.externalEntityDecl



startPrefixMapping
public void startPrefixMapping(String prefix, String uri) throws SAXException(Code)
Filter a start Namespace prefix mapping event.
Parameters:
  prefix - The Namespace prefix.
Parameters:
  uri - The Namespace URI.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ContentHandler.startPrefixMapping



unparsedEntityDecl
public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException(Code)
Filter an unparsed entity declaration event.
Parameters:
  name - The entity name.
Parameters:
  publicId - The entity's public identifier, or null.
Parameters:
  systemId - The entity's system identifier, or null.
Parameters:
  notationName - The name of the associated notation.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.DTDHandler.unparsedEntityDecl



warning
public void warning(SAXParseException e) throws SAXException(Code)
Filter a warning event.
Parameters:
  e - The nwarning as an exception.
exception:
  org.xml.sax.SAXException - The client may throwan exception during processing.
See Also:   org.xml.sax.ErrorHandler.warning



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.