com.reqdesign.reqif

Class AttributeDefinitionString

java.lang.Object

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

com.reqdesign.reqif.AttributeDefinition<AttributeValueString>

com.reqdesign.reqif.AttributeDefinitionString

public final class AttributeDefinitionString
extends AttributeDefinition<AttributeValueString>

This class is the definition of a string attribute.

This class extends from the base class AttributeDefinition.

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

<ATTRIBUTE-DEFINITION-STRING 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
DatatypeDefinitionString	getDatatypeDefinitionString() Type specific getter for the associated DatatypeDefinition subclass.
AttributeValueString	getDefaultValue() The default value which can be assigned by the exporting tool if one is specified.
void	setDefaultValue(java.lang.String 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

getDatatypeDefinitionString

public DatatypeDefinitionString getDatatypeDefinitionString()

Type specific getter for the associated DatatypeDefinition subclass.

Returns:

the associated DatatypeDefinitionString object, not null

getDefaultValue

public AttributeValueString getDefaultValue()

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

If, during import, an AttributeValueString is not specified for a particular SpecElementWithAttributes, and corresponding AttributeDefinitionString 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<AttributeValueString>

Returns:

the default value for this AttributeDefinitionString

setDefaultValue

public void setDefaultValue(java.lang.String theValue)
                     throws InvalidValueException,
                            NotFoundException

Sets the default value for this object.

null values are not permitted although you can set an empty string.

Parameters:

theValue - the String value to set as the default, not null

Throws:

InvalidValueException - if the specified value is null or the length is longer than permitted as defined in the associated DatatypeDefinitionString object MAX-LENGTH attribute

NotFoundException - if this AttributeDefinitionString has been removed from its SpecType