com.ibm.rational.rpe.common.data
Class Property

java.lang.Object
  extended by com.ibm.rational.rpe.common.data.Property
All Implemented Interfaces:
Visitable

public class Property
extends java.lang.Object
implements Visitable

This class models the property concept in Rational Reporting for Document Generation (RRDG). Almost all of the RRDG concepts use properties, such as templates, template elements, document specifications, outputs, and variables. A property is a name-value pair, which can have additional traits like type, editable, visible and required. Optionally, a property can have a DomainValue, which describes the valid domain for its values.


Constructor Summary
Property()
           
Property(java.lang.String name, java.lang.String type, Value value)
          Creates a property with the given name and value and also sets its type to type
Property(java.lang.String name, Value value)
          Creates a property with the given name and value
 
Method Summary
 DomainValue getDomain()
          Returns the DomainValue for this property, if present.
 java.lang.String getName()
           
 java.lang.String getType()
           
 Value getValue()
          Returns the value of the property.
 boolean isEditable()
           
 boolean isRequired()
           
 boolean isVisible()
           
 void setDomain(DomainValue domain)
          Sets the DomainValue for this property.
 void setEditable(boolean editable)
           
 void setName(java.lang.String name)
           
 void setRequired(boolean required)
           
 void setType(java.lang.String type)
           
 void setValue(Value value)
           
 void setVisible(boolean visible)
           
 void visit(Visitable parent, com.ibm.rational.rpe.common.template.visitor.Visitor v)
          Visits the current visitable object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Property

public Property()

Property

public Property(java.lang.String name,
                Value value)
Creates a property with the given name and value


Property

public Property(java.lang.String name,
                java.lang.String type,
                Value value)
Creates a property with the given name and value and also sets its type to type

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setType

public void setType(java.lang.String type)

getType

public java.lang.String getType()

getValue

public Value getValue()
Returns the value of the property.

Returns:

setValue

public void setValue(Value value)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

visit

public void visit(Visitable parent,
                  com.ibm.rational.rpe.common.template.visitor.Visitor v)
Description copied from interface: Visitable
Visits the current visitable object

Specified by:
visit in interface Visitable
Parameters:
parent - - (optional) the parent visitable object that triggered the visit of this object
v - - the visitor

getDomain

public DomainValue getDomain()
Returns the DomainValue for this property, if present.

Returns:

setDomain

public void setDomain(DomainValue domain)
Sets the DomainValue for this property.