edu.uci.isr.xarch.instance
Interface IComponentInstance

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IPrescribedComponentInstance

All Known Implementing Classes:

ComponentInstanceImpl, PrescribedComponentInstanceImpl

public interface IComponentInstance

extends IXArchElement

Interface for accessing objects of the ComponentInstance 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	addInterfaceInstance(IInterfaceInstance newInterfaceInstance) Add a interfaceInstance to this ComponentInstance.
void	addInterfaceInstances(Collection interfaceInstances) Add a collection of interfaceInstances to this ComponentInstance.
void	clearDescription() Clear the description from this ComponentInstance.
void	clearId() Remove the id attribute from this ComponentInstance.
void	clearInterfaceInstances() Remove all interfaceInstances from this ComponentInstance.
void	clearSubArchitecture() Clear the subArchitecture from this ComponentInstance.
Collection	getAllInterfaceInstances() Get all the interfaceInstances from this ComponentInstance.
IDescription	getDescription() Get the description from this ComponentInstance.
String	getId() Get the id attribute from this ComponentInstance.
IInterfaceInstance	getInterfaceInstance(String id) Gets the interfaceInstance from this ComponentInstance with the given id.
Collection	getInterfaceInstances(Collection ids) Gets the interfaceInstances from this ComponentInstance with the given ids.
ISubArchitecture	getSubArchitecture() Get the subArchitecture from this ComponentInstance.
boolean	hasAllInterfaceInstances(Collection interfaceInstancesToCheck) Determine if this ComponentInstance contains each element in the given set of interfaceInstances.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ComponentInstance has the given description
boolean	hasId(String id) Determine if the id attribute on this ComponentInstance has the given value.
boolean	hasInterfaceInstance(IInterfaceInstance interfaceInstanceToCheck) Determine if this ComponentInstance contains a given interfaceInstance.
Collection	hasInterfaceInstances(Collection interfaceInstancesToCheck) Determine if this ComponentInstance contains the given set of interfaceInstances.
boolean	hasSubArchitecture(ISubArchitecture subArchitectureToCheck) Determine if this ComponentInstance has the given subArchitecture
boolean	isEqual(IComponentInstance ComponentInstanceToCheck) Determine if another ComponentInstance has the same id as this one.
boolean	isEquivalent(IComponentInstance ComponentInstanceToCheck) Determine if another ComponentInstance is equivalent to this one, ignoring ID's.
void	removeInterfaceInstance(IInterfaceInstance interfaceInstanceToRemove) Remove the given interfaceInstance from this ComponentInstance.
void	removeInterfaceInstances(Collection interfaceInstances) Remove all the given interfaceInstances from this ComponentInstance.
void	setDescription(IDescription value) Set the description for this ComponentInstance.
void	setId(String id) Set the id attribute on this ComponentInstance.
void	setSubArchitecture(ISubArchitecture value) Set the subArchitecture for this ComponentInstance.

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 ComponentInstance.

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 ComponentInstance.

getId

public String getId()

Get the id attribute from this ComponentInstance. 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 ComponentInstance

hasId

public boolean hasId(String id)

Determine if the id attribute on this ComponentInstance 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 ComponentInstance.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ComponentInstance.

getDescription

public IDescription getDescription()

Get the description from this ComponentInstance.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ComponentInstance has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addInterfaceInstance

public void addInterfaceInstance(IInterfaceInstance newInterfaceInstance)

Add a interfaceInstance to this ComponentInstance.

Parameters:

newInterfaceInstance - interfaceInstance to add.

addInterfaceInstances

public void addInterfaceInstances(Collection interfaceInstances)

Add a collection of interfaceInstances to this ComponentInstance.

Parameters:

interfaceInstances - interfaceInstances to add.

clearInterfaceInstances

public void clearInterfaceInstances()

Remove all interfaceInstances from this ComponentInstance.

removeInterfaceInstance

public void removeInterfaceInstance(IInterfaceInstance interfaceInstanceToRemove)

Remove the given interfaceInstance from this ComponentInstance. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceInstanceToRemove - interfaceInstance to remove.

removeInterfaceInstances

public void removeInterfaceInstances(Collection interfaceInstances)

Remove all the given interfaceInstances from this ComponentInstance. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceInstances - interfaceInstance to remove.

getAllInterfaceInstances

public Collection getAllInterfaceInstances()

Get all the interfaceInstances from this ComponentInstance.

Returns:

all interfaceInstances in this ComponentInstance.

hasInterfaceInstance

public boolean hasInterfaceInstance(IInterfaceInstance interfaceInstanceToCheck)

Determine if this ComponentInstance contains a given interfaceInstance.

Returns:

true if this ComponentInstance contains the given interfaceInstanceToCheck, false otherwise.

hasInterfaceInstances

public Collection hasInterfaceInstances(Collection interfaceInstancesToCheck)

Determine if this ComponentInstance contains the given set of interfaceInstances.

Parameters:

interfaceInstancesToCheck - interfaceInstances to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in interfaceInstances 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.

hasAllInterfaceInstances

public boolean hasAllInterfaceInstances(Collection interfaceInstancesToCheck)

Determine if this ComponentInstance contains each element in the given set of interfaceInstances.

Parameters:

interfaceInstancesToCheck - interfaceInstances to check for.

Returns:

true if every element in interfaceInstances is found in this ComponentInstance, false otherwise.

getInterfaceInstance

public IInterfaceInstance getInterfaceInstance(String id)

Gets the interfaceInstance from this ComponentInstance with the given id.

Parameters:

id - ID to look for.

Returns:

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

getInterfaceInstances

public Collection getInterfaceInstances(Collection ids)

Gets the interfaceInstances from this ComponentInstance with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

setSubArchitecture

public void setSubArchitecture(ISubArchitecture value)

Set the subArchitecture for this ComponentInstance.

Parameters:

value - new subArchitecture

clearSubArchitecture

public void clearSubArchitecture()

Clear the subArchitecture from this ComponentInstance.

getSubArchitecture

public ISubArchitecture getSubArchitecture()

Get the subArchitecture from this ComponentInstance.

Returns:

subArchitecture

hasSubArchitecture

public boolean hasSubArchitecture(ISubArchitecture subArchitectureToCheck)

Determine if this ComponentInstance has the given subArchitecture

Parameters:

subArchitectureToCheck - subArchitecture to compare

Returns:

true if the subArchitectures are equivalent, false otherwise

isEqual

public boolean isEqual(IComponentInstance ComponentInstanceToCheck)

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

Parameters:

ComponentInstanceToCheck - ComponentInstance to compare with this one.

isEquivalent

public boolean isEquivalent(IComponentInstance ComponentInstanceToCheck)

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

Parameters:

ComponentInstanceToCheck - ComponentInstance to compare to this one.

Returns:

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