edu.uci.isr.xarch.types
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 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	addSignatureInterfaceMapping(ISignatureInterfaceMapping newSignatureInterfaceMapping) Add a signatureInterfaceMapping to this SubArchitecture.
void	addSignatureInterfaceMappings(Collection signatureInterfaceMappings) Add a collection of signatureInterfaceMappings to this SubArchitecture.
void	clearArchStructure() Clear the archStructure from this SubArchitecture.
void	clearSignatureInterfaceMappings() Remove all signatureInterfaceMappings from this SubArchitecture.
Collection	getAllSignatureInterfaceMappings() Get all the signatureInterfaceMappings from this SubArchitecture.
IXMLLink	getArchStructure() Get the archStructure from this SubArchitecture.
ISignatureInterfaceMapping	getSignatureInterfaceMapping(String id) Gets the signatureInterfaceMapping from this SubArchitecture with the given id.
Collection	getSignatureInterfaceMappings(Collection ids) Gets the signatureInterfaceMappings from this SubArchitecture with the given ids.
boolean	hasAllSignatureInterfaceMappings(Collection signatureInterfaceMappingsToCheck) Determine if this SubArchitecture contains each element in the given set of signatureInterfaceMappings.
boolean	hasArchStructure(IXMLLink archStructureToCheck) Determine if this SubArchitecture has the given archStructure
boolean	hasSignatureInterfaceMapping(ISignatureInterfaceMapping signatureInterfaceMappingToCheck) Determine if this SubArchitecture contains a given signatureInterfaceMapping.
Collection	hasSignatureInterfaceMappings(Collection signatureInterfaceMappingsToCheck) Determine if this SubArchitecture contains the given set of signatureInterfaceMappings.
boolean	isEquivalent(ISubArchitecture SubArchitectureToCheck) Determine if another SubArchitecture is equivalent to this one, ignoring ID's.
void	removeSignatureInterfaceMapping(ISignatureInterfaceMapping signatureInterfaceMappingToRemove) Remove the given signatureInterfaceMapping from this SubArchitecture.
void	removeSignatureInterfaceMappings(Collection signatureInterfaceMappings) Remove all the given signatureInterfaceMappings from this SubArchitecture.
void	setArchStructure(IXMLLink value) Set the archStructure 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

setArchStructure

public void setArchStructure(IXMLLink value)

Set the archStructure for this SubArchitecture.

Parameters:

value - new archStructure

clearArchStructure

public void clearArchStructure()

Clear the archStructure from this SubArchitecture.

getArchStructure

public IXMLLink getArchStructure()

Get the archStructure from this SubArchitecture.

Returns:

archStructure

hasArchStructure

public boolean hasArchStructure(IXMLLink archStructureToCheck)

Determine if this SubArchitecture has the given archStructure

Parameters:

archStructureToCheck - archStructure to compare

Returns:

true if the archStructures are equivalent, false otherwise

addSignatureInterfaceMapping

public void addSignatureInterfaceMapping(ISignatureInterfaceMapping newSignatureInterfaceMapping)

Add a signatureInterfaceMapping to this SubArchitecture.

Parameters:

newSignatureInterfaceMapping - signatureInterfaceMapping to add.

addSignatureInterfaceMappings

public void addSignatureInterfaceMappings(Collection signatureInterfaceMappings)

Add a collection of signatureInterfaceMappings to this SubArchitecture.

Parameters:

signatureInterfaceMappings - signatureInterfaceMappings to add.

clearSignatureInterfaceMappings

public void clearSignatureInterfaceMappings()

Remove all signatureInterfaceMappings from this SubArchitecture.

removeSignatureInterfaceMapping

public void removeSignatureInterfaceMapping(ISignatureInterfaceMapping signatureInterfaceMappingToRemove)

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

Parameters:

signatureInterfaceMappingToRemove - signatureInterfaceMapping to remove.

removeSignatureInterfaceMappings

public void removeSignatureInterfaceMappings(Collection signatureInterfaceMappings)

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

Parameters:

signatureInterfaceMappings - signatureInterfaceMapping to remove.

getAllSignatureInterfaceMappings

public Collection getAllSignatureInterfaceMappings()

Get all the signatureInterfaceMappings from this SubArchitecture.

Returns:

all signatureInterfaceMappings in this SubArchitecture.

hasSignatureInterfaceMapping

public boolean hasSignatureInterfaceMapping(ISignatureInterfaceMapping signatureInterfaceMappingToCheck)

Determine if this SubArchitecture contains a given signatureInterfaceMapping.

Returns:

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

hasSignatureInterfaceMappings

public Collection hasSignatureInterfaceMappings(Collection signatureInterfaceMappingsToCheck)

Determine if this SubArchitecture contains the given set of signatureInterfaceMappings.

Parameters:

signatureInterfaceMappingsToCheck - signatureInterfaceMappings to check for.

Returns:

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

hasAllSignatureInterfaceMappings

public boolean hasAllSignatureInterfaceMappings(Collection signatureInterfaceMappingsToCheck)

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

Parameters:

signatureInterfaceMappingsToCheck - signatureInterfaceMappings to check for.

Returns:

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

getSignatureInterfaceMapping

public ISignatureInterfaceMapping getSignatureInterfaceMapping(String id)

Gets the signatureInterfaceMapping from this SubArchitecture with the given id.

Parameters:

id - ID to look for.

Returns:

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

getSignatureInterfaceMappings

public Collection getSignatureInterfaceMappings(Collection ids)

Gets the signatureInterfaceMappings from this SubArchitecture with the given ids.

Parameters:

ids - ID to look for.

Returns:

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