ilog.server.jsds.table
Class IlsRpTable

java.lang.Object
  |
  +--ilog.server.jcomp.RpObject
        |
        +--ilog.server.jsds.IlsDSObject
              |
              +--ilog.server.jsds.IlsDSMainObject
                    |
                    +--ilog.server.jsds.table.IlsRpTable
All Implemented Interfaces:
IlsDataSourceContainer.Finder, RepresentationUpdate.Type, S2CTransactionStatus

public class IlsRpTable
extends IlsDSMainObject

Representation object for table data source. The predefined attribute is "column" it represents the headers of the table. The attribute "column" is indexed.


Inner classes inherited from class ilog.server.jcomp.RpObject
RpObject.IllegalCollector, RpObject.ModelNotSet, RpObject.RepresentationNotSet
 
Fields inherited from class ilog.server.jsds.IlsDSObject
_properties, NOTIFY_OR_ROLLBACK
 
Fields inherited from class ilog.server.jcomp.RpObject
_repres
 
Fields inherited from interface ilog.server.jcomp.RepresentationUpdate.Type
ADD, ADD_ORIG, CLOSE, COMP_FUNCALL, CREATION, DELETION, HREF_MODIF_LABEL, LOCAL_CREATION, LOCAL_RM, MAX, MODIFICATION, NOTIFY, NOUPDATE, OBJ_FUNCALL, OPEN_VIEW, PUSH_MAIN_ORIG, RM, RM_ORIG, ROLLBACK, SELECTION, SET_MAIN_ORIG, STATUS, VIEW_FUNCALL
 
Fields inherited from interface ilog.server.jcomp.S2CTransactionStatus
ACKNOWLEDGE, CP_ROLLBACK, CREATION, DEFAULT, GET_OBJ_IDS, GET_VIEW_IDS, NOTIFY, NOTIFY_CREATION, RECV_MESG, RECV_OBJ_IDS, RECV_VIEW_IDS, SV_ROLLBACK, SV_ROLLBACK_CREATION
 
Constructor Summary
IlsRpTable(Representation rp, RpObjModel om)
          Instantiate a new IlsRpTable.
 
Method Summary
protected  boolean beginS2CUpdate(int transStatus, int transId)
           
protected  void dispose()
           
protected  void endS2CUpdate(int transStatus, int transId)
           
 java.lang.Object onAddRow()
          Add a row to the table.
 void onRemoveRow(IlsRpRow row)
          Remove row from the table.
 void onUpdateCell(IlsRpRow row, int colNumber, java.lang.Object value)
          Update a cell value of a row representation.
 void onUpdateCellProperty(IlsRpRow row, int colNumber, java.lang.String propertyName, java.lang.Object value)
          Update a cell property value of a row representation.
 void onUpdateColumnProperty(int colNumber, java.lang.String propName, java.lang.Object value)
          Update a column property value of the table representation.
 void onUpdateRow(IlsRpRow row, IlTableCellInfo[] cellValues)
          Update a row of the table representation.
 void onUpdateRowProperty(IlsRpRow row, java.util.Map properties)
          Update the row properties value of the table representation.
 void onUpdateRowProperty(IlsRpRow row, java.lang.String propName, java.lang.Object value)
          Update a row property value of the table representation.
protected  void setBoolean(int attrId, boolean value)
           
protected  void setChar(int attrId, char value)
           
 void setColumn(int colNumber, java.lang.String columnName)
          Set the column header.
protected  void setDouble(int attrId, double value)
           
protected  void setFloat(int attrId, float value)
           
protected  void setLong(int attrId, long value)
           
protected  void setReference(int attrId, RpObject value)
           
protected  void setShort(int attrId, short value)
           
protected  void setString(int attrId, java.lang.String value)
           
protected  void setUserTypeValue(int attrId, MvUserType value)
           
 
Methods inherited from class ilog.server.jsds.IlsDSMainObject
match
 
Methods inherited from class ilog.server.jsds.IlsDSObject
onDSDereference, onUpdateProperty, openDSView, openDSView, openDSView, setHRef, setProperty
 
Methods inherited from class ilog.server.jcomp.RpObject
ackAttrUpdate, ackOpenView, afterInit, beforeDeletion, beginC2SUpdate, beginC2SUpdate, discardC2SUpdate, endC2SUpdate, execAsyncCallback, execAsyncCallback, execCallback, execDuplexCallback, execDuplexCallback, execDuplexCallback, execSyncCallback, finalize, getAttributeId, getAttributeId, getAttributeType, getLabel, getReference, getRepresentation, getRpObjectId, getRpObjModel, ILS_RP_ATTR_BOOLEAN, ILS_RP_ATTR_CHAR, ILS_RP_ATTR_DOUBLE, ILS_RP_ATTR_FLOAT, ILS_RP_ATTR_HREF, ILS_RP_ATTR_INT, ILS_RP_ATTR_LONG, ILS_RP_ATTR_MVVALUE, ILS_RP_ATTR_REF, ILS_RP_ATTR_REF, ILS_RP_ATTR_STRING, ILS_RP_ATTR_USERTYPE, ILS_RP_DEFAULT_ATTR_BOOLEAN, ILS_RP_DEFAULT_ATTR_CHAR, ILS_RP_DEFAULT_ATTR_DOUBLE, ILS_RP_DEFAULT_ATTR_FLOAT, ILS_RP_DEFAULT_ATTR_INT, ILS_RP_DEFAULT_ATTR_LONG, ILS_RP_DEFAULT_ATTR_MVVALUE, ILS_RP_DEFAULT_ATTR_REF, ILS_RP_DEFAULT_ATTR_STRING, ILS_RP_DEFAULT_ATTR_USERTYPE, ILS_RP_DEFAULT_INDEXED_ATTR_BOOL, ILS_RP_DEFAULT_INDEXED_ATTR_CHAR, ILS_RP_DEFAULT_INDEXED_ATTR_DOUBLE, ILS_RP_DEFAULT_INDEXED_ATTR_FLOAT, ILS_RP_DEFAULT_INDEXED_ATTR_INT, ILS_RP_DEFAULT_INDEXED_ATTR_LONG, ILS_RP_DEFAULT_INDEXED_ATTR_MVVALUE, ILS_RP_DEFAULT_INDEXED_ATTR_REF, ILS_RP_DEFAULT_INDEXED_ATTR_STRING, ILS_RP_DEFAULT_INDEXED_ATTR_USERTYPE, ILS_RP_INDEXED_ATTR_BOOLEAN, ILS_RP_INDEXED_ATTR_CHAR, ILS_RP_INDEXED_ATTR_DOUBLE, ILS_RP_INDEXED_ATTR_FLOAT, ILS_RP_INDEXED_ATTR_HREF, ILS_RP_INDEXED_ATTR_INT, ILS_RP_INDEXED_ATTR_LONG, ILS_RP_INDEXED_ATTR_MVVALUE, ILS_RP_INDEXED_ATTR_REF, ILS_RP_INDEXED_ATTR_STRING, ILS_RP_INDEXED_ATTR_USERTYPE, isEditable, isMatchingHRef, isMatchingRef, onAddToCollection, onDereference, onDereference, onDereference, onNullifyRef, onRmFromCollection, onRmFromCollection, onRmRepresentation, onSuppress, onUpdate, onUpdate, openView, openView, openView, openView, performUpdate, performUpdate, setAny, setAttributeValue, setConstAttribute, setConstAttributes, setMvValue, setRpStatus, setSelection, setValue, testCollection, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IlsRpTable

public IlsRpTable(Representation rp,
                  RpObjModel om)
Instantiate a new IlsRpTable. This method is invoked by the representation.
Parameters:
rp - The representation into which this representation object will be inserted.
om - The associated representation object model.
Method Detail

dispose

protected void dispose()
Description copied from class: RpObject
This hook method is called when the object is "deleted".

When the component receives the order of deletion or when the garbage collector reclaims the object.

Overrides:
dispose in class RpObject

beginS2CUpdate

protected boolean beginS2CUpdate(int transStatus,
                                 int transId)
Description copied from class: RpObject
This function is called by Representation.beginS2CTransaction if this object is involved in the transaction. It can be overridden to control the execution of the transaction.

If this method return strue, the notification, acknowledgement or rollback is forwarded to each attribute affected by the transaction. If it returns false, the transaction aborts for this representation object.

Overrides:
beginS2CUpdate in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
trnsSt: - The transaction status (forwarded by Representation.beginS2CTransaction).
trnsId: - The transaction identifier (forwarded by Representation.beginS2CTransaction).
See Also:
Representation.beginS2CTransaction(int, int)

endS2CUpdate

protected void endS2CUpdate(int transStatus,
                            int transId)
Description copied from class: RpObject
This function is called automatically once the server has finished updating a representation object after a server component transaction.

This method is empty.

Overrides:
endS2CUpdate in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
trnsSt: - The transaction status
trnsId: - The transaction identifier

onAddRow

public java.lang.Object onAddRow()
Add a row to the table.
Returns:
the new row representation.

onRemoveRow

public void onRemoveRow(IlsRpRow row)
Remove row from the table.

onUpdateCell

public void onUpdateCell(IlsRpRow row,
                         int colNumber,
                         java.lang.Object value)
Update a cell value of a row representation.
Parameters:
row - The row representation to update.
colNumber - The cell index to update.
value - The new value.

onUpdateCellProperty

public void onUpdateCellProperty(IlsRpRow row,
                                 int colNumber,
                                 java.lang.String propertyName,
                                 java.lang.Object value)
Update a cell property value of a row representation.
Parameters:
row - The row representation to update.
colNumber - The cell index to update.
propertyName - The cell property name.
value - The new value.

onUpdateColumnProperty

public void onUpdateColumnProperty(int colNumber,
                                   java.lang.String propName,
                                   java.lang.Object value)
Update a column property value of the table representation.
Parameters:
colNumber - The cell index to update.
propertyName - The cell property name.
value - The new value.

onUpdateRow

public void onUpdateRow(IlsRpRow row,
                        IlTableCellInfo[] cellValues)
Update a row of the table representation.
Parameters:
row - The row representation to update.
cellValues - The new cell values.
See Also:
IlTableCellInfo

onUpdateRowProperty

public void onUpdateRowProperty(IlsRpRow row,
                                java.util.Map properties)
Update the row properties value of the table representation.
Parameters:
row - The row representation to update.
properties - The properties to update.

onUpdateRowProperty

public void onUpdateRowProperty(IlsRpRow row,
                                java.lang.String propName,
                                java.lang.Object value)
Update a row property value of the table representation.
Parameters:
row - The row representation to update.
propertyName - The cell property name.
value - The new value.

setColumn

public void setColumn(int colNumber,
                      java.lang.String columnName)
Set the column header. This method is invoked by the component.
Parameters:
colNumber - The column header index.
columnName - The new value.

setBoolean

protected void setBoolean(int attrId,
                          boolean value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setBoolean in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A boolean attribute identifier.
v - the value.

setChar

protected void setChar(int attrId,
                       char value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setChar in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A char attribute identifier.
v - the value.

setDouble

protected void setDouble(int attrId,
                         double value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setDouble in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A double attribute identifier.
v - the value.

setFloat

protected void setFloat(int attrId,
                        float value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setFloat in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A float attribute identifier.
v - the value.

setLong

protected void setLong(int attrId,
                       long value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setLong in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A long attribute identifier.
v - the value.

setShort

protected void setShort(int attrId,
                        short value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setShort in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A short attribute identifier.
v - the value.

setString

protected void setString(int attrId,
                         java.lang.String value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setString in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A String attribute identifier.
v - the value.

setReference

protected void setReference(int attrId,
                            RpObject value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setReference in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A RpObject attribute identifier.
v - the value.

setUserTypeValue

protected void setUserTypeValue(int attrId,
                                MvUserType value)
Description copied from class: RpObject
Called by the server to set the value this attribute when it has no associated modifier.
Overrides:
setUserTypeValue in class IlsDSObject
Following copied from class: ilog.server.jcomp.RpObject
Parameters:
id - A MvUserType attribute identifier
v - the value.