Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-05


oracle.adf.view.rich.activedata
Class ActiveDataEncoder

java.lang.Object
  extended by oracle.adf.view.rich.activedata.ActiveDataEncoder

Direct Known Subclasses:
SimpleActiveDataEncoder

public abstract class ActiveDataEncoder
extends java.lang.Object

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


Constructor Summary
ActiveDataEncoder()
           

 

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

 

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,
                      java.io.Writer writer)
               throws java.io.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:
java.io.IOException
See Also:
ActiveDataUpdateEvent

encode

public boolean encode(ClientEncoder clientEncoder,
                      java.io.Writer writer,
                      ActiveDataUpdateEvent event)
               throws java.io.IOException
Throws:
java.io.IOException

encode

public boolean encode(ActiveDataExceptionEvent event,
                      java.io.Writer writer)
               throws java.io.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:
java.io.IOException

encode

public boolean encode(ClientEncoder clientEncoder,
                      java.io.Writer writer,
                      ActiveDataExceptionEvent event)
               throws java.io.IOException
Throws:
java.io.IOException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-05


Copyright (c) 1998, 2011, Oracle and/or its affiliates. All rights reserved.