Public Member Functions

si.ijs.acs.objectexplorer.engine.Attribute Class Reference

Inheritance diagram for si.ijs.acs.objectexplorer.engine.Attribute:
si.ijs.acs.objectexplorer.engine.BACI.BACIAttribute

List of all members.

Public Member Functions

 Attribute (String name, SimpleIntrospectable introspectable, DataType type, boolean readOnly)
DataType getAttributeType ()
SimpleIntrospectable getIntrospectable ()
abstract RemoteCall invokeAccessor ()
abstract RemoteCall invokeMutator (Object value)
boolean isReadOnly ()
String toString ()

Detailed Description

Attribute is a class that represents an attribute (or Java property) design pattern on remote objects. Attributes are characterized by a pair of functions, called accessor and mutator functions. An attribute has a type. An accessor is used to retrieve the value of a given type, and the mutator is used to change the value. A read only attribute is an attribute that only declares an accessor method. Attributes are treated separately from normal operations because their explicit declaration is often chosen for special design reasons and thus they have a special status for the final user.


Constructor & Destructor Documentation

si.ijs.acs.objectexplorer.engine.Attribute.Attribute ( String  name,
SimpleIntrospectable  introspectable,
DataType  type,
boolean  readOnly 
)

Constructs a new instance of this class. All parameters must be non-null.

Parameters:
name the name of the attribute
introspectable the remote instance that contains this attribute
type a DataType instance that represents the type of this attribute. Note that the class should declare public constructors with all parameters neccessary for the construction of the value, if applicable. GUI can then use introspection to create new instances and pass them to mutator methods.
readOnly true if this attribute only supports accessor method.

Member Function Documentation

DataType si.ijs.acs.objectexplorer.engine.Attribute.getAttributeType (  ) 

Returns the DataType object that represents the type of this attribute. The value is the same as that passed into the constructor.

Returns:
type of this

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIAttribute.BACIAttribute().

SimpleIntrospectable si.ijs.acs.objectexplorer.engine.Attribute.getIntrospectable (  ) 

Returns the container for this attribute. The function returns the parameter passed into the constructor.

Returns:
remote object declaring the attribute

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteAccess.invokeAccessor().

abstract RemoteCall si.ijs.acs.objectexplorer.engine.Attribute.invokeAccessor (  )  [pure virtual]

The method invokes remote accessor method on the introspectable instance. The return value is packed into the standard RemoteCall structure.

Returns:
remote call data structure that will return true when isAttributeAccess() is invoked.

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIAttribute.

abstract RemoteCall si.ijs.acs.objectexplorer.engine.Attribute.invokeMutator ( Object  value  )  [pure virtual]

NOT SUPPORTED yet. Will be used for changing the value of a writable attribute.

Parameters:
value java.lang.Object the new value of the attribute

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIAttribute.

boolean si.ijs.acs.objectexplorer.engine.Attribute.isReadOnly (  ) 

Returns true if the attribute is read only. Returns the same value as that passed into the constructor.

Returns:
boolean readOnly flag.

Referenced by si.ijs.acs.objectexplorer.ListsHandlerBean.clickedItem().

String si.ijs.acs.objectexplorer.engine.Attribute.toString (  ) 

Overloaded to return the name of the attribute as passed into the constructor. This should be the display name in the GUI.

Returns:
name of the attribute

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties