org.jasig.portal
Class ChannelRenderer.Worker

java.lang.Object
  org.jasig.portal.utils.threading.BaseTask
      org.jasig.portal.ChannelRenderer.Worker

All Implemented Interfaces:

Runnable, ChannelRenderer.IWorker, Task

Enclosing class:

ChannelRenderer

protected class ChannelRenderer.Worker
extends BaseTask
implements ChannelRenderer.IWorker

Field Summary

Fields inherited from class org.jasig.portal.utils.threading.BaseTask

exception

Constructor Summary

ChannelRenderer.Worker(IChannel ch, ChannelRuntimeData runtimeData)

Method Summary

boolean	done()
void	execute() Subclasses should implement this method NOTE: not declaring throws Throwable.
SAX2BufferImpl	getBuffer()
String	getChannelTitle() Get a Sring representing the dynamic channel title reported by the IChannel this ChannelRenderer rendered.
String	getCharacters() Returns a character output of a channel rendering.
long	getRenderTime()
boolean	isRenderedFromCache()
boolean	isSetRuntimeDataComplete()
void	setCharacterCache(String chars) Sets a character cache for the current rendering.
boolean	successful()
String	toString()

Methods inherited from class org.jasig.portal.utils.threading.BaseTask

getException, run, setException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.portal.utils.threading.Task

getException

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

ChannelRenderer.Worker

public ChannelRenderer.Worker(IChannel ch,
                              ChannelRuntimeData runtimeData)

Method Detail

isSetRuntimeDataComplete

public boolean isSetRuntimeDataComplete()

Specified by:

isSetRuntimeDataComplete in interface ChannelRenderer.IWorker

execute

public void execute()
             throws Exception

Description copied from class: BaseTask

Subclasses should implement this method NOTE: not declaring throws Throwable. We shouldn't really catch Errors, should we?

Specified by:

execute in interface ChannelRenderer.IWorker

Specified by:

execute in class BaseTask

Throws:

Exception

successful

public boolean successful()

Specified by:

successful in interface ChannelRenderer.IWorker

getBuffer

public SAX2BufferImpl getBuffer()

Specified by:

getBuffer in interface ChannelRenderer.IWorker

getCharacters

public String getCharacters()

Returns a character output of a channel rendering.

Specified by:

getCharacters in interface ChannelRenderer.IWorker

setCharacterCache

public void setCharacterCache(String chars)

Sets a character cache for the current rendering.

Specified by:

setCharacterCache in interface ChannelRenderer.IWorker

done

public boolean done()

Specified by:

done in interface ChannelRenderer.IWorker

getChannelTitle

public String getChannelTitle()

Get a Sring representing the dynamic channel title reported by the IChannel this ChannelRenderer rendered. Returns null if the channel reported no such title or the channel isn't done rendering.

Specified by:

getChannelTitle in interface ChannelRenderer.IWorker

Returns:

dynamic channel title, or null if no title available.

getRenderTime

public long getRenderTime()

Specified by:

getRenderTime in interface ChannelRenderer.IWorker

Returns:

the renderTime

isRenderedFromCache

public boolean isRenderedFromCache()

Specified by:

isRenderedFromCache in interface ChannelRenderer.IWorker

Returns:

the renderedFromCache

toString

public String toString()

Overrides:

toString in class Object