com.reqdesign.reqif

Class DatatypeDefinitionReal

java.lang.Object

com.reqdesign.reqif.Identifiable<DatatypeDefinition>

com.reqdesign.reqif.DatatypeDefinition

com.reqdesign.reqif.DatatypeDefinitionReal

public final class DatatypeDefinitionReal
extends DatatypeDefinition

This class defines the primitive Real data type.

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

<DATATYPE-DEFINITION-REAL ACCURACY="accuracy" DESC="desc" IDENTIFIER="identifier" LAST-CHANGE="lastChange" LONG-NAME="longName" MAX="max" MIN="min">

The following is the common list of XML attributes:

• @ACCURACY required xsd:integer specifies the number of decimal places to keep for this datatype
• @DESC optional xsd:string description
• @IDENTIFIER required xsd:ID
• @LAST-CHANGE required xsd:dateTime
• @LONG-NAME optional xsd:string
• @MAX required xsd:double specifies the maximum value allowed to be specified for this datatype
• @MIN required xsd:double specifies the minimum value allowed to be specified for this datatype

Truncation occurs for attribute values based on this datatype definition when the ReqIF is saved.

Method Summary

Modifier and Type	Method and Description
long	getAccuracy() Gets the @ACCURACY attribute value for this DatatypeDefinitionReal object.
java.lang.String	getAccuracyText() Returns the String representation for the ACCURACY attribute.
double	getMax() Gets the @MAX attribute value for this DatatypeDefinitionReal object.
java.lang.String	getMaxText() Returns the String representation for the MAX attribute.
double	getMin() Gets the @MIN attribute value for this DatatypeDefinitionReal object
java.lang.String	getMinText() Returns the String representation for the MIN attribute.
void	setAccuracy(long accuracy) Sets the accuracy property for this DatatypeDefinitionReal object.
void	setMax(double max) Sets the @MAX attribute for this DatatypeDefinitionReal object.
void	setMin(double min) Sets the @MIN attribute for this DatatypeDefinitionReal object.

Methods inherited from class com.reqdesign.reqif.DatatypeDefinition

getDatatypeName, 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

getMaxText

public java.lang.String getMaxText()

Returns the String representation for the MAX attribute.

Returns:

the String representation for the MAX attribute.

getMinText

public java.lang.String getMinText()

Returns the String representation for the MIN attribute.

Returns:

the String representation for the MIN attribute.

getAccuracyText

public java.lang.String getAccuracyText()

Returns the String representation for the ACCURACY attribute.

Returns:

the String representation for the ACCURACY attribute.

getAccuracy

public long getAccuracy()

Gets the @ACCURACY attribute value for this DatatypeDefinitionReal object.

Returns:

the value assigned to the @ACCURACY attribute, not negative

setAccuracy

public void setAccuracy(long accuracy)
                 throws InvalidValueException,
                        NotFoundException

Sets the accuracy property for this DatatypeDefinitionReal object.

Parameters:

accuracy - the positive number to set for the @ACCURACY attribute

Throws:

InvalidValueException - if the specified value is negative

NotFoundException - if the DatatypeDefinitionReal is not in the Datatypes collection

getMax

public double getMax()

Gets the @MAX attribute value for this DatatypeDefinitionReal object.

Returns:

the value assigned to the @MAX attribute

setMax

public void setMax(double max)
            throws InvalidValueException,
                   NotFoundException

Sets the @MAX attribute for this DatatypeDefinitionReal object.

When setting this value, consider any existing AttributeDefinitionReal objects associated with a SpecType subclasses that may have specified a default double value based on this DatatypeDefinitionReal object that is greater than this value. Similarly there may be existing AttributeValueReal objects also with double values greater than this value. Any attempt to set this value exceeding any existing instance will cause an InvalidValueException to be raised.

Parameters:

max - the value to set for the @MAX attribute

Throws:

InvalidValueException - if the value is lower than the current @MIN attribute or any existing attribute values or default values that are linked to this DatatypeDefinitionReal object

NotFoundException - if the DatatypeDefinitionReal is not in the Datatypes collection

getMin

public double getMin()

Gets the @MIN attribute value for this DatatypeDefinitionReal object

Returns:

the value assigned to the @MIN attribute

setMin

public void setMin(double min)
            throws InvalidValueException,
                   NotFoundException

Sets the @MIN attribute for this DatatypeDefinitionReal object.

When setting this value, consider any existing AttributeDefinitionReal objects associated with a SpecType subclasses that may have specified a default double value based on this DatatypeDefinitionReal object that is less than this value. Similarly there may be existing AttributeValueReal objects also with double values lower than this value. Any attempt to set this value lower than any existing instance will cause an InvalidValueException to be raised.

Parameters:

min - the value to set for the @MIN attribute

Throws:

InvalidValueException - if the value is higher than the current @MAX attribute or any existing attribute values or default values that are linked to this DatatypeDefinitionReal object

NotFoundException - if the DatatypeDefinitionReal is not in the Datatypes collection