uPortal 2.4.1
API Documentation

org.jasig.portal
Class CharacterCachingChannelIncorporationFilter

java.lang.Object
  extended byorg.jasig.portal.utils.SAX2FilterImpl
      extended byorg.jasig.portal.CharacterCachingChannelIncorporationFilter
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

public class CharacterCachingChannelIncorporationFilter
extends SAX2FilterImpl

A filter that incorporates channel content into the main SAX stream. Unlike a regular ChannelIncorporationFilter, this class can feed cache character buffers to the CachingSerializer.

Version:
$Revision: 1.17 $
Author:
Peter Kharchenko

Constructor Summary
CharacterCachingChannelIncorporationFilter(org.xml.sax.ContentHandler handler, ChannelManager chanm, boolean ccaching)
           
 
Method Summary
 void endDocument()
          Filter an end document event.
 void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)
          Filter an end element event.
 java.util.Vector getChannelIdBlocks()
          Obtain a vector of channels to be inserted into a current character cache.
 java.util.Vector getSystemCCacheBlocks()
          Obtain system character cache blocks.
 void startDocument()
          Filter a start document event.
 void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
          Filter a start element event.
 
Methods inherited from class org.jasig.portal.utils.SAX2FilterImpl
characters, comment, endCDATA, endDTD, endEntity, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, parse, parse, processingInstruction, resolveEntity, setAllHandlers, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setLexicalHandler, setParent, setProperty, skippedEntity, startCDATA, startDTD, startEntity, startPrefixMapping, unparsedEntityDecl, warning
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CharacterCachingChannelIncorporationFilter

public CharacterCachingChannelIncorporationFilter(org.xml.sax.ContentHandler handler,
                                                  ChannelManager chanm,
                                                  boolean ccaching)
Method Detail

getSystemCCacheBlocks

public java.util.Vector getSystemCCacheBlocks()
Obtain system character cache blocks.

Returns:
a Vector of system character blocks in between which channel renderings should be inserted.

getChannelIdBlocks

public java.util.Vector getChannelIdBlocks()
Obtain a vector of channels to be inserted into a current character cache.

Returns:
a Vector of cache entry blocks corresponding to channel subscribe Id(s) in an order in which they appear in the overall document.

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException
Description copied from class: SAX2FilterImpl
Filter a start document event.

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class SAX2FilterImpl
Throws:
org.xml.sax.SAXException - The client may throw an exception during processing.
See Also:
ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException
Description copied from class: SAX2FilterImpl
Filter an end document event.

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class SAX2FilterImpl
Throws:
org.xml.sax.SAXException - The client may throw an exception during processing.
See Also:
ContentHandler.endDocument()

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
Description copied from class: SAX2FilterImpl
Filter a start element event.

Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class SAX2FilterImpl
Parameters:
uri - The element's Namespace URI, or the empty string.
localName - The element's local name, or the empty string.
qName - The element's qualified (prefixed) name, or the empty string.
atts - The element's attributes.
Throws:
org.xml.sax.SAXException - The client may throw an exception during processing.
See Also:
ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
Description copied from class: SAX2FilterImpl
Filter an end element event.

Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class SAX2FilterImpl
Parameters:
uri - The element's Namespace URI, or the empty string.
localName - The element's local name, or the empty string.
qName - The element's qualified (prefixed) name, or the empty string.
Throws:
org.xml.sax.SAXException - The client may throw an exception during processing.
See Also:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

uPortal 2.4.1
API Documentation