edu.uci.isr.xarch.types
Interface IArchStructure

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

ArchStructureImpl

public interface IArchStructure

extends IXArchElement

Interface for accessing objects of the ArchStructure 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	addComponent(IComponent newComponent) Add a component to this ArchStructure.
void	addComponents(Collection components) Add a collection of components to this ArchStructure.
void	addConnector(IConnector newConnector) Add a connector to this ArchStructure.
void	addConnectors(Collection connectors) Add a collection of connectors to this ArchStructure.
void	addGroup(IGroup newGroup) Add a group to this ArchStructure.
void	addGroups(Collection groups) Add a collection of groups to this ArchStructure.
void	addLink(ILink newLink) Add a link to this ArchStructure.
void	addLinks(Collection links) Add a collection of links to this ArchStructure.
void	clearComponents() Remove all components from this ArchStructure.
void	clearConnectors() Remove all connectors from this ArchStructure.
void	clearDescription() Clear the description from this ArchStructure.
void	clearGroups() Remove all groups from this ArchStructure.
void	clearId() Remove the id attribute from this ArchStructure.
void	clearLinks() Remove all links from this ArchStructure.
Collection	getAllComponents() Get all the components from this ArchStructure.
Collection	getAllConnectors() Get all the connectors from this ArchStructure.
Collection	getAllGroups() Get all the groups from this ArchStructure.
Collection	getAllLinks() Get all the links from this ArchStructure.
IComponent	getComponent(String id) Gets the component from this ArchStructure with the given id.
Collection	getComponents(Collection ids) Gets the components from this ArchStructure with the given ids.
IConnector	getConnector(String id) Gets the connector from this ArchStructure with the given id.
Collection	getConnectors(Collection ids) Gets the connectors from this ArchStructure with the given ids.
IDescription	getDescription() Get the description from this ArchStructure.
IGroup	getGroup(String id) Gets the group from this ArchStructure with the given id.
Collection	getGroups(Collection ids) Gets the groups from this ArchStructure with the given ids.
String	getId() Get the id attribute from this ArchStructure.
ILink	getLink(String id) Gets the link from this ArchStructure with the given id.
Collection	getLinks(Collection ids) Gets the links from this ArchStructure with the given ids.
boolean	hasAllComponents(Collection componentsToCheck) Determine if this ArchStructure contains each element in the given set of components.
boolean	hasAllConnectors(Collection connectorsToCheck) Determine if this ArchStructure contains each element in the given set of connectors.
boolean	hasAllGroups(Collection groupsToCheck) Determine if this ArchStructure contains each element in the given set of groups.
boolean	hasAllLinks(Collection linksToCheck) Determine if this ArchStructure contains each element in the given set of links.
boolean	hasComponent(IComponent componentToCheck) Determine if this ArchStructure contains a given component.
Collection	hasComponents(Collection componentsToCheck) Determine if this ArchStructure contains the given set of components.
boolean	hasConnector(IConnector connectorToCheck) Determine if this ArchStructure contains a given connector.
Collection	hasConnectors(Collection connectorsToCheck) Determine if this ArchStructure contains the given set of connectors.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ArchStructure has the given description
boolean	hasGroup(IGroup groupToCheck) Determine if this ArchStructure contains a given group.
Collection	hasGroups(Collection groupsToCheck) Determine if this ArchStructure contains the given set of groups.
boolean	hasId(String id) Determine if the id attribute on this ArchStructure has the given value.
boolean	hasLink(ILink linkToCheck) Determine if this ArchStructure contains a given link.
Collection	hasLinks(Collection linksToCheck) Determine if this ArchStructure contains the given set of links.
boolean	isEqual(IArchStructure ArchStructureToCheck) Determine if another ArchStructure has the same id as this one.
boolean	isEquivalent(IArchStructure ArchStructureToCheck) Determine if another ArchStructure is equivalent to this one, ignoring ID's.
void	removeComponent(IComponent componentToRemove) Remove the given component from this ArchStructure.
void	removeComponents(Collection components) Remove all the given components from this ArchStructure.
void	removeConnector(IConnector connectorToRemove) Remove the given connector from this ArchStructure.
void	removeConnectors(Collection connectors) Remove all the given connectors from this ArchStructure.
void	removeGroup(IGroup groupToRemove) Remove the given group from this ArchStructure.
void	removeGroups(Collection groups) Remove all the given groups from this ArchStructure.
void	removeLink(ILink linkToRemove) Remove the given link from this ArchStructure.
void	removeLinks(Collection links) Remove all the given links from this ArchStructure.
void	setDescription(IDescription value) Set the description for this ArchStructure.
void	setId(String id) Set the id attribute on this ArchStructure.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ArchStructure.

getDescription

public IDescription getDescription()

Get the description from this ArchStructure.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ArchStructure has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addComponent

public void addComponent(IComponent newComponent)

Add a component to this ArchStructure.

Parameters:

newComponent - component to add.

addComponents

public void addComponents(Collection components)

Add a collection of components to this ArchStructure.

Parameters:

components - components to add.

clearComponents

public void clearComponents()

Remove all components from this ArchStructure.

removeComponent

public void removeComponent(IComponent componentToRemove)

Remove the given component from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

componentToRemove - component to remove.

removeComponents

public void removeComponents(Collection components)

Remove all the given components from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

components - component to remove.

getAllComponents

public Collection getAllComponents()

Get all the components from this ArchStructure.

Returns:

all components in this ArchStructure.

hasComponent

public boolean hasComponent(IComponent componentToCheck)

Determine if this ArchStructure contains a given component.

Returns:

true if this ArchStructure contains the given componentToCheck, false otherwise.

hasComponents

public Collection hasComponents(Collection componentsToCheck)

Determine if this ArchStructure contains the given set of components.

Parameters:

componentsToCheck - components to check for.

Returns:

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

hasAllComponents

public boolean hasAllComponents(Collection componentsToCheck)

Determine if this ArchStructure contains each element in the given set of components.

Parameters:

componentsToCheck - components to check for.

Returns:

true if every element in components is found in this ArchStructure, false otherwise.

getComponent

public IComponent getComponent(String id)

Gets the component from this ArchStructure with the given id.

Parameters:

id - ID to look for.

Returns:

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

getComponents

public Collection getComponents(Collection ids)

Gets the components from this ArchStructure with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

addConnector

public void addConnector(IConnector newConnector)

Add a connector to this ArchStructure.

Parameters:

newConnector - connector to add.

addConnectors

public void addConnectors(Collection connectors)

Add a collection of connectors to this ArchStructure.

Parameters:

connectors - connectors to add.

clearConnectors

public void clearConnectors()

Remove all connectors from this ArchStructure.

removeConnector

public void removeConnector(IConnector connectorToRemove)

Remove the given connector from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

connectorToRemove - connector to remove.

removeConnectors

public void removeConnectors(Collection connectors)

Remove all the given connectors from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

connectors - connector to remove.

getAllConnectors

public Collection getAllConnectors()

Get all the connectors from this ArchStructure.

Returns:

all connectors in this ArchStructure.

hasConnector

public boolean hasConnector(IConnector connectorToCheck)

Determine if this ArchStructure contains a given connector.

Returns:

true if this ArchStructure contains the given connectorToCheck, false otherwise.

hasConnectors

public Collection hasConnectors(Collection connectorsToCheck)

Determine if this ArchStructure contains the given set of connectors.

Parameters:

connectorsToCheck - connectors to check for.

Returns:

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

hasAllConnectors

public boolean hasAllConnectors(Collection connectorsToCheck)

Determine if this ArchStructure contains each element in the given set of connectors.

Parameters:

connectorsToCheck - connectors to check for.

Returns:

true if every element in connectors is found in this ArchStructure, false otherwise.

getConnector

public IConnector getConnector(String id)

Gets the connector from this ArchStructure with the given id.

Parameters:

id - ID to look for.

Returns:

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

getConnectors

public Collection getConnectors(Collection ids)

Gets the connectors from this ArchStructure with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

addLink

public void addLink(ILink newLink)

Add a link to this ArchStructure.

Parameters:

newLink - link to add.

addLinks

public void addLinks(Collection links)

Add a collection of links to this ArchStructure.

Parameters:

links - links to add.

clearLinks

public void clearLinks()

Remove all links from this ArchStructure.

removeLink

public void removeLink(ILink linkToRemove)

Remove the given link from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

linkToRemove - link to remove.

removeLinks

public void removeLinks(Collection links)

Remove all the given links from this ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

links - link to remove.

getAllLinks

public Collection getAllLinks()

Get all the links from this ArchStructure.

Returns:

all links in this ArchStructure.

hasLink

public boolean hasLink(ILink linkToCheck)

Determine if this ArchStructure contains a given link.

Returns:

true if this ArchStructure contains the given linkToCheck, false otherwise.

hasLinks

public Collection hasLinks(Collection linksToCheck)

Determine if this ArchStructure contains the given set of links.

Parameters:

linksToCheck - links to check for.

Returns:

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

hasAllLinks

public boolean hasAllLinks(Collection linksToCheck)

Determine if this ArchStructure contains each element in the given set of links.

Parameters:

linksToCheck - links to check for.

Returns:

true if every element in links is found in this ArchStructure, false otherwise.

getLink

public ILink getLink(String id)

Gets the link from this ArchStructure with the given id.

Parameters:

id - ID to look for.

Returns:

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

getLinks

public Collection getLinks(Collection ids)

Gets the links from this ArchStructure with the given ids.

Parameters:

ids - ID to look for.

Returns:

links 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 ArchStructure.

Parameters:

newGroup - group to add.

addGroups

public void addGroups(Collection groups)

Add a collection of groups to this ArchStructure.

Parameters:

groups - groups to add.

clearGroups

public void clearGroups()

Remove all groups from this ArchStructure.

removeGroup

public void removeGroup(IGroup groupToRemove)

Remove the given group from this ArchStructure. 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 ArchStructure. Matching is done by the isEquivalent(...) function.

Parameters:

groups - group to remove.

getAllGroups

public Collection getAllGroups()

Get all the groups from this ArchStructure.

Returns:

all groups in this ArchStructure.

hasGroup

public boolean hasGroup(IGroup groupToCheck)

Determine if this ArchStructure contains a given group.

Returns:

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

hasGroups

public Collection hasGroups(Collection groupsToCheck)

Determine if this ArchStructure 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 ArchStructure 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 ArchStructure, false otherwise.

getGroup

public IGroup getGroup(String id)

Gets the group from this ArchStructure 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 ArchStructure 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(IArchStructure ArchStructureToCheck)

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

Parameters:

ArchStructureToCheck - ArchStructure to compare with this one.

isEquivalent

public boolean isEquivalent(IArchStructure ArchStructureToCheck)

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

Parameters:

ArchStructureToCheck - ArchStructure to compare to this one.

Returns:

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