ilog.server.jcomp
Class RpAttrModel

java.lang.Object
  |
  +--ilog.server.jcomp.RpAttrModel

public class RpAttrModel
extends java.lang.Object

Dynamic view-related class

This class defines an attribute of a dynamic representation object model (see IlsRpObjModel). In the following view specification, table and column[1] are two attributes of the dynamic representation object model inputRow.

   view NodePanel:
   ...
   subscribe Line:
   represent IlsSwRow inputRow:
               Ref<IlsSwTable> table=...;
               string column[1]=...;
   ...
 

At runtime, both attributes will be defined by an instance of the class IlsRpAttrModel. An object of type IlsRpAttrModel specifies the type of the attribute, its identifier, and its write permissions. A runtime attribute does not necessarily have to be a data member of the representation object type. Attribute of a representation object are associated with editing functions via the macros ILS_RP_ATTR_XXX and ILS_RP_INDEXED_ATTR_XXX.

See Also:
RpObjModel, RpObject, Mapping

Method Summary
 MvDataType getDataType()
           
 int getId()
          This function returns the attribute identifier.
 int getIndex()
           
 java.lang.String getLabel()
           
 boolean isEditable()
           
 boolean isIndexed()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getDataType

public final MvDataType getDataType()
Returns:
The runtime type of the attribute.

getLabel

public final java.lang.String getLabel()

getId

public final int getId()
This function returns the attribute identifier. This identifier is used by the Rogue Wave Server internal protocol. It is also used to identify the attribute to be edited in the callback functions of the RpObject class.
Returns:
The attribute identifier.

isIndexed

public boolean isIndexed()
Returns:
true if and only if the attribute is indexed.

getIndex

public final int getIndex()
Returns:
The index value of the attribute if the attribute is indexed, -1

isEditable

public boolean isEditable()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object