com.reqdesign.reqif

Class AttributeDefinitionReal

java.lang.Object

com.reqdesign.reqif.Identifiable<AttributeDefinition<T>>

com.reqdesign.reqif.AttributeDefinition<AttributeValueReal>

com.reqdesign.reqif.AttributeDefinitionReal

public final class AttributeDefinitionReal
extends AttributeDefinition<AttributeValueReal>

This class is the definition of a real attribute.

This class extends from the base class AttributeDefinition.

The specific form of an AttributeDefinitionReal in a ReqIF file is as follows:

<ATTRIBUTE-DEFINITION-REAL DESC="desc" IS-EDITABLE="isEditable" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName">

The following is the list of XML attributes:

• @DESC optional xsd:string description
• @IS-EDITABLE optional xsd:boolean, if not specified, false is assumed
• @IDENTIFIER required xsd:ID
• @LAST-CHANGE required xsd:dateTime
• @LONG-NAME required xsd:string (Note: currently the reqif.xsd does not enforce this)

Method Summary

Modifier and Type	Method and Description
DatatypeDefinitionReal	getDatatypeDefinitionReal() Type specific getter for the associated DatatypeDefinition subclass.
AttributeValueReal	getDefaultValue() The default value which can be assigned by the exporting tool if one is specified.
void	setDefaultValue(double theValue) Sets the default value for this object.

Methods inherited from class com.reqdesign.reqif.AttributeDefinition

getDatatypeDefinition, getSpecType, hasDefaultValue, isEditable, removeDefaultValue, setIsEditable, toString

Methods inherited from class com.reqdesign.reqif.Identifiable

equals, getAlternativeID, getChildren, getDesc, getIdentifier, getLastChange, getLastChangeText, getLongName, getPathToRoot, getReqIFContent, hashCode, isUsed, isValidIdentifier, setAlternativeID, setDesc, setLastChange, setLongName, whereUsed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDatatypeDefinitionReal

public DatatypeDefinitionReal getDatatypeDefinitionReal()

Type specific getter for the associated DatatypeDefinition subclass.

Returns:

the associated DatatypeDefinitionReal object

getDefaultValue

public AttributeValueReal getDefaultValue()

The default value which can be assigned by the exporting tool if one is specified.

If, during import, an AttributeValueReal is not specified for a particular SpecElementWithAttributes, and corresponding AttributeDefinitionReal on the associated SpecType, then the default value if one exists will be the substitute for the missing value otherwise the value null is assumed meaning 'unset'.

Specified by:

getDefaultValue in class AttributeDefinition<AttributeValueReal>

Returns:

the default value for this AttributeDefinitionReal

setDefaultValue

public void setDefaultValue(double theValue)
                     throws NotFoundException,
                            InvalidValueException

Sets the default value for this object.

When a ReqIF is saved, the value specified as the default value, will be truncated to the number of places as defined by the ACCURACY attribute.

Parameters:

theValue - the double value to set as the default

Throws:

InvalidValueException - if the specified value is outside the permitted range as defined in the associated DatatypeDefinitionReal object @MIN and @MAX attribute values

NotFoundException - if this AttributeDefinitionReal has been removed from its SpecType