edu.uci.isr.xarch.instance
Interface IArchInstance

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

ArchInstanceImpl

public interface IArchInstance

extends IXArchElement

Interface for accessing objects of the ArchInstance xsi:type in the instance namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	addComponentInstance(IComponentInstance newComponentInstance) Add a componentInstance to this ArchInstance.
void	addComponentInstances(Collection componentInstances) Add a collection of componentInstances to this ArchInstance.
void	addConnectorInstance(IConnectorInstance newConnectorInstance) Add a connectorInstance to this ArchInstance.
void	addConnectorInstances(Collection connectorInstances) Add a collection of connectorInstances to this ArchInstance.
void	addGroup(IGroup newGroup) Add a group to this ArchInstance.
void	addGroups(Collection groups) Add a collection of groups to this ArchInstance.
void	addLinkInstance(ILinkInstance newLinkInstance) Add a linkInstance to this ArchInstance.
void	addLinkInstances(Collection linkInstances) Add a collection of linkInstances to this ArchInstance.
void	clearComponentInstances() Remove all componentInstances from this ArchInstance.
void	clearConnectorInstances() Remove all connectorInstances from this ArchInstance.
void	clearDescription() Clear the description from this ArchInstance.
void	clearGroups() Remove all groups from this ArchInstance.
void	clearId() Remove the id attribute from this ArchInstance.
void	clearLinkInstances() Remove all linkInstances from this ArchInstance.
Collection	getAllComponentInstances() Get all the componentInstances from this ArchInstance.
Collection	getAllConnectorInstances() Get all the connectorInstances from this ArchInstance.
Collection	getAllGroups() Get all the groups from this ArchInstance.
Collection	getAllLinkInstances() Get all the linkInstances from this ArchInstance.
IComponentInstance	getComponentInstance(String id) Gets the componentInstance from this ArchInstance with the given id.
Collection	getComponentInstances(Collection ids) Gets the componentInstances from this ArchInstance with the given ids.
IConnectorInstance	getConnectorInstance(String id) Gets the connectorInstance from this ArchInstance with the given id.
Collection	getConnectorInstances(Collection ids) Gets the connectorInstances from this ArchInstance with the given ids.
IDescription	getDescription() Get the description from this ArchInstance.
IGroup	getGroup(String id) Gets the group from this ArchInstance with the given id.
Collection	getGroups(Collection ids) Gets the groups from this ArchInstance with the given ids.
String	getId() Get the id attribute from this ArchInstance.
ILinkInstance	getLinkInstance(String id) Gets the linkInstance from this ArchInstance with the given id.
Collection	getLinkInstances(Collection ids) Gets the linkInstances from this ArchInstance with the given ids.
boolean	hasAllComponentInstances(Collection componentInstancesToCheck) Determine if this ArchInstance contains each element in the given set of componentInstances.
boolean	hasAllConnectorInstances(Collection connectorInstancesToCheck) Determine if this ArchInstance contains each element in the given set of connectorInstances.
boolean	hasAllGroups(Collection groupsToCheck) Determine if this ArchInstance contains each element in the given set of groups.
boolean	hasAllLinkInstances(Collection linkInstancesToCheck) Determine if this ArchInstance contains each element in the given set of linkInstances.
boolean	hasComponentInstance(IComponentInstance componentInstanceToCheck) Determine if this ArchInstance contains a given componentInstance.
Collection	hasComponentInstances(Collection componentInstancesToCheck) Determine if this ArchInstance contains the given set of componentInstances.
boolean	hasConnectorInstance(IConnectorInstance connectorInstanceToCheck) Determine if this ArchInstance contains a given connectorInstance.
Collection	hasConnectorInstances(Collection connectorInstancesToCheck) Determine if this ArchInstance contains the given set of connectorInstances.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ArchInstance has the given description
boolean	hasGroup(IGroup groupToCheck) Determine if this ArchInstance contains a given group.
Collection	hasGroups(Collection groupsToCheck) Determine if this ArchInstance contains the given set of groups.
boolean	hasId(String id) Determine if the id attribute on this ArchInstance has the given value.
boolean	hasLinkInstance(ILinkInstance linkInstanceToCheck) Determine if this ArchInstance contains a given linkInstance.
Collection	hasLinkInstances(Collection linkInstancesToCheck) Determine if this ArchInstance contains the given set of linkInstances.
boolean	isEqual(IArchInstance ArchInstanceToCheck) Determine if another ArchInstance has the same id as this one.
boolean	isEquivalent(IArchInstance ArchInstanceToCheck) Determine if another ArchInstance is equivalent to this one, ignoring ID's.
void	removeComponentInstance(IComponentInstance componentInstanceToRemove) Remove the given componentInstance from this ArchInstance.
void	removeComponentInstances(Collection componentInstances) Remove all the given componentInstances from this ArchInstance.
void	removeConnectorInstance(IConnectorInstance connectorInstanceToRemove) Remove the given connectorInstance from this ArchInstance.
void	removeConnectorInstances(Collection connectorInstances) Remove all the given connectorInstances from this ArchInstance.
void	removeGroup(IGroup groupToRemove) Remove the given group from this ArchInstance.
void	removeGroups(Collection groups) Remove all the given groups from this ArchInstance.
void	removeLinkInstance(ILinkInstance linkInstanceToRemove) Remove the given linkInstance from this ArchInstance.
void	removeLinkInstances(Collection linkInstances) Remove all the given linkInstances from this ArchInstance.
void	setDescription(IDescription value) Set the description for this ArchInstance.
void	setId(String id) Set the id attribute on this ArchInstance.

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setId

public void setId(String id)

Set the id attribute on this ArchInstance.

Parameters:

id - id

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearId

public void clearId()

Remove the id attribute from this ArchInstance.

getId

public String getId()

Get the id attribute from this ArchInstance. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

id on this ArchInstance

hasId

public boolean hasId(String id)

Determine if the id attribute on this ArchInstance has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this ArchInstance.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ArchInstance.

getDescription

public IDescription getDescription()

Get the description from this ArchInstance.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ArchInstance has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addComponentInstance

public void addComponentInstance(IComponentInstance newComponentInstance)

Add a componentInstance to this ArchInstance.

Parameters:

newComponentInstance - componentInstance to add.

addComponentInstances

public void addComponentInstances(Collection componentInstances)

Add a collection of componentInstances to this ArchInstance.

Parameters:

componentInstances - componentInstances to add.

clearComponentInstances

public void clearComponentInstances()

Remove all componentInstances from this ArchInstance.

removeComponentInstance

public void removeComponentInstance(IComponentInstance componentInstanceToRemove)

Remove the given componentInstance from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

componentInstanceToRemove - componentInstance to remove.

removeComponentInstances

public void removeComponentInstances(Collection componentInstances)

Remove all the given componentInstances from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

componentInstances - componentInstance to remove.

getAllComponentInstances

public Collection getAllComponentInstances()

Get all the componentInstances from this ArchInstance.

Returns:

all componentInstances in this ArchInstance.

hasComponentInstance

public boolean hasComponentInstance(IComponentInstance componentInstanceToCheck)

Determine if this ArchInstance contains a given componentInstance.

Returns:

true if this ArchInstance contains the given componentInstanceToCheck, false otherwise.

hasComponentInstances

public Collection hasComponentInstances(Collection componentInstancesToCheck)

Determine if this ArchInstance contains the given set of componentInstances.

Parameters:

componentInstancesToCheck - componentInstances to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in componentInstances was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllComponentInstances

public boolean hasAllComponentInstances(Collection componentInstancesToCheck)

Determine if this ArchInstance contains each element in the given set of componentInstances.

Parameters:

componentInstancesToCheck - componentInstances to check for.

Returns:

true if every element in componentInstances is found in this ArchInstance, false otherwise.

getComponentInstance

public IComponentInstance getComponentInstance(String id)

Gets the componentInstance from this ArchInstance with the given id.

Parameters:

id - ID to look for.

Returns:

componentInstance with the given ID, or null if not found.

getComponentInstances

public Collection getComponentInstances(Collection ids)

Gets the componentInstances from this ArchInstance with the given ids.

Parameters:

ids - ID to look for.

Returns:

componentInstances with the given IDs. If an element with a given ID was not found, that ID is ignored.

addConnectorInstance

public void addConnectorInstance(IConnectorInstance newConnectorInstance)

Add a connectorInstance to this ArchInstance.

Parameters:

newConnectorInstance - connectorInstance to add.

addConnectorInstances

public void addConnectorInstances(Collection connectorInstances)

Add a collection of connectorInstances to this ArchInstance.

Parameters:

connectorInstances - connectorInstances to add.

clearConnectorInstances

public void clearConnectorInstances()

Remove all connectorInstances from this ArchInstance.

removeConnectorInstance

public void removeConnectorInstance(IConnectorInstance connectorInstanceToRemove)

Remove the given connectorInstance from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

connectorInstanceToRemove - connectorInstance to remove.

removeConnectorInstances

public void removeConnectorInstances(Collection connectorInstances)

Remove all the given connectorInstances from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

connectorInstances - connectorInstance to remove.

getAllConnectorInstances

public Collection getAllConnectorInstances()

Get all the connectorInstances from this ArchInstance.

Returns:

all connectorInstances in this ArchInstance.

hasConnectorInstance

public boolean hasConnectorInstance(IConnectorInstance connectorInstanceToCheck)

Determine if this ArchInstance contains a given connectorInstance.

Returns:

true if this ArchInstance contains the given connectorInstanceToCheck, false otherwise.

hasConnectorInstances

public Collection hasConnectorInstances(Collection connectorInstancesToCheck)

Determine if this ArchInstance contains the given set of connectorInstances.

Parameters:

connectorInstancesToCheck - connectorInstances to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in connectorInstances was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllConnectorInstances

public boolean hasAllConnectorInstances(Collection connectorInstancesToCheck)

Determine if this ArchInstance contains each element in the given set of connectorInstances.

Parameters:

connectorInstancesToCheck - connectorInstances to check for.

Returns:

true if every element in connectorInstances is found in this ArchInstance, false otherwise.

getConnectorInstance

public IConnectorInstance getConnectorInstance(String id)

Gets the connectorInstance from this ArchInstance with the given id.

Parameters:

id - ID to look for.

Returns:

connectorInstance with the given ID, or null if not found.

getConnectorInstances

public Collection getConnectorInstances(Collection ids)

Gets the connectorInstances from this ArchInstance with the given ids.

Parameters:

ids - ID to look for.

Returns:

connectorInstances with the given IDs. If an element with a given ID was not found, that ID is ignored.

addLinkInstance

public void addLinkInstance(ILinkInstance newLinkInstance)

Add a linkInstance to this ArchInstance.

Parameters:

newLinkInstance - linkInstance to add.

addLinkInstances

public void addLinkInstances(Collection linkInstances)

Add a collection of linkInstances to this ArchInstance.

Parameters:

linkInstances - linkInstances to add.

clearLinkInstances

public void clearLinkInstances()

Remove all linkInstances from this ArchInstance.

removeLinkInstance

public void removeLinkInstance(ILinkInstance linkInstanceToRemove)

Remove the given linkInstance from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

linkInstanceToRemove - linkInstance to remove.

removeLinkInstances

public void removeLinkInstances(Collection linkInstances)

Remove all the given linkInstances from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

linkInstances - linkInstance to remove.

getAllLinkInstances

public Collection getAllLinkInstances()

Get all the linkInstances from this ArchInstance.

Returns:

all linkInstances in this ArchInstance.

hasLinkInstance

public boolean hasLinkInstance(ILinkInstance linkInstanceToCheck)

Determine if this ArchInstance contains a given linkInstance.

Returns:

true if this ArchInstance contains the given linkInstanceToCheck, false otherwise.

hasLinkInstances

public Collection hasLinkInstances(Collection linkInstancesToCheck)

Determine if this ArchInstance contains the given set of linkInstances.

Parameters:

linkInstancesToCheck - linkInstances to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in linkInstances was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllLinkInstances

public boolean hasAllLinkInstances(Collection linkInstancesToCheck)

Determine if this ArchInstance contains each element in the given set of linkInstances.

Parameters:

linkInstancesToCheck - linkInstances to check for.

Returns:

true if every element in linkInstances is found in this ArchInstance, false otherwise.

getLinkInstance

public ILinkInstance getLinkInstance(String id)

Gets the linkInstance from this ArchInstance with the given id.

Parameters:

id - ID to look for.

Returns:

linkInstance with the given ID, or null if not found.

getLinkInstances

public Collection getLinkInstances(Collection ids)

Gets the linkInstances from this ArchInstance with the given ids.

Parameters:

ids - ID to look for.

Returns:

linkInstances with the given IDs. If an element with a given ID was not found, that ID is ignored.

addGroup

public void addGroup(IGroup newGroup)

Add a group to this ArchInstance.

Parameters:

newGroup - group to add.

addGroups

public void addGroups(Collection groups)

Add a collection of groups to this ArchInstance.

Parameters:

groups - groups to add.

clearGroups

public void clearGroups()

Remove all groups from this ArchInstance.

removeGroup

public void removeGroup(IGroup groupToRemove)

Remove the given group from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

groupToRemove - group to remove.

removeGroups

public void removeGroups(Collection groups)

Remove all the given groups from this ArchInstance. Matching is done by the isEquivalent(...) function.

Parameters:

groups - group to remove.

getAllGroups

public Collection getAllGroups()

Get all the groups from this ArchInstance.

Returns:

all groups in this ArchInstance.

hasGroup

public boolean hasGroup(IGroup groupToCheck)

Determine if this ArchInstance contains a given group.

Returns:

true if this ArchInstance contains the given groupToCheck, false otherwise.

hasGroups

public Collection hasGroups(Collection groupsToCheck)

Determine if this ArchInstance contains the given set of groups.

Parameters:

groupsToCheck - groups to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in groups was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllGroups

public boolean hasAllGroups(Collection groupsToCheck)

Determine if this ArchInstance contains each element in the given set of groups.

Parameters:

groupsToCheck - groups to check for.

Returns:

true if every element in groups is found in this ArchInstance, false otherwise.

getGroup

public IGroup getGroup(String id)

Gets the group from this ArchInstance with the given id.

Parameters:

id - ID to look for.

Returns:

group with the given ID, or null if not found.

getGroups

public Collection getGroups(Collection ids)

Gets the groups from this ArchInstance with the given ids.

Parameters:

ids - ID to look for.

Returns:

groups with the given IDs. If an element with a given ID was not found, that ID is ignored.

isEqual

public boolean isEqual(IArchInstance ArchInstanceToCheck)

Determine if another ArchInstance has the same id as this one.

Parameters:

ArchInstanceToCheck - ArchInstance to compare with this one.

isEquivalent

public boolean isEquivalent(IArchInstance ArchInstanceToCheck)

Determine if another ArchInstance is equivalent to this one, ignoring ID's.

Parameters:

ArchInstanceToCheck - ArchInstance to compare to this one.

Returns:

true if all the child elements of this ArchInstance are equivalent, false otherwise.