com.reqdesign.reqif

Class Datatypes

java.lang.Object

com.reqdesign.reqif.Datatypes

All Implemented Interfaces:

java.lang.Iterable<DatatypeDefinition>

public final class Datatypes
extends java.lang.Object

This class is a collection class for DatatypeDefinition objects and represents the collection off all DatatypeDefinition objects defined in a ReqIF file.

The class wraps the <DATATYPES> element in a ReqIF file. The element can contain any number of child DATATYPE-DEFINITION elements.

Method Summary

Modifier and Type	Method and Description
boolean	contains(DatatypeDefinition datatypeDefinition) Checks whether the specified DatatypeDefinition exists in this collection.
boolean	containsIdentifiableWithLongName(java.lang.String longName) Checks for existence of an Identifiable in this collection with the specified longName.
boolean	containsKey(java.lang.String identifier) Checks whether this collection contains the Identifiable whose identfier matches that specified in the argument
DatatypeDefinitionBoolean	createDatatypeDefinitionBoolean(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new DatatypeDefinitionBoolean and adds it to this ReqIF.
DatatypeDefinitionDate	createDatatypeDefinitionDate(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new DatatypeDefinitionDate and adds it to this ReqIF.
DatatypeDefinitionEnumeration	createDatatypeDefinitionEnumeration(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new DatatypeDefinitionEnumeration and adds it to this ReqIF.
DatatypeDefinitionInteger	createDatatypeDefinitionInteger(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, long max, long min) Constructs a new DatatypeDefinitionInteger and adds it to this ReqIF.
DatatypeDefinitionReal	createDatatypeDefinitionReal(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, long accuracy, double max, double min) Constructs a new DatatypeDefinitionReal and adds it to this ReqIF.
DatatypeDefinitionString	createDatatypeDefinitionString(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, long maxLength) Constructs a new DatatypeDefinitionString and adds it to this ReqIF.
DatatypeDefinitionXHTML	createDatatypeDefinitionXHTML(java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID) Constructs a new DatatypeDefinitionXHTML and adds it to this ReqIF.
DatatypeDefinition	find(java.lang.String longName) Returns the first occurrence of a DatatypeDefinition object with the specified longName that is contained in this collection.
DatatypeDefinition	get(int index) Returns the DatatypeDefinition object at the specified index that is contained in this collection.
DatatypeDefinition	get(java.lang.String identifier) Returns the DatatypeDefinition object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<DatatypeDefinition>	iterator()
void	remove(DatatypeDefinition datatypeDefinition) Removes a DatatypeDefinition object from this collection.
java.util.stream.Stream<DatatypeDefinition>	stream()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

stream

public java.util.stream.Stream<DatatypeDefinition> stream()

iterator

public java.util.Iterator<DatatypeDefinition> iterator()

Specified by:

iterator in interface java.lang.Iterable<DatatypeDefinition>

get

public DatatypeDefinition get(int index)
                       throws java.lang.IndexOutOfBoundsException

Returns the DatatypeDefinition object at the specified index that is contained in this collection.

Parameters:

index - the index of the DatatypeDefinition to return from the collection, >= 0 and < collection size

Returns:

the DatatypeDefinition object at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if the index is < 0 or >= count

find

public DatatypeDefinition find(java.lang.String longName)

Returns the first occurrence of a DatatypeDefinition object with the specified longName that is contained in this collection.

Parameters:

longName - the longName of the DatatypeDefinition to return, not null

Returns:

the first occurrence of a DatatypeDefinition subclass with the specified longName, can be null

get

public DatatypeDefinition get(java.lang.String identifier)
                       throws UnknownIdentifierException

Returns the DatatypeDefinition object with the specified identifier that is contained in this collection.

Parameters:

identifier - the identifier of the collection member to return

Returns:

the DatatypeDefinition subclass with the specified identifier

Throws:

UnknownIdentifierException - if the object identified by the Identifier parameter can't be found

contains

public boolean contains(DatatypeDefinition datatypeDefinition)

Checks whether the specified DatatypeDefinition exists in this collection.

Parameters:

datatypeDefinition - the DatatypeDefinition to check, not null

Returns:

returns true if the specified datatypeDefinition exists, false otherwise

remove

public void remove(DatatypeDefinition datatypeDefinition)
            throws NotFoundException,
                   ReferencedException

Removes a DatatypeDefinition object from this collection.

Parameters:

datatypeDefinition - the DatatypeDefinition object to remove, not null

Throws:

NotFoundException - if the specified DatatypeDefinition object is not in the collection

ReferencedException - if the specified DatatypeDefinition object is referenced in other AttributeDefinition objects

createDatatypeDefinitionBoolean

public DatatypeDefinitionBoolean createDatatypeDefinitionBoolean(java.lang.String desc,
                                                                 java.util.Date lastChange,
                                                                 java.lang.String longName,
                                                                 java.lang.String identifier,
                                                                 java.lang.String alternativeID)
                                                          throws DuplicateIdentifierException,
                                                                 InvalidIdentifierException

Constructs a new DatatypeDefinitionBoolean and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

Returns:

the created DatatypeDefinitionBoolean, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionDate

public DatatypeDefinitionDate createDatatypeDefinitionDate(java.lang.String desc,
                                                           java.util.Date lastChange,
                                                           java.lang.String longName,
                                                           java.lang.String identifier,
                                                           java.lang.String alternativeID)
                                                    throws DuplicateIdentifierException,
                                                           InvalidIdentifierException

Constructs a new DatatypeDefinitionDate and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

Returns:

the created DatatypeDefinitionDate, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionEnumeration

public DatatypeDefinitionEnumeration createDatatypeDefinitionEnumeration(java.lang.String desc,
                                                                         java.util.Date lastChange,
                                                                         java.lang.String longName,
                                                                         java.lang.String identifier,
                                                                         java.lang.String alternativeID)
                                                                  throws DuplicateIdentifierException,
                                                                         InvalidIdentifierException

Constructs a new DatatypeDefinitionEnumeration and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

Returns:

the created DatatypeDefinitionEnumeration, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionInteger

public DatatypeDefinitionInteger createDatatypeDefinitionInteger(java.lang.String desc,
                                                                 java.util.Date lastChange,
                                                                 java.lang.String longName,
                                                                 java.lang.String identifier,
                                                                 java.lang.String alternativeID,
                                                                 long max,
                                                                 long min)
                                                          throws InvalidValueException,
                                                                 DuplicateIdentifierException,
                                                                 InvalidIdentifierException

Constructs a new DatatypeDefinitionInteger and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

max - the long value to be assigned to the MAX attribute, not null

min - the long value to be assigned to the MIN attribute, not null

Returns:

the created DatatypeDefinitionInteger, not null

Throws:

InvalidValueException - if max is less than min

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionReal

public DatatypeDefinitionReal createDatatypeDefinitionReal(java.lang.String desc,
                                                           java.util.Date lastChange,
                                                           java.lang.String longName,
                                                           java.lang.String identifier,
                                                           java.lang.String alternativeID,
                                                           long accuracy,
                                                           double max,
                                                           double min)
                                                    throws InvalidValueException,
                                                           DuplicateIdentifierException,
                                                           InvalidIdentifierException

Constructs a new DatatypeDefinitionReal and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

accuracy - the long value to be assigned to the ACCURACY attribute

max - the double value to be assigned to the MAX attribute

min - the double value to be assigned to the MIN attribute

Returns:

the created DatatypeDefinitionReal, not null

Throws:

InvalidValueException - if accuracy is negative or max is less than min

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionString

public DatatypeDefinitionString createDatatypeDefinitionString(java.lang.String desc,
                                                               java.util.Date lastChange,
                                                               java.lang.String longName,
                                                               java.lang.String identifier,
                                                               java.lang.String alternativeID,
                                                               long maxLength)
                                                        throws InvalidValueException,
                                                               DuplicateIdentifierException,
                                                               InvalidIdentifierException

Constructs a new DatatypeDefinitionString and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

maxLength - the long value to be assigned to the MAX-LENGTH attribute

Returns:

the created DatatypeDefinitionString, not null

Throws:

InvalidValueException - if maxLength is negative

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

createDatatypeDefinitionXHTML

public DatatypeDefinitionXHTML createDatatypeDefinitionXHTML(java.lang.String desc,
                                                             java.util.Date lastChange,
                                                             java.lang.String longName,
                                                             java.lang.String identifier,
                                                             java.lang.String alternativeID)
                                                      throws DuplicateIdentifierException,
                                                             InvalidIdentifierException

Constructs a new DatatypeDefinitionXHTML and adds it to this ReqIF.

Since LONG-NAME is optional it is permitted to create multiple datatype definitions with the same LONG-NAME even with different data types.

Parameters:

desc - the value to be assigned to the DESC attribute, can be null

lastChange - the date value to be assigned to the LAST-CHANGE attribute, can be null in which case 'now' is assigned

longName - the value to be assigned to the LONG-NAME attribute, can be null

identifier - the identifier in xsd:ID format to assign to this object, can be null to auto-assign

alternativeID - the value to be assigned to the ALTERNATIVE-ID::IDENTIFIER attribute, can be null

Returns:

the created DatatypeDefinitionXHTML, not null

Throws:

DuplicateIdentifierException - if the specified identifier is not unique

InvalidIdentifierException - if the specified identifier is not valid xsd:ID format

containsKey

public boolean containsKey(java.lang.String identifier)

Checks whether this collection contains the Identifiable whose identfier matches that specified in the argument

Parameters:

identifier - the identifier of the member to check for occurrence in the collection, not null

Returns:

true if the member having the specified identifier exists in the collection

containsIdentifiableWithLongName

public boolean containsIdentifiableWithLongName(java.lang.String longName)

Checks for existence of an Identifiable in this collection with the specified longName.

Parameters:

longName - the value of longName to check, nullable since longName can be null

Returns:

True if an Identifiable with the specified longName exists in this collection, otherwise false

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getCount

public int getCount()

Returns the count of items in this collection.

Returns:

the collection size