ilog.server.jsds.sdm
Class IlsRpSDMElement

java.lang.Object
  |
  +--ilog.server.jcomp.RpObject
        |
        +--ilog.server.jsds.IlsDSObject
              |
              +--ilog.server.jsds.sdm.IlsRpSDMElement

All Implemented Interfaces:

RepresentationUpdate.Type, S2CTransactionStatus

Direct Known Subclasses:

IlsRpSDMLink, IlsRpSDMNode

public abstract class IlsRpSDMElement

extends IlsDSObject

Base representation object for node and links in SDM data source. Predefined attributes are SDM, tag and parent.

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

IlsRpSDMElement(Representation rp, RpObjModel om)

Method Summary

protected boolean	beginS2CUpdate(int transStatus, int transId)
protected void	dispose()
protected void	doDispose()
protected void	endS2CUpdate(int transStatus, int transId)
protected abstract void	fireAddElement(IlsRpSDMModel sdm, java.util.Map properties)
protected abstract void	fireRemoveElement(IlsRpSDMModel sdm)
protected abstract void	fireUpdateElement(IlsRpSDMModel sdm, java.util.Map properties)
IlsRpSDMElement	getParent()
IlsRpSDMModel	getSDM()
java.lang.String	getTag()
void	setParent(IlsRpSDMElement parent)
void	setSDM(IlsRpSDMModel sdm) Update the node SDM.
void	setTag(java.lang.String tag)

Methods inherited from class ilog.server.jsds.IlsDSObject

onDSDereference, onUpdateProperty, openDSView, openDSView, openDSView, setBoolean, setChar, setDouble, setFloat, setHRef, setLong, setProperty, setReference, setShort, setString, setUserTypeValue

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

IlsRpSDMElement

public IlsRpSDMElement(Representation rp,
                       RpObjModel om)

Method Detail

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

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

fireAddElement

protected abstract void fireAddElement(IlsRpSDMModel sdm,
                                       java.util.Map properties)

fireUpdateElement

protected abstract void fireUpdateElement(IlsRpSDMModel sdm,
                                          java.util.Map properties)

fireRemoveElement

protected abstract void fireRemoveElement(IlsRpSDMModel sdm)

doDispose

protected void doDispose()

getTag

public java.lang.String getTag()

getParent

public IlsRpSDMElement getParent()

getSDM

public IlsRpSDMModel getSDM()

setSDM

public void setSDM(IlsRpSDMModel sdm)

Update the node SDM. This method is invoked by the component. if tag is undefined, try to define with IlsRpSDMModel.getTag

Parameters:

sdm - The new SDM.

setTag

public void setTag(java.lang.String tag)

setParent

public void setParent(IlsRpSDMElement parent)