edu.uci.isr.xarch.versions
Interface IComponentTypeVersionGraph

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

ComponentTypeVersionGraphImpl

public interface IComponentTypeVersionGraph

extends IXArchElement

Interface for accessing objects of the ComponentTypeVersionGraph xsi:type in the versions 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	addNode(INode newNode) Add a node to this ComponentTypeVersionGraph.
void	addNodes(Collection nodes) Add a collection of nodes to this ComponentTypeVersionGraph.
void	clearDescription() Clear the description from this ComponentTypeVersionGraph.
void	clearId() Remove the id attribute from this ComponentTypeVersionGraph.
void	clearNodes() Remove all nodes from this ComponentTypeVersionGraph.
Collection	getAllNodes() Get all the nodes from this ComponentTypeVersionGraph.
IDescription	getDescription() Get the description from this ComponentTypeVersionGraph.
String	getId() Get the id attribute from this ComponentTypeVersionGraph.
INode	getNode(String id) Gets the node from this ComponentTypeVersionGraph with the given id.
Collection	getNodes(Collection ids) Gets the nodes from this ComponentTypeVersionGraph with the given ids.
boolean	hasAllNodes(Collection nodesToCheck) Determine if this ComponentTypeVersionGraph contains each element in the given set of nodes.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ComponentTypeVersionGraph has the given description
boolean	hasId(String id) Determine if the id attribute on this ComponentTypeVersionGraph has the given value.
boolean	hasNode(INode nodeToCheck) Determine if this ComponentTypeVersionGraph contains a given node.
Collection	hasNodes(Collection nodesToCheck) Determine if this ComponentTypeVersionGraph contains the given set of nodes.
boolean	isEqual(IComponentTypeVersionGraph ComponentTypeVersionGraphToCheck) Determine if another ComponentTypeVersionGraph has the same id as this one.
boolean	isEquivalent(IComponentTypeVersionGraph ComponentTypeVersionGraphToCheck) Determine if another ComponentTypeVersionGraph is equivalent to this one, ignoring ID's.
void	removeNode(INode nodeToRemove) Remove the given node from this ComponentTypeVersionGraph.
void	removeNodes(Collection nodes) Remove all the given nodes from this ComponentTypeVersionGraph.
void	setDescription(IDescription value) Set the description for this ComponentTypeVersionGraph.
void	setId(String id) Set the id attribute on this ComponentTypeVersionGraph.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ComponentTypeVersionGraph.

getDescription

public IDescription getDescription()

Get the description from this ComponentTypeVersionGraph.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ComponentTypeVersionGraph has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addNode

public void addNode(INode newNode)

Add a node to this ComponentTypeVersionGraph.

Parameters:

newNode - node to add.

addNodes

public void addNodes(Collection nodes)

Add a collection of nodes to this ComponentTypeVersionGraph.

Parameters:

nodes - nodes to add.

clearNodes

public void clearNodes()

Remove all nodes from this ComponentTypeVersionGraph.

removeNode

public void removeNode(INode nodeToRemove)

Remove the given node from this ComponentTypeVersionGraph. Matching is done by the isEquivalent(...) function.

Parameters:

nodeToRemove - node to remove.

removeNodes

public void removeNodes(Collection nodes)

Remove all the given nodes from this ComponentTypeVersionGraph. Matching is done by the isEquivalent(...) function.

Parameters:

nodes - node to remove.

getAllNodes

public Collection getAllNodes()

Get all the nodes from this ComponentTypeVersionGraph.

Returns:

all nodes in this ComponentTypeVersionGraph.

hasNode

public boolean hasNode(INode nodeToCheck)

Determine if this ComponentTypeVersionGraph contains a given node.

Returns:

true if this ComponentTypeVersionGraph contains the given nodeToCheck, false otherwise.

hasNodes

public Collection hasNodes(Collection nodesToCheck)

Determine if this ComponentTypeVersionGraph contains the given set of nodes.

Parameters:

nodesToCheck - nodes to check for.

Returns:

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

hasAllNodes

public boolean hasAllNodes(Collection nodesToCheck)

Determine if this ComponentTypeVersionGraph contains each element in the given set of nodes.

Parameters:

nodesToCheck - nodes to check for.

Returns:

true if every element in nodes is found in this ComponentTypeVersionGraph, false otherwise.

getNode

public INode getNode(String id)

Gets the node from this ComponentTypeVersionGraph with the given id.

Parameters:

id - ID to look for.

Returns:

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

getNodes

public Collection getNodes(Collection ids)

Gets the nodes from this ComponentTypeVersionGraph with the given ids.

Parameters:

ids - ID to look for.

Returns:

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

isEqual

public boolean isEqual(IComponentTypeVersionGraph ComponentTypeVersionGraphToCheck)

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

Parameters:

ComponentTypeVersionGraphToCheck - ComponentTypeVersionGraph to compare with this one.

isEquivalent

public boolean isEquivalent(IComponentTypeVersionGraph ComponentTypeVersionGraphToCheck)

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

Parameters:

ComponentTypeVersionGraphToCheck - ComponentTypeVersionGraph to compare to this one.

Returns:

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