uPortal 2.4.1
API Documentation

org.jasig.portal
Class ChannelRenderingBuffer

java.lang.Object
  extended byorg.jasig.portal.utils.SAX2FilterImpl
      extended byorg.jasig.portal.utils.SAX2BufferImpl
          extended byorg.jasig.portal.ChannelRenderingBuffer
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 ChannelRenderingBuffer
extends SAX2BufferImpl

Channel Rendering buffer allows portal to accumulate a list of all channels that will have to be rendered. This is done by accumulating layout content (full page content minus content provided by the channels). The entire document is accumulated in a buffer. Information about channel elements is passed to a ChannelManager. Once the end of the document is reached, the entire buffer is released to a provided Document Handler.

Version:
$Revision: 1.15 $
Author:
Peter Kharchenko

Field Summary
 
Fields inherited from class org.jasig.portal.utils.SAX2BufferImpl
CHARACTERS, COMMENT, ENDCDATA, ENDDOCUMENT, ENDDTD, ENDELEMENT, ENDENTITY, ENDPREFIXMAPPING, ERROR, FATALERROR, IGNORABLEWHITESPACE, NOTATIONDECL, PROCESSINGINSTRUCTION, SKIPPEDENTITY, STARTCDATA, STARTDOCUMENT, STARTDTD, STARTELEMENT, STARTENTITY, STARTPREFIXMAPPING, UNPARSEDENTITYDECL, WARNING
 
Constructor Summary
ChannelRenderingBuffer(ChannelManager chanman)
          Default constructor.
ChannelRenderingBuffer(ChannelManager chanman, boolean ccaching)
           
ChannelRenderingBuffer(org.xml.sax.ContentHandler ch, ChannelManager chanman)
           
ChannelRenderingBuffer(org.xml.sax.ContentHandler ch, ChannelManager chanman, boolean ccaching)
           
ChannelRenderingBuffer(org.xml.sax.XMLReader parent, ChannelManager chanman)
           
ChannelRenderingBuffer(org.xml.sax.XMLReader parent, ChannelManager chanman, boolean ccaching)
           
 
Method Summary
 void endDocument()
          Filter an end document event.
 void endElement(java.lang.String url, java.lang.String localName, java.lang.String qName)
          Filter an end element event.
 void setCharacterCaching(boolean setting)
           
 void startDocument()
          Filter a start document event.
 void startElement(java.lang.String url, 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.SAX2BufferImpl
characters, clearBuffer, comment, endCDATA, endDTD, endEntity, endPrefixMapping, error, fatalError, ignorableWhitespace, isEmpty, notationDecl, outputBuffer, outputBuffer, processingInstruction, setDocumentLocator, setOutputAtDocumentEnd, skippedEntity, startBuffering, startCDATA, startDTD, startEntity, startPrefixMapping, stopBuffering, unparsedEntityDecl, warning
 
Methods inherited from class org.jasig.portal.utils.SAX2FilterImpl
getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, parse, parse, resolveEntity, setAllHandlers, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setLexicalHandler, setParent, setProperty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChannelRenderingBuffer

public ChannelRenderingBuffer(ChannelManager chanman)
Default constructor.

Parameters:
chanman - the channel manager

ChannelRenderingBuffer

public ChannelRenderingBuffer(org.xml.sax.ContentHandler ch,
                              ChannelManager chanman)

ChannelRenderingBuffer

public ChannelRenderingBuffer(org.xml.sax.XMLReader parent,
                              ChannelManager chanman)

ChannelRenderingBuffer

public ChannelRenderingBuffer(ChannelManager chanman,
                              boolean ccaching)

ChannelRenderingBuffer

public ChannelRenderingBuffer(org.xml.sax.ContentHandler ch,
                              ChannelManager chanman,
                              boolean ccaching)

ChannelRenderingBuffer

public ChannelRenderingBuffer(org.xml.sax.XMLReader parent,
                              ChannelManager chanman,
                              boolean ccaching)
Method Detail

setCharacterCaching

public void setCharacterCaching(boolean setting)

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 SAX2BufferImpl
Throws:
org.xml.sax.SAXException

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 SAX2BufferImpl
Throws:
org.xml.sax.SAXException

startElement

public void startElement(java.lang.String url,
                         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 SAX2BufferImpl
Throws:
org.xml.sax.SAXException

endElement

public void endElement(java.lang.String url,
                       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 SAX2BufferImpl
Throws:
org.xml.sax.SAXException

uPortal 2.4.1
API Documentation