com.reqdesign.reqif

Class EmbeddedValue

java.lang.Object

com.reqdesign.reqif.EmbeddedValue

public final class EmbeddedValue
extends java.lang.Object

Class representing additional information related to enumeration literals.

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

<EMBEDDED-VALUE KEY="key" OTHER-CONTENT="otherContent">

The following is the common list of XML attributes:

• @KEY required xsd:integer - the numerical value corresponding to the enumeration literal
• @OTHER-CONTENT required xsd:string - arbitrary additional information related to the enumeration literal (for example, a color.)

Method Summary

Modifier and Type	Method and Description
long	getKey() Gets the @KEY XML attribute for this object.
java.lang.String	getKeyText() Gets the String representation for the KEY attribute for this EmbeddedValue object
java.lang.String	getOtherContent() Gets the @OTHER-CONTENT XML attribute for this object.
void	setKey(long key) Sets the value of the @KEY attribute to the specified value
void	setOtherContent(java.lang.String otherContent) Sets the @OTHER-CONTENT attribute to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOtherContent

public java.lang.String getOtherContent()

Gets the @OTHER-CONTENT XML attribute for this object.

Returns:

the value of the EmbeddedValue OTHER-CONTENT XML string attribute

setOtherContent

public void setOtherContent(java.lang.String otherContent)
                     throws NotFoundException

Sets the @OTHER-CONTENT attribute to the specified value.

Parameters:

otherContent - the value to set for the @OTHER-CONTENT attribute, not null

Throws:

NotFoundException - if the owning DatatypeDefinitionEnumeration has been removed from the Datatypes collection

getKey

public long getKey()

Gets the @KEY XML attribute for this object.

Returns:

the value of the EmbeddedValue KEY XML integer attribute

getKeyText

public java.lang.String getKeyText()

Gets the String representation for the KEY attribute for this EmbeddedValue object

Returns:

the String representation for the KEY attribute for this EmbeddedValue object

setKey

public void setKey(long key)
            throws NotFoundException

Sets the value of the @KEY attribute to the specified value

Parameters:

key - the value to set for the @KEY attribute

Throws:

NotFoundException - if the owning DatatypeDefinitionEnumeration has been removed from the Datatypes collection