com.reqdesign.reqif

Class AttributeValueXHTML

java.lang.Object

com.reqdesign.reqif.AttributeValue

com.reqdesign.reqif.AttributeValueXHTML

public final class AttributeValueXHTML
extends AttributeValue

Concrete specialization of the AttributeValue class specifically for XHTML values

This class extends from the base class AttributeValue.

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

 <ATTRIBUTE-VALUE-XHTML IS-SIMPLIFIED="isSimplified">
     <THE-VALUE>
         <reqif-xhtml:div xmlsn:reqif-xhtml="http://www.w3.org/1999/xhtml">...</reqif-xhtml:div>
     </THE-VALUE>
     <THE-ORIGINAL-VALUE>
         <reqif-xhtml:div xmlsn:reqif-xhtml="http://www.w3.org/1999/xhtml">...</reqif-xhtml:div>
     </THE-ORIGINAL-VALUE>
     ...
 </ATTRIBUTE-VALUE-XHTML>

The following is the list of XML attributes:

• @IS-SIMPLIFIED optional xsd:boolean if omitted, false is implied. If true, then theOriginalValue cannot be null

The XHTML top level content of either THE-VALUE or THE-ORIGINAL-VALUE should comprise a single div element in the http://www.w3.org/1999/xhtml namespace. Inside this element can be any other ReqIF XHTML compliant structures.

}

THE-ORIGINAL-VALUE is optional if isSimplified is false.

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Element	createXHTMLElement(java.lang.String text) Creates and initializes an Element object with the ReqIF XHTML namespace xmlns:reqif-xhtml=<"http://www.w3.org/1999/xhtml">
static org.w3c.dom.Element	createXHTMLElementFromXml(ReqIFFile reqIFFile, java.lang.String xmlText) Creates and initializes an Element object with the specified ReqIF XHTML XML.
static org.w3c.dom.Element	createXHTMLElementFromXml(ReqIFFile reqIFFile, java.lang.String xmlText, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Creates and initializes an Element object with the specified ReqIF XHTML XML with validation.
AttributeDefinitionXHTML	getAttributeDefinitionXHTML() The AttributeDefinitionXHTML associated with this attribute value
DatatypeDefinitionXHTML	getDatatypeDefinitionXHTML() The DatatypeDefinitionXHTML associated with this attribute value
java.lang.String	getDisplayText() Returns a String representation of the THE-VALUE ReqIF XHTML content.
java.util.List<ReferencedFile>	getReferencedFiles()
org.w3c.dom.Element	getTheOriginalValue() Returns the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content element.
org.w3c.dom.Element	getTheValue() Returns the Element object representing the THE-VALUE ReqIF XHTML content element.
java.lang.Object	getValue() Returns the native value as Object
boolean	isSimplified() Returns the value of the @IS-SIMPLIFIED attribute for this object.
void	setIsSimplified(boolean isSimplified) Sets the value of the @IS-SIMPLIFIED attribute for this object.
void	setTheOriginalValue(org.w3c.dom.Element theOriginalValue) Sets the Element representing the THE-ORIGINAL-VALUE ReqIF XHTML content.
void	setTheOriginalValue(org.w3c.dom.Element theOriginalValue, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Sets the Element representing the THE-ORIGINAL-VALUE ReqIF XHTML content with validation.
void	setTheValue(org.w3c.dom.Element theValue) Sets the Element representing the THE-VALUE ReqIF XHTML content with validation.
void	setTheValue(org.w3c.dom.Element theValue, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Sets the Element representing the THE-VALUE ReqIF XHTML content.
void	setTheValue(org.w3c.dom.Element theValue, org.w3c.dom.Element theOriginalValue, boolean isSimplified) Sets the Element representing the THE-VALUE ReqIF XHTML content with validation.
static boolean	validate(ReqIFFile reqIFFile, org.w3c.dom.Element theValue, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Validates the XML contents in the specified theValue Element parameter against the ReqIF XHTML standard.

Methods inherited from class com.reqdesign.reqif.AttributeValue

getAttributeDefinition, getAttributeDefinitionLongName, getDatatypeDefinition, getReqIFContent, getReqIFContent, getSpecElementWithAttributes

Methods inherited from class java.lang.Object

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

Method Detail

getReferencedFiles

public java.util.List<ReferencedFile> getReferencedFiles()

validate

public static boolean validate(ReqIFFile reqIFFile,
                               org.w3c.dom.Element theValue,
                               java.util.function.Consumer<ValidationMessage> validationMessageConsumer)

Validates the XML contents in the specified theValue Element parameter against the ReqIF XHTML standard.

Validation messages are sent to the Consumer parameter validationMessageConsumer

Parameters:

reqIFFile - the ReqIFFile object against which the validation is to be carried out, not null

theValue - the Element containing the XML to validate, not null

validationMessageConsumer - a consumer of validation messages, not null

Returns:

true if no validation errors occurred, false otherwise

createXHTMLElement

public static org.w3c.dom.Element createXHTMLElement(java.lang.String text)
                                              throws javax.xml.parsers.ParserConfigurationException

Creates and initializes an Element object with the ReqIF XHTML namespace xmlns:reqif-xhtml=<"http://www.w3.org/1999/xhtml">

Parameters:

text - the text content to apply to the div element, can be null

Returns:

the Element object comprising a single reqif-xhtml:div element set with the specified text content, not null

Throws:

javax.xml.parsers.ParserConfigurationException - if an error occurs during Element creation

createXHTMLElementFromXml

public static org.w3c.dom.Element createXHTMLElementFromXml(ReqIFFile reqIFFile,
                                                            java.lang.String xmlText)
                                                     throws ValidationException,
                                                            InvalidValueException,
                                                            java.lang.Exception

Creates and initializes an Element object with the specified ReqIF XHTML XML.

The specified XML must have appropriately specified namespace xmlns:reqif-xhtml=<"http://www.w3.org/1999/xhtml">

Parameters:

reqIFFile - the ReqIFFile object, not null

xmlText - the XML text to convert to an Element object, not null

Returns:

the Element object representing the specified XML text, not null

Throws:

java.lang.Exception - if an error occurs during XML Element creation

InvalidValueException - if either reqIFFile or xmlText parameters are null

ValidationException - if the XML does not conform to ReqIF XHTML standards

createXHTMLElementFromXml

public static org.w3c.dom.Element createXHTMLElementFromXml(ReqIFFile reqIFFile,
                                                            java.lang.String xmlText,
                                                            java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                                                     throws ValidationException,
                                                            java.lang.Exception

Creates and initializes an Element object with the specified ReqIF XHTML XML with validation.

The specified XML must have appropriately specified namespace xmlns:reqif-xhtml=<"http://www.w3.org/1999/xhtml">

Parameters:

reqIFFile - the ReqIFFile object, not null

xmlText - the XML text to convert to an Element object, not null

validationMessageConsumer - a consumer of validation message objects ValidationMessage, not null

Returns:

the Element object representing the specified XML text, not null

Throws:

java.lang.Exception - if an error occurs during XML Element creation

InvalidValueException - if either reqIFFile or xmlText or validationMessageConsumer parameters are null

ValidationException - if the XML does not conform to ReqIF XHTML standards

isSimplified

public boolean isSimplified()

Returns the value of the @IS-SIMPLIFIED attribute for this object.

If this flag is true, THE-ORIGINAL-VALUE must be specified.

Returns:

the {code boolean} value of the @IS-SIMPLIFIED attribute for this object

setIsSimplified

public void setIsSimplified(boolean isSimplified)
                     throws InvalidValueException

Sets the value of the @IS-SIMPLIFIED attribute for this object.

When setting this flag to true, ensure that theOriginalValue has been set to the original theValue content.

Parameters:

isSimplified - the value to set for the @IS-SIMPLIFIED attribute for this object

Throws:

InvalidValueException - if the flag is set to true but theOriginalValue has not be set

getTheOriginalValue

public org.w3c.dom.Element getTheOriginalValue()

Returns the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content element.

This Element must be set to a copy of the original theValue before setting isSimplified to true.

Returns:

the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content element, can be null

setTheOriginalValue

public void setTheOriginalValue(org.w3c.dom.Element theOriginalValue)
                         throws InvalidValueException,
                                ValidationException,
                                NotFoundException

Sets the Element representing the THE-ORIGINAL-VALUE ReqIF XHTML content.

Parameters:

theOriginalValue - the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content, can be null

Throws:

ValidationException - if the theOriginalValue element does not conform to ReqIF XHTML standards

NotFoundException - if the AttributeDefinitionXHTML for this AttributeValueXHTML was not found in the SpecType SpecAttributes collection

InvalidValueException - if isSimplified has been set but theOriginalValue is null

setTheOriginalValue

public void setTheOriginalValue(org.w3c.dom.Element theOriginalValue,
                                java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                         throws ValidationException,
                                NotFoundException

Sets the Element representing the THE-ORIGINAL-VALUE ReqIF XHTML content with validation.

Parameters:

theOriginalValue - the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content, not null

validationMessageConsumer - a consumer of validation messages, not null

Throws:

ValidationException - if the theOriginalValue element does not conform to ReqIF XHTML standards

NotFoundException - if the AttributeDefinitionXHTML for this AttributeValueXHTML was not found in the SpecType SpecAttributes collection

getTheValue

public org.w3c.dom.Element getTheValue()

Returns the Element object representing the THE-VALUE ReqIF XHTML content element.

Returns:

the Element object representing the THE-VALUE ReqIF XHTML content element, not null

setTheValue

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

Sets the Element representing the THE-VALUE ReqIF XHTML content with validation.

Parameters:

theValue - the Element object representing the THE-VALUE ReqIF XHTML content, not null

Throws:

ValidationException - if the theValue element does not conform to ReqIF XHTML standards

NotFoundException - if the AttributeDefinitionXHTML for this AttributeValueXHTML was not found in the SpecType SpecAttributes collection

setTheValue

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

Sets the Element representing the THE-VALUE ReqIF XHTML content with validation.

Parameters:

theValue - the Element object representing the THE-VALUE ReqIF XHTML content, not null

theOriginalValue - the Element object representing the THE-ORIGINAL-VALUE ReqIF XHTML content, can be null

isSimplified - boolean specifying whether THE-VALUE is a simplified version of the requirement content and consequently THE-ORIGINAL-VALUE is the original content

Throws:

ValidationException - if the theValue element does not conform to ReqIF XHTML standards

NotFoundException - if the AttributeDefinitionXHTML for this AttributeValueXHTML was not found in the SpecType SpecAttributes collection

setTheValue

public void setTheValue(org.w3c.dom.Element theValue,
                        java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                 throws ValidationException,
                        NotFoundException

Sets the Element representing the THE-VALUE ReqIF XHTML content.

Parameters:

theValue - the Element object representing the THE-VALUE ReqIF XHTML content, not null

validationMessageConsumer - a consumer of validation messages, not null

Throws:

ValidationException - if the theValue element does not conform to ReqIF XHTML standards

NotFoundException - if the AttributeDefinitionXHTML for this AttributeValueXHTML was not found in the SpecType SpecAttributes collection

getAttributeDefinitionXHTML

public AttributeDefinitionXHTML getAttributeDefinitionXHTML()

The AttributeDefinitionXHTML associated with this attribute value

Returns:

the AttributeDefinitionXHTML object associated with this object, not null

getDatatypeDefinitionXHTML

public DatatypeDefinitionXHTML getDatatypeDefinitionXHTML()

The DatatypeDefinitionXHTML associated with this attribute value

Returns:

the DatatypeDefinitionXHTML object associated with this object, not null

getDisplayText

public java.lang.String getDisplayText()

Returns a String representation of the THE-VALUE ReqIF XHTML content.

Specified by:

getDisplayText in class AttributeValue

Returns:

the String representation of the THE-VALUE REQIF XHTML content, not null

getValue

public java.lang.Object getValue()

Returns the native value as Object

Specified by:

getValue in class AttributeValue

Returns:

the theValue Element value as Object