com.reqdesign.reqif

Class SpecRelations

java.lang.Object

com.reqdesign.reqif.SpecRelations

All Implemented Interfaces:

java.lang.Iterable<SpecRelation>

public final class SpecRelations
extends java.lang.Object

Concrete collection class for SpecRelation objects that also contains lookups for quick access of relations keyed by either the source or target identifiers.

Method Summary

Modifier and Type	Method and Description
boolean	contains(SpecRelation specRelation) Checks whether the specified SpecRelation 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
SpecRelation	createSpecRelation(SpecRelationType specRelationType, SpecObject sourceSpecObject, SpecObject targetSpecObject, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeId) Creates a SpecRelation object by specifying the source and target SpecObject objects
SpecRelation	createSpecRelation(SpecRelationType specRelationType, java.lang.String sourceSpecObjectIdentifier, java.lang.String targetSpecObjectIdentifier, java.lang.String desc, java.util.Date lastChange, java.lang.String longName, java.lang.String identifier, java.lang.String alternativeId) Creates a SpecRelation object by specifying the source and target SpecObject identifiers
SpecRelation	find(java.lang.String longName) Returns the first occurrence of a SpecRelation object with the specified longName that is contained in this collection.
SpecRelation	get(int index) Returns the SpecRelation object at the specified index that is contained in this collection.
SpecRelation	get(java.lang.String identifier) Returns the SpecRelation object with the specified identifier that is contained in this collection.
int	getCount() Returns the count of items in this collection.
java.util.Iterator<SpecRelation>	iterator()
void	remove(SpecRelation specRelation) Removes a SpecRelation object from this collection.
void	removeAll() Removes all (@code SpecRelation} objects from this collection.
java.util.stream.Stream<SpecRelation>	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

createSpecRelation

public SpecRelation createSpecRelation(SpecRelationType specRelationType,
                                       SpecObject sourceSpecObject,
                                       SpecObject targetSpecObject,
                                       java.lang.String desc,
                                       java.util.Date lastChange,
                                       java.lang.String longName,
                                       java.lang.String identifier,
                                       java.lang.String alternativeId)
                                throws DuplicateIdentifierException,
                                       InvalidIdentifierException

Creates a SpecRelation object by specifying the source and target SpecObject objects

Parameters:

specRelationType - the SpecRelationType of the SpecRelation to create, not null

sourceSpecObject - the SpecObject corresponding to the source, not null

targetSpecObject - the SpecObject corresponding to the target, not null

desc - the String value to sert for the description property, can be null

lastChange - the Date value to set for the lastChange property, set to null for 'now'

longName - the String value to set for the longName property, can be null

identifier - the String value to set for the identifier property (must confirm to xsd:ID), set to null to autogenerate

alternativeId - the String value to set for the alternativeId property, can be null

Returns:

a reference to the created SpecRelation, not null

Throws:

DuplicateIdentifierException - if the specified identifier is already used in this ReqIF file

InvalidIdentifierException - if the specified identifier does not confrom to xsd:ID format

createSpecRelation

public SpecRelation createSpecRelation(SpecRelationType specRelationType,
                                       java.lang.String sourceSpecObjectIdentifier,
                                       java.lang.String targetSpecObjectIdentifier,
                                       java.lang.String desc,
                                       java.util.Date lastChange,
                                       java.lang.String longName,
                                       java.lang.String identifier,
                                       java.lang.String alternativeId)
                                throws DuplicateIdentifierException,
                                       InvalidIdentifierException

Creates a SpecRelation object by specifying the source and target SpecObject identifiers

Parameters:

specRelationType - the SpecRelationType of the SpecRelation to create, not null

sourceSpecObjectIdentifier - the identifier of the SpecObject corresponding to the source, not null

targetSpecObjectIdentifier - the identifier of the SpecObject corresponding to the target, not null

desc - the String value to sert for the description property, can be null

lastChange - the Date value to set for the lastChange property, set to null for 'now'

longName - the String value to set for the longName property, can be null

identifier - the String value to set for the identifier property (must confirm to xsd:ID), set to null to autogenerate

alternativeId - the String value to set for the alternativeId property, can be null

Returns:

a reference to the created SpecRelation, not null

Throws:

DuplicateIdentifierException - if the specified identifier is already used in this ReqIF file

InvalidIdentifierException - if the specified identifier does not conform to xsd:ID format

stream

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<SpecRelation>

get

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

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

Parameters:

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

Returns:

the SpecRelation object at the specified index

Throws:

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

get

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

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

Parameters:

identifier - the identifier of the collection member to return, not null

Returns:

the SpecRelation subclass with the specified identifier

Throws:

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

find

public SpecRelation find(java.lang.String longName)

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

Parameters:

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

Returns:

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

contains

public boolean contains(SpecRelation specRelation)

Checks whether the specified SpecRelation exists in this collection.

Parameters:

specRelation - the SpecRelation to check, not null

Returns:

returns true if the specified specRelation exists, false otherwise

remove

public void remove(SpecRelation specRelation)
            throws NotFoundException,
                   ReferencedException

Removes a SpecRelation object from this collection.

Parameters:

specRelation - the SpecRelation object to remove, not null

Throws:

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

ReferencedException - if the specified SpecRelation object is referenced in other RelationGroup objects

removeAll

public void removeAll()
               throws ReferencedException

Removes all (@code SpecRelation} objects from this collection.

Throws:

ReferencedException - if at least one SpecRelation object is referenced in other RelationGroup objects

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