|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IChannelRenderer
defines channel rendering interface.
The process of channel rendering can be implemented in different ways
including in serial form, in parallel form, or a mixture of the two. This
interface allows different implementation to use different implementation
policies.
The channel renderer interaction model is as follows, in order of invocation:
startRendering
completeRendering
outputRendering
Field Summary | |
static java.lang.String |
RCS_ID
Class version identifier. |
static int |
RENDERING_FAILED
Channel rendering failed. |
static int |
RENDERING_SUCCESSFUL
Channel rendering was successful. |
static int |
RENDERING_TIMED_OUT
Channel rendering timed-out. |
Method Summary | |
void |
cancelRendering()
Cancels the rendering job. |
int |
completeRendering()
Complete the channel rendering. |
SAX2BufferImpl |
getBuffer()
Returns the channel rendering buffer. |
java.lang.String |
getCharacters()
Returns the channel rendering character set. |
int |
outputRendering(org.xml.sax.ContentHandler out)
Places the channel rendering output in the specified content handler. |
void |
setCacheTables(java.util.Map cacheTables)
Sets the cache tables for the channel renderer. |
void |
setCharacterCache(java.lang.String chars)
Sets the character cache for the channel renderer. |
void |
setCharacterCacheable(boolean setting)
Enables or disables character caching for the channel renderer. |
void |
setTimeout(long value)
Sets the timeout value for the channel renderer. |
void |
startRendering()
Starts the channel rendering process. |
void |
startRendering(SetCheckInSemaphore groupSemaphore,
java.lang.Object groupRenderingKey)
Starts the channel rendering process. |
Field Detail |
public static final java.lang.String RCS_ID
Class version identifier.
public static final int RENDERING_SUCCESSFUL
Channel rendering was successful.
public static final int RENDERING_FAILED
Channel rendering failed.
public static final int RENDERING_TIMED_OUT
Channel rendering timed-out.
Method Detail |
public void startRendering()
Starts the channel rendering process.
public void startRendering(SetCheckInSemaphore groupSemaphore, java.lang.Object groupRenderingKey)
Starts the channel rendering process.
groupSemaphore
- semaphore to use for a group of channelsgroupRenderingKey
- group rendering keypublic int completeRendering() throws java.lang.Throwable
Complete the channel rendering.
java.lang.Throwable
public void cancelRendering()
Cancels the rendering job.
public java.lang.String getCharacters()
Returns the channel rendering character set.
public SAX2BufferImpl getBuffer()
Returns the channel rendering buffer.
public void setCharacterCache(java.lang.String chars)
Sets the character cache for the channel renderer.
chars
- character cache for the channel rendererpublic void setCharacterCacheable(boolean setting)
Enables or disables character caching for the channel renderer.
setting
- character caching settingpublic void setCacheTables(java.util.Map cacheTables)
Sets the cache tables for the channel renderer.
cacheTables
- cache table for the channel rendererpublic void setTimeout(long value)
Sets the timeout value for the channel renderer.
value
- milliseconds of timeout for the channel rendererpublic int outputRendering(org.xml.sax.ContentHandler out) throws java.lang.Throwable
out
- content handler for the channel rendering information
java.lang.Throwable
- if an error occurs
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |