Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal
Class ChannelRenderingBuffer

    java.lang.Object
      org.jasig.portal.utils.SAX2FilterImpl
          org.jasig.portal.utils.SAX2BufferImpl
              org.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.16 $
Author:
  Peter Kharchenko

Field Summary
`(package private) boolean` | `ccaching`
`private java.lang.String` | `channelClassName`
`private java.lang.String` | `channelPublishId`
`private java.lang.String` | `channelSubscribeId`
`protected ChannelManager` | `cm`
`private boolean` | `insideChannelElement`
`private static org.apache.commons.logging.Log` | `log`
`private java.util.Hashtable` | `params`
`private long` | `timeOut`

Fields inherited from class org.jasig.portal.utils.SAX2BufferImpl
`buffering, CHARACTERS, COMMENT, copyCharBlock, ENDCDATA, ENDDOCUMENT, ENDDTD, ENDELEMENT, ENDENTITY, ENDPREFIXMAPPING, ERROR, eventArguments, eventTypes, FATALERROR, IGNORABLEWHITESPACE, NOTATIONDECL, outputAtDocumentEnd, PROCESSINGINSTRUCTION, SKIPPEDENTITY, STARTCDATA, STARTDOCUMENT, STARTDTD, STARTELEMENT, STARTENTITY, STARTPREFIXMAPPING, UNPARSEDENTITYDECL, WARNING`

Fields inherited from class org.jasig.portal.utils.SAX2FilterImpl
`contentHandler, dtdHandler, entityResolver, errorHandler, lexicalHandler, locator`

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
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### log

    private static final org.apache.commons.logging.Log log

### cm

    protected ChannelManager cm

### insideChannelElement

    private boolean insideChannelElement

### params

    private java.util.Hashtable params

### channelClassName

    private java.lang.String channelClassName

### channelSubscribeId

    private java.lang.String channelSubscribeId

### channelPublishId

    private java.lang.String channelPublishId

### timeOut

    private long timeOut

### ccaching

    boolean ccaching

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` - 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 `SAX2BufferImpl`
  Throws:
    `org.xml.sax.SAXException` - The client may throw an exception during processing.
  See Also:
    `ContentHandler.endDocument()`

### 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`
  Parameters:
    `url` - 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 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`
  Parameters:
    `url` - 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)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD