edu.uci.isr.xarch.types
Interface IArchTypes

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

ArchTypesImpl

public interface IArchTypes

extends IXArchElement

Interface for accessing objects of the ArchTypes xsi:type in the types 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	addComponentType(IComponentType newComponentType) Add a componentType to this ArchTypes.
void	addComponentTypes(Collection componentTypes) Add a collection of componentTypes to this ArchTypes.
void	addConnectorType(IConnectorType newConnectorType) Add a connectorType to this ArchTypes.
void	addConnectorTypes(Collection connectorTypes) Add a collection of connectorTypes to this ArchTypes.
void	addInterfaceType(IInterfaceType newInterfaceType) Add a interfaceType to this ArchTypes.
void	addInterfaceTypes(Collection interfaceTypes) Add a collection of interfaceTypes to this ArchTypes.
void	clearComponentTypes() Remove all componentTypes from this ArchTypes.
void	clearConnectorTypes() Remove all connectorTypes from this ArchTypes.
void	clearInterfaceTypes() Remove all interfaceTypes from this ArchTypes.
Collection	getAllComponentTypes() Get all the componentTypes from this ArchTypes.
Collection	getAllConnectorTypes() Get all the connectorTypes from this ArchTypes.
Collection	getAllInterfaceTypes() Get all the interfaceTypes from this ArchTypes.
IComponentType	getComponentType(String id) Gets the componentType from this ArchTypes with the given id.
Collection	getComponentTypes(Collection ids) Gets the componentTypes from this ArchTypes with the given ids.
IConnectorType	getConnectorType(String id) Gets the connectorType from this ArchTypes with the given id.
Collection	getConnectorTypes(Collection ids) Gets the connectorTypes from this ArchTypes with the given ids.
IInterfaceType	getInterfaceType(String id) Gets the interfaceType from this ArchTypes with the given id.
Collection	getInterfaceTypes(Collection ids) Gets the interfaceTypes from this ArchTypes with the given ids.
boolean	hasAllComponentTypes(Collection componentTypesToCheck) Determine if this ArchTypes contains each element in the given set of componentTypes.
boolean	hasAllConnectorTypes(Collection connectorTypesToCheck) Determine if this ArchTypes contains each element in the given set of connectorTypes.
boolean	hasAllInterfaceTypes(Collection interfaceTypesToCheck) Determine if this ArchTypes contains each element in the given set of interfaceTypes.
boolean	hasComponentType(IComponentType componentTypeToCheck) Determine if this ArchTypes contains a given componentType.
Collection	hasComponentTypes(Collection componentTypesToCheck) Determine if this ArchTypes contains the given set of componentTypes.
boolean	hasConnectorType(IConnectorType connectorTypeToCheck) Determine if this ArchTypes contains a given connectorType.
Collection	hasConnectorTypes(Collection connectorTypesToCheck) Determine if this ArchTypes contains the given set of connectorTypes.
boolean	hasInterfaceType(IInterfaceType interfaceTypeToCheck) Determine if this ArchTypes contains a given interfaceType.
Collection	hasInterfaceTypes(Collection interfaceTypesToCheck) Determine if this ArchTypes contains the given set of interfaceTypes.
boolean	isEquivalent(IArchTypes ArchTypesToCheck) Determine if another ArchTypes is equivalent to this one, ignoring ID's.
void	removeComponentType(IComponentType componentTypeToRemove) Remove the given componentType from this ArchTypes.
void	removeComponentTypes(Collection componentTypes) Remove all the given componentTypes from this ArchTypes.
void	removeConnectorType(IConnectorType connectorTypeToRemove) Remove the given connectorType from this ArchTypes.
void	removeConnectorTypes(Collection connectorTypes) Remove all the given connectorTypes from this ArchTypes.
void	removeInterfaceType(IInterfaceType interfaceTypeToRemove) Remove the given interfaceType from this ArchTypes.
void	removeInterfaceTypes(Collection interfaceTypes) Remove all the given interfaceTypes from this ArchTypes.

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

addComponentType

public void addComponentType(IComponentType newComponentType)

Add a componentType to this ArchTypes.

Parameters:

newComponentType - componentType to add.

addComponentTypes

public void addComponentTypes(Collection componentTypes)

Add a collection of componentTypes to this ArchTypes.

Parameters:

componentTypes - componentTypes to add.

clearComponentTypes

public void clearComponentTypes()

Remove all componentTypes from this ArchTypes.

removeComponentType

public void removeComponentType(IComponentType componentTypeToRemove)

Remove the given componentType from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

componentTypeToRemove - componentType to remove.

removeComponentTypes

public void removeComponentTypes(Collection componentTypes)

Remove all the given componentTypes from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

componentTypes - componentType to remove.

getAllComponentTypes

public Collection getAllComponentTypes()

Get all the componentTypes from this ArchTypes.

Returns:

all componentTypes in this ArchTypes.

hasComponentType

public boolean hasComponentType(IComponentType componentTypeToCheck)

Determine if this ArchTypes contains a given componentType.

Returns:

true if this ArchTypes contains the given componentTypeToCheck, false otherwise.

hasComponentTypes

public Collection hasComponentTypes(Collection componentTypesToCheck)

Determine if this ArchTypes contains the given set of componentTypes.

Parameters:

componentTypesToCheck - componentTypes to check for.

Returns:

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

hasAllComponentTypes

public boolean hasAllComponentTypes(Collection componentTypesToCheck)

Determine if this ArchTypes contains each element in the given set of componentTypes.

Parameters:

componentTypesToCheck - componentTypes to check for.

Returns:

true if every element in componentTypes is found in this ArchTypes, false otherwise.

getComponentType

public IComponentType getComponentType(String id)

Gets the componentType from this ArchTypes with the given id.

Parameters:

id - ID to look for.

Returns:

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

getComponentTypes

public Collection getComponentTypes(Collection ids)

Gets the componentTypes from this ArchTypes with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

addConnectorType

public void addConnectorType(IConnectorType newConnectorType)

Add a connectorType to this ArchTypes.

Parameters:

newConnectorType - connectorType to add.

addConnectorTypes

public void addConnectorTypes(Collection connectorTypes)

Add a collection of connectorTypes to this ArchTypes.

Parameters:

connectorTypes - connectorTypes to add.

clearConnectorTypes

public void clearConnectorTypes()

Remove all connectorTypes from this ArchTypes.

removeConnectorType

public void removeConnectorType(IConnectorType connectorTypeToRemove)

Remove the given connectorType from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

connectorTypeToRemove - connectorType to remove.

removeConnectorTypes

public void removeConnectorTypes(Collection connectorTypes)

Remove all the given connectorTypes from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

connectorTypes - connectorType to remove.

getAllConnectorTypes

public Collection getAllConnectorTypes()

Get all the connectorTypes from this ArchTypes.

Returns:

all connectorTypes in this ArchTypes.

hasConnectorType

public boolean hasConnectorType(IConnectorType connectorTypeToCheck)

Determine if this ArchTypes contains a given connectorType.

Returns:

true if this ArchTypes contains the given connectorTypeToCheck, false otherwise.

hasConnectorTypes

public Collection hasConnectorTypes(Collection connectorTypesToCheck)

Determine if this ArchTypes contains the given set of connectorTypes.

Parameters:

connectorTypesToCheck - connectorTypes to check for.

Returns:

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

hasAllConnectorTypes

public boolean hasAllConnectorTypes(Collection connectorTypesToCheck)

Determine if this ArchTypes contains each element in the given set of connectorTypes.

Parameters:

connectorTypesToCheck - connectorTypes to check for.

Returns:

true if every element in connectorTypes is found in this ArchTypes, false otherwise.

getConnectorType

public IConnectorType getConnectorType(String id)

Gets the connectorType from this ArchTypes with the given id.

Parameters:

id - ID to look for.

Returns:

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

getConnectorTypes

public Collection getConnectorTypes(Collection ids)

Gets the connectorTypes from this ArchTypes with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

addInterfaceType

public void addInterfaceType(IInterfaceType newInterfaceType)

Add a interfaceType to this ArchTypes.

Parameters:

newInterfaceType - interfaceType to add.

addInterfaceTypes

public void addInterfaceTypes(Collection interfaceTypes)

Add a collection of interfaceTypes to this ArchTypes.

Parameters:

interfaceTypes - interfaceTypes to add.

clearInterfaceTypes

public void clearInterfaceTypes()

Remove all interfaceTypes from this ArchTypes.

removeInterfaceType

public void removeInterfaceType(IInterfaceType interfaceTypeToRemove)

Remove the given interfaceType from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceTypeToRemove - interfaceType to remove.

removeInterfaceTypes

public void removeInterfaceTypes(Collection interfaceTypes)

Remove all the given interfaceTypes from this ArchTypes. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceTypes - interfaceType to remove.

getAllInterfaceTypes

public Collection getAllInterfaceTypes()

Get all the interfaceTypes from this ArchTypes.

Returns:

all interfaceTypes in this ArchTypes.

hasInterfaceType

public boolean hasInterfaceType(IInterfaceType interfaceTypeToCheck)

Determine if this ArchTypes contains a given interfaceType.

Returns:

true if this ArchTypes contains the given interfaceTypeToCheck, false otherwise.

hasInterfaceTypes

public Collection hasInterfaceTypes(Collection interfaceTypesToCheck)

Determine if this ArchTypes contains the given set of interfaceTypes.

Parameters:

interfaceTypesToCheck - interfaceTypes to check for.

Returns:

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

hasAllInterfaceTypes

public boolean hasAllInterfaceTypes(Collection interfaceTypesToCheck)

Determine if this ArchTypes contains each element in the given set of interfaceTypes.

Parameters:

interfaceTypesToCheck - interfaceTypes to check for.

Returns:

true if every element in interfaceTypes is found in this ArchTypes, false otherwise.

getInterfaceType

public IInterfaceType getInterfaceType(String id)

Gets the interfaceType from this ArchTypes with the given id.

Parameters:

id - ID to look for.

Returns:

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

getInterfaceTypes

public Collection getInterfaceTypes(Collection ids)

Gets the interfaceTypes from this ArchTypes with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

isEquivalent

public boolean isEquivalent(IArchTypes ArchTypesToCheck)

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

Parameters:

ArchTypesToCheck - ArchTypes to compare to this one.

Returns:

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