oracle.adf.view.rich.activedata

Class ActiveDataEncoder

java.lang.Object

oracle.adf.view.rich.activedata.ActiveDataEncoder

Direct Known Subclasses:

SimpleActiveDataEncoder

public abstract class ActiveDataEncoder
extends Object

ActiveDataEncoder is the abstract base class for all encoders that encode active data.

Constructor Summary

Constructors

Constructor and Description
ActiveDataEncoder()

Method Summary

Modifier and Type	Method and Description
boolean	encode(ActiveDataExceptionEvent event, Writer writer) Handle the result of receiving an exception from the active data manager.
boolean	encode(ActiveDataUpdateEvent event, Writer writer) Encode active data contents for the given ActiveDataEvent.
boolean	encode(ClientEncoder clientEncoder, Writer writer, ActiveDataExceptionEvent event) Handle the result of receiving an exception from the active data manager.
boolean	encode(ClientEncoder clientEncoder, Writer writer, ActiveDataUpdateEvent event) Encode active data contents for the given ActiveDataEvent.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveDataEncoder

public ActiveDataEncoder()

Method Detail

encode

public boolean encode(ActiveDataUpdateEvent event,
                      Writer writer)
               throws IOException

Encode active data contents for the given ActiveDataEvent. The encoded contents is written to the writer. Encoder could optionally choose not to encode active data for reasons such as high volum of change data. If active data is not encoded, active data channel will notify the component to refresh to get lastest data.

Parameters:

event - the active data upate event

writer - the output writer used by the encoder to write encoded contents

Returns:

return true to notify the component to refresh itself; return false if the active data is encoded;

Throws:

IOException - If an I/O error occurs

See Also:

ActiveDataUpdateEvent

encode

public boolean encode(ClientEncoder clientEncoder,
                      Writer writer,
                      ActiveDataUpdateEvent event)
               throws IOException

Encode active data contents for the given ActiveDataEvent. The encoded contents is written to the writer. Encoder could optionally choose not to encode active data for reasons such as high volum of change data. If active data is not encoded, active data channel will notify the component to refresh to get lastest data.

Parameters:

clientEncoder - the client encoder.

writer - the output writer used by the encoder to write encoded contents

event - the active data upate event

Returns:

return true to notify the component to refresh itself; return false if the active data is encoded;

Throws:

IOException - If an I/O error occurs

encode

public boolean encode(ActiveDataExceptionEvent event,
                      Writer writer)
               throws IOException

Handle the result of receiving an exception from the active data manager. The default implementation simply returns true, signifying that the active data framework should request that the component be redrawn.

Parameters:

event - the active data exception event

writer - the output writer used by the encoder to write encoded contents

Returns:

return true to notify the component to refresh itself; Otherwise return false;

Throws:

IOException - If an I/O error occurs

encode

public boolean encode(ClientEncoder clientEncoder,
                      Writer writer,
                      ActiveDataExceptionEvent event)
               throws IOException

Handle the result of receiving an exception from the active data manager. The default implementation simply returns true, signifying that the active data framework should request that the component be redrawn.

Parameters:

clientEncoder - the client encoder.

writer - the output writer used by the encoder to write encoded contents

event - the active data upate event

Returns:

return true to notify the component to refresh itself; Otherwise return false.

Throws:

IOException - If an I/O error occurs