com.reqdesign.reqif

Class AttributeDefinitionXHTML

java.lang.Object

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

com.reqdesign.reqif.AttributeDefinition<AttributeValueXHTML>

com.reqdesign.reqif.AttributeDefinitionXHTML

public final class AttributeDefinitionXHTML
extends AttributeDefinition<AttributeValueXHTML>

This class is the definition of an XHTML attribute.

This class extends from the base class AttributeDefinition.

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

<ATTRIBUTE-DEFINITION-XHTML 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
DatatypeDefinitionXHTML	getDatatypeDefinitionXHTML() Type specific getter for the associated DatatypeDefinition subclass.
AttributeValueXHTML	getDefaultValue() The default value which can be assigned by the exporting tool if one is specified.
void	setDefaultValue(org.w3c.dom.Element theValue) Sets the default for theValue for this object.
void	setDefaultValue(org.w3c.dom.Element theValue, org.w3c.dom.Element theOriginalValue, boolean isSimplified) Sets the defaults for the theValue, theOriginalValue and isSimplified values for this object.
void	setDefaultValue(java.lang.String theValue) Sets the default for theValue value this object by specifying content as a String.
void	setDefaultValue(java.lang.String theValue, java.lang.String theOriginalValue, boolean isSimplified) Sets the default values for this object by specifying ReqIF XHTML content using String values.

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

getDatatypeDefinitionXHTML

public DatatypeDefinitionXHTML getDatatypeDefinitionXHTML()

Type specific getter for the associated DatatypeDefinition subclass.

Returns:

the associated DatatypeDefinitionXHTML object, not null

getDefaultValue

public AttributeValueXHTML getDefaultValue()

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

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

Returns:

the default value for this AttributeDefinitionXHTML

setDefaultValue

public void setDefaultValue(org.w3c.dom.Element theValue,
                            org.w3c.dom.Element theOriginalValue,
                            boolean isSimplified)
                     throws ValidationException,
                            NotFoundException

Sets the defaults for the theValue, theOriginalValue and isSimplified values for this object.

The specified ReqIF XHTML will be validated. If errors occurred, you can investigate the validation errors by calling AttributeValueXHTML.validate(ReqIFFile, Element, Consumer)

Parameters:

theValue - the Element value to set as the default for theValue, not null

theOriginalValue - the Element value to set as the default for theOriginalValue, can be null

isSimplified - the boolean value to set as the @IS_SIMPLIFIED attribute

Throws:

ValidationException - if theValue or theOriginalValue do not contain valid ReqIF XHTML

NotFoundException - if this AttributeDefinitionXHTML has been removed from its SpecType

setDefaultValue

public void setDefaultValue(org.w3c.dom.Element theValue)
                     throws NotSavedException,
                            ValidationException,
                            NotFoundException

Sets the default for theValue for this object.

The Element object representing the THE-ORIGINAL-VALUE element will not be specified.

The @IS-SIMPLIFIED attribute is set to false.

Parameters:

theValue - the Element value to set as the default for the THE-VALUE element, not null

Throws:

NotSavedException - if theValue contains file references and the ReqIF was not loaded or has not been saved

ValidationException - if theValue does not contain valid ReqIF XHTML

NotFoundException - if this AttributeDefinitionXHTML has been removed from its SpecType

setDefaultValue

public void setDefaultValue(java.lang.String theValue,
                            java.lang.String theOriginalValue,
                            boolean isSimplified)
                     throws java.lang.Exception,
                            NotFoundException

Sets the default values for this object by specifying ReqIF XHTML content using String values.

Parameters:

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

theOriginalValue - the String value to set as the default theOriginalValue can be null

isSimplified - the boolean value to set as the @IS_SIMPLIFIED attribute

Throws:

java.lang.Exception - if an error occurs during Element creation from the specified String parameters

NotFoundException - if this AttributeDefinitionXHTML has been removed from its SpecType

setDefaultValue

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

Sets the default for theValue value this object by specifying content as a String.

The Element object representing the THE-ORIGINAL-VALUE element will not be specified.

The @IS-SIMPLFIED attribute is set to false.

Parameters:

theValue - the String value to be converted to an Element object andset as the default for the THE-VALUE element, not null

Throws:

java.lang.Exception - if an error occurs during Element creation from the specified String parameter

NotFoundException - if this AttributeDefinitionXHTML has been removed from its SpecType