com.reqdesign.reqif

Class AttributeDefinitionEnumeration

java.lang.Object

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

com.reqdesign.reqif.AttributeDefinition<AttributeValueEnumeration>

com.reqdesign.reqif.AttributeDefinitionEnumeration

public final class AttributeDefinitionEnumeration
extends AttributeDefinition<AttributeValueEnumeration>

This class is the definition of an enumeration attribute.

Attributes

multiValued : Boolean

If set to true, this means that the user of a requirements authoring tool can pick one or more than one of the values in the set of specified values as an enumeration attribute value.

If set to false, this means that the user of a requirements authoring tool can pick exactly one of the values in the set of specified values as an enumeration attribute value.

Associations

defaultValue : AttributeValueEnumeration [0..1] {composite}

Linkage of the owned default value that is used if no attribute value is supplied by the user of the requirements authoring tool.

type : DatatypeDefinitionEnumeration [1]

Reference to the data type for enumerations.

If the isEditable attribute is set to false or left out, no modification of the default value by tool users is allowed.

Constraints

If the inherited isEditable attribute is set to false or left out, all of the following constraints apply:

• no modification of the default value by tool users is allowed.
• no adding, deleting, or modification of enumeration literals by tool users is allowed.

Semantics

There are basically two kinds of enumerations: "single-choice" and "multiple-choice" enumerations.

• "Single-choice" enumerations allow the user of a requirements authoring tool to pick exactly one value out of a set of specified values.
• "Multiple-choice" enumerations allow the user of a requirements authoring tool to pick several values out of a set of specified values.

For "multiple-choice" enumerations, the multiValued attribute needs to be set to true, for "single-choice" enumerations it needs to be set to false.

This class extends from the base class AttributeDefinition.

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

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

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)
• @MULTI-VALUED required xsd:boolean see above

Method Summary

Modifier and Type	Method and Description
DatatypeDefinitionEnumeration	getDatatypeDefinitionEnumeration() Type specific getter for the associated DatatypeDefinition subclass.
AttributeValueEnumeration	getDefaultValue() The default value which can be assigned by the exporting tool if one is specified.
boolean	getMultiValued()
void	setDefaultValue(EnumValue... theValues) Sets the default values for this object using a List.
void	setMultiValued(boolean multiValued) Sets the value of the @MULTI-VALUED attribute of this AttributeDefinitionEnumeration 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

getMultiValued

public boolean getMultiValued()

Returns:

the value of the @MULTI-VALUED attribute of this AttributeDefinitionEnumeration object

setMultiValued

public void setMultiValued(boolean multiValued)
                    throws InvalidValueException,
                           NotFoundException

Sets the value of the @MULTI-VALUED attribute of this AttributeDefinitionEnumeration object.

Parameters:

multiValued - true to set the @MULTI-VALUED attribute or false to unset the attribute.

Throws:

InvalidValueException - if an attempt is made to clear the flag when there are existing AttributeDefinitionEnumeration or AttributeValueEnumeration objects that have more multiple EnumValue references.

NotFoundException - is this AttributeDefinitionEnumeration has been removed from the SpecType SpecAttributes collection

getDatatypeDefinitionEnumeration

public DatatypeDefinitionEnumeration getDatatypeDefinitionEnumeration()

Type specific getter for the associated DatatypeDefinition subclass.

Returns:

the associated DatatypeDefinitionEnumeration object, not null

getDefaultValue

public AttributeValueEnumeration getDefaultValue()

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

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

Returns:

the default value for this AttributeDefinitionEnumeration

setDefaultValue

public void setDefaultValue(EnumValue... theValues)
                     throws InvalidValueException,
                            NotFoundException

Sets the default values for this object using a List.

See AttributeDefinition.removeDefaultValue() to unset the default.

Parameters:

theValues - the Array containing instances of EnumValue objects to set as the default, not null

Throws:

InvalidValueException - if the specified parameter is null, or any of the objects in the list are null or any of the objects in the list are not contained in the associated DatatypeDefinitionEnumeration or more than one EnumValue object is specified when the @MULTI-VALUED attribute is false

NotFoundException - if this AttributeDefinitionEnumeration has been removed from its SpecType