com.reqdesign.reqif

Class SpecAttributes

java.lang.Object

com.reqdesign.reqif.SpecAttributes

All Implemented Interfaces:

java.lang.Iterable<AttributeDefinition<?>>

public final class SpecAttributes
extends java.lang.Object

Concrete collection class for AttributeDefinition objects and owned by SpecType.

Method Summary

Modifier and Type	Method and Description
boolean	contains(AttributeDefinition<?> attributeDefinition) Checks whether the specified AttributeDefinition 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
AttributeDefinitionBoolean	createAttributeDefinition(DatatypeDefinitionBoolean datatypeDefinitionBoolean, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionBoolean and adds it to this SpecType subclass.
AttributeDefinitionDate	createAttributeDefinition(DatatypeDefinitionDate datatypeDefinitionDate, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionDate and adds it to this SpecType subclass.
AttributeDefinitionEnumeration	createAttributeDefinition(DatatypeDefinitionEnumeration datatypeDefinitionEnumeration, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable, boolean multiValued) Constructs a new AttributeDefinitionEnumeration and adds it to this SpecType subclass.
AttributeDefinitionInteger	createAttributeDefinition(DatatypeDefinitionInteger datatypeDefinitionInteger, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionInteger and adds it to this SpecType subclass.
AttributeDefinitionReal	createAttributeDefinition(DatatypeDefinitionReal datatypeDefinitionReal, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionReal and adds it to this SpecType subclass.
AttributeDefinitionString	createAttributeDefinition(DatatypeDefinitionString datatypeDefinitionString, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionString and adds it to this SpecType subclass.
AttributeDefinitionXHTML	createAttributeDefinition(DatatypeDefinitionXHTML datatypeDefinitionXHTML, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeID, boolean isEditable) Constructs a new AttributeDefinitionXHTML and adds it to this SpecType subclass.
AttributeDefinition	find(java.lang.String longName) Returns the first occurrence of an AttributeDefinition object with the specified longName that is contained in this collection.
AttributeDefinition<?>	get(int index) Returns the AttributeDefinition object at the specified index that is contained in this collection.
AttributeDefinition<?>	get(java.lang.String identifier) Returns the AttributeDefinition object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<AttributeDefinition<?>>	iterator()
void	remove(AttributeDefinition<?> attributeDefinition) Removes a AttributeDefinition object from this collection.
java.util.stream.Stream<AttributeDefinition<?>>	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<AttributeDefinition<?>> stream()

iterator

public java.util.Iterator<AttributeDefinition<?>> iterator()

Specified by:

iterator in interface java.lang.Iterable<AttributeDefinition<?>>

get

public AttributeDefinition<?> get(int index)
                           throws java.lang.IndexOutOfBoundsException

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

Parameters:

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

Returns:

the AttributeDefinition object at the specified index

Throws:

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

get

public AttributeDefinition<?> get(java.lang.String identifier)
                           throws UnknownIdentifierException

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

Parameters:

identifier - the identifier of the collection member to return

Returns:

the AttributeDefinition subclass with the specified identifier

Throws:

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

find

public AttributeDefinition find(java.lang.String longName)

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

Parameters:

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

Returns:

the first occurrence of an AttributeDefinition subclass with the specified longName, can be null

contains

public boolean contains(AttributeDefinition<?> attributeDefinition)

Checks whether the specified AttributeDefinition exists in this collection.

Parameters:

attributeDefinition - the AttributeDefinition to check, not null

Returns:

returns true if the specified attributeDefinition exists, false otherwise

remove

public void remove(AttributeDefinition<?> attributeDefinition)
            throws NotFoundException,
                   ReferencedException

Removes a AttributeDefinition object from this collection.

Parameters:

attributeDefinition - the AttributeDefinition object to remove, not null

Throws:

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

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

createAttributeDefinition

public AttributeDefinitionBoolean createAttributeDefinition(DatatypeDefinitionBoolean datatypeDefinitionBoolean,
                                                            java.lang.String desc,
                                                            java.util.Date lastChange,
                                                            java.lang.String longName,
                                                            java.lang.String identifier,
                                                            java.lang.String alternativeID,
                                                            boolean isEditable)
                                                     throws NotFoundException,
                                                            DuplicateIdentifierException,
                                                            NotSupportedException,
                                                            InvalidIdentifierException

Constructs a new AttributeDefinitionBoolean and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionBoolean - the DatatypeDefinitionBoolean object on which to base this AttributeDefinitionBoolean object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionBoolean, not null

Throws:

NotFoundException - if datatypeDefinitionBoolean cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionDate createAttributeDefinition(DatatypeDefinitionDate datatypeDefinitionDate,
                                                         java.lang.String desc,
                                                         java.util.Date lastChange,
                                                         java.lang.String longName,
                                                         java.lang.String identifier,
                                                         java.lang.String alternativeID,
                                                         boolean isEditable)
                                                  throws NotFoundException,
                                                         DuplicateIdentifierException,
                                                         NotSupportedException,
                                                         InvalidIdentifierException

Constructs a new AttributeDefinitionDate and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionDate - the DatatypeDefinitionDate object on which to base this AttributeDefinitionDate object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionDate, not null

Throws:

NotFoundException - if datatypeDefinitionDate cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionEnumeration createAttributeDefinition(DatatypeDefinitionEnumeration datatypeDefinitionEnumeration,
                                                                java.lang.String desc,
                                                                java.util.Date lastChange,
                                                                java.lang.String longName,
                                                                java.lang.String identifier,
                                                                java.lang.String alternativeID,
                                                                boolean isEditable,
                                                                boolean multiValued)
                                                         throws NotFoundException,
                                                                DuplicateIdentifierException,
                                                                NotSupportedException,
                                                                InvalidIdentifierException

Constructs a new AttributeDefinitionEnumeration and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionEnumeration - the DatatypeDefinitionEnumeration object on which to base this AttributeDefinitionEnumeration object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

multiValued - the value to be assigned to the MULTI-VALUED attribute

Returns:

the created AttributeDefinitionEnumeration, not null

Throws:

NotFoundException - if datatypeDefinitionEnumeration cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionInteger createAttributeDefinition(DatatypeDefinitionInteger datatypeDefinitionInteger,
                                                            java.lang.String desc,
                                                            java.util.Date lastChange,
                                                            java.lang.String longName,
                                                            java.lang.String identifier,
                                                            java.lang.String alternativeID,
                                                            boolean isEditable)
                                                     throws NotFoundException,
                                                            DuplicateIdentifierException,
                                                            NotSupportedException,
                                                            InvalidIdentifierException

Constructs a new AttributeDefinitionInteger and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionInteger - the DatatypeDefinitionInteger object on which to base this AttributeDefinitionInteger object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionInteger, not null

Throws:

NotFoundException - if datatypeDefinitionInteger cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionReal createAttributeDefinition(DatatypeDefinitionReal datatypeDefinitionReal,
                                                         java.lang.String desc,
                                                         java.util.Date lastChange,
                                                         java.lang.String longName,
                                                         java.lang.String identifier,
                                                         java.lang.String alternativeID,
                                                         boolean isEditable)
                                                  throws NotFoundException,
                                                         DuplicateIdentifierException,
                                                         NotSupportedException,
                                                         InvalidIdentifierException

Constructs a new AttributeDefinitionReal and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionReal - the DatatypeDefinitionReal object on which to base this AttributeDefinitionReal object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionReal, not null

Throws:

NotFoundException - if datatypeDefinitionReal cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionString createAttributeDefinition(DatatypeDefinitionString datatypeDefinitionString,
                                                           java.lang.String desc,
                                                           java.util.Date lastChange,
                                                           java.lang.String longName,
                                                           java.lang.String identifier,
                                                           java.lang.String alternativeID,
                                                           boolean isEditable)
                                                    throws NotFoundException,
                                                           DuplicateIdentifierException,
                                                           NotSupportedException,
                                                           InvalidIdentifierException

Constructs a new AttributeDefinitionString and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionString - the DatatypeDefinitionString object on which to base this AttributeDefinitionString object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionString, not null

Throws:

NotFoundException - if datatypeDefinitionString cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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

createAttributeDefinition

public AttributeDefinitionXHTML createAttributeDefinition(DatatypeDefinitionXHTML datatypeDefinitionXHTML,
                                                          java.lang.String desc,
                                                          java.util.Date lastChange,
                                                          java.lang.String longName,
                                                          java.lang.String identifier,
                                                          java.lang.String alternativeID,
                                                          boolean isEditable)
                                                   throws NotFoundException,
                                                          DuplicateIdentifierException,
                                                          NotSupportedException,
                                                          InvalidIdentifierException

Constructs a new AttributeDefinitionXHTML and adds it to this SpecType subclass.

LONG-NAME is not optional and must be specified

Parameters:

datatypeDefinitionXHTML - the DatatypeDefinitionXHTML object on which to base this AttributeDefinitionXHTML object, not null

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, not null

identifier - the identifier 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

isEditable - the value to be assigned to the IS-EDITABLE attribute

Returns:

the created AttributeDefinitionXHTML, not null

Throws:

NotFoundException - if datatypeDefinitionXHTML cannot be found in the Datatypes collection, or this SpecType has been removed from the SpecTypes collection

DuplicateIdentifierException - if the specified identifier is not unique

NotSupportedException - if an attempt is made to add attribute definitions to a RelationGroupType object

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