edu.uci.isr.xarch.instance
Interface ISubArchitecture

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

SubArchitectureImpl

public interface ISubArchitecture

extends IXArchElement

Interface for accessing objects of the SubArchitecture 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	addInterfaceInstanceMapping(IInterfaceInstanceMapping newInterfaceInstanceMapping) Add a interfaceInstanceMapping to this SubArchitecture.
void	addInterfaceInstanceMappings(Collection interfaceInstanceMappings) Add a collection of interfaceInstanceMappings to this SubArchitecture.
void	clearArchInstance() Clear the archInstance from this SubArchitecture.
void	clearInterfaceInstanceMappings() Remove all interfaceInstanceMappings from this SubArchitecture.
Collection	getAllInterfaceInstanceMappings() Get all the interfaceInstanceMappings from this SubArchitecture.
IArchInstance	getArchInstance() Get the archInstance from this SubArchitecture.
IInterfaceInstanceMapping	getInterfaceInstanceMapping(String id) Gets the interfaceInstanceMapping from this SubArchitecture with the given id.
Collection	getInterfaceInstanceMappings(Collection ids) Gets the interfaceInstanceMappings from this SubArchitecture with the given ids.
boolean	hasAllInterfaceInstanceMappings(Collection interfaceInstanceMappingsToCheck) Determine if this SubArchitecture contains each element in the given set of interfaceInstanceMappings.
boolean	hasArchInstance(IArchInstance archInstanceToCheck) Determine if this SubArchitecture has the given archInstance
boolean	hasInterfaceInstanceMapping(IInterfaceInstanceMapping interfaceInstanceMappingToCheck) Determine if this SubArchitecture contains a given interfaceInstanceMapping.
Collection	hasInterfaceInstanceMappings(Collection interfaceInstanceMappingsToCheck) Determine if this SubArchitecture contains the given set of interfaceInstanceMappings.
boolean	isEquivalent(ISubArchitecture SubArchitectureToCheck) Determine if another SubArchitecture is equivalent to this one, ignoring ID's.
void	removeInterfaceInstanceMapping(IInterfaceInstanceMapping interfaceInstanceMappingToRemove) Remove the given interfaceInstanceMapping from this SubArchitecture.
void	removeInterfaceInstanceMappings(Collection interfaceInstanceMappings) Remove all the given interfaceInstanceMappings from this SubArchitecture.
void	setArchInstance(IArchInstance value) Set the archInstance for this SubArchitecture.

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

setArchInstance

public void setArchInstance(IArchInstance value)

Set the archInstance for this SubArchitecture.

Parameters:

value - new archInstance

clearArchInstance

public void clearArchInstance()

Clear the archInstance from this SubArchitecture.

getArchInstance

public IArchInstance getArchInstance()

Get the archInstance from this SubArchitecture.

Returns:

archInstance

hasArchInstance

public boolean hasArchInstance(IArchInstance archInstanceToCheck)

Determine if this SubArchitecture has the given archInstance

Parameters:

archInstanceToCheck - archInstance to compare

Returns:

true if the archInstances are equivalent, false otherwise

addInterfaceInstanceMapping

public void addInterfaceInstanceMapping(IInterfaceInstanceMapping newInterfaceInstanceMapping)

Add a interfaceInstanceMapping to this SubArchitecture.

Parameters:

newInterfaceInstanceMapping - interfaceInstanceMapping to add.

addInterfaceInstanceMappings

public void addInterfaceInstanceMappings(Collection interfaceInstanceMappings)

Add a collection of interfaceInstanceMappings to this SubArchitecture.

Parameters:

interfaceInstanceMappings - interfaceInstanceMappings to add.

clearInterfaceInstanceMappings

public void clearInterfaceInstanceMappings()

Remove all interfaceInstanceMappings from this SubArchitecture.

removeInterfaceInstanceMapping

public void removeInterfaceInstanceMapping(IInterfaceInstanceMapping interfaceInstanceMappingToRemove)

Remove the given interfaceInstanceMapping from this SubArchitecture. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceInstanceMappingToRemove - interfaceInstanceMapping to remove.

removeInterfaceInstanceMappings

public void removeInterfaceInstanceMappings(Collection interfaceInstanceMappings)

Remove all the given interfaceInstanceMappings from this SubArchitecture. Matching is done by the isEquivalent(...) function.

Parameters:

interfaceInstanceMappings - interfaceInstanceMapping to remove.

getAllInterfaceInstanceMappings

public Collection getAllInterfaceInstanceMappings()

Get all the interfaceInstanceMappings from this SubArchitecture.

Returns:

all interfaceInstanceMappings in this SubArchitecture.

hasInterfaceInstanceMapping

public boolean hasInterfaceInstanceMapping(IInterfaceInstanceMapping interfaceInstanceMappingToCheck)

Determine if this SubArchitecture contains a given interfaceInstanceMapping.

Returns:

true if this SubArchitecture contains the given interfaceInstanceMappingToCheck, false otherwise.

hasInterfaceInstanceMappings

public Collection hasInterfaceInstanceMappings(Collection interfaceInstanceMappingsToCheck)

Determine if this SubArchitecture contains the given set of interfaceInstanceMappings.

Parameters:

interfaceInstanceMappingsToCheck - interfaceInstanceMappings to check for.

Returns:

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

hasAllInterfaceInstanceMappings

public boolean hasAllInterfaceInstanceMappings(Collection interfaceInstanceMappingsToCheck)

Determine if this SubArchitecture contains each element in the given set of interfaceInstanceMappings.

Parameters:

interfaceInstanceMappingsToCheck - interfaceInstanceMappings to check for.

Returns:

true if every element in interfaceInstanceMappings is found in this SubArchitecture, false otherwise.

getInterfaceInstanceMapping

public IInterfaceInstanceMapping getInterfaceInstanceMapping(String id)

Gets the interfaceInstanceMapping from this SubArchitecture with the given id.

Parameters:

id - ID to look for.

Returns:

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

getInterfaceInstanceMappings

public Collection getInterfaceInstanceMappings(Collection ids)

Gets the interfaceInstanceMappings from this SubArchitecture with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

isEquivalent

public boolean isEquivalent(ISubArchitecture SubArchitectureToCheck)

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

Parameters:

SubArchitectureToCheck - SubArchitecture to compare to this one.

Returns:

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