edu.uci.isr.xarch.versions
Interface IInterfaceTypeVersionGraph

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

InterfaceTypeVersionGraphImpl

public interface IInterfaceTypeVersionGraph

extends IXArchElement

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

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this InterfaceTypeVersionGraph.

getDescription

public IDescription getDescription()

Get the description from this InterfaceTypeVersionGraph.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this InterfaceTypeVersionGraph 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 InterfaceTypeVersionGraph.

Parameters:

newNode - node to add.

addNodes

public void addNodes(Collection nodes)

Add a collection of nodes to this InterfaceTypeVersionGraph.

Parameters:

nodes - nodes to add.

clearNodes

public void clearNodes()

Remove all nodes from this InterfaceTypeVersionGraph.

removeNode

public void removeNode(INode nodeToRemove)

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

Parameters:

nodes - node to remove.

getAllNodes

public Collection getAllNodes()

Get all the nodes from this InterfaceTypeVersionGraph.

Returns:

all nodes in this InterfaceTypeVersionGraph.

hasNode

public boolean hasNode(INode nodeToCheck)

Determine if this InterfaceTypeVersionGraph contains a given node.

Returns:

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

hasNodes

public Collection hasNodes(Collection nodesToCheck)

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

getNode

public INode getNode(String id)

Gets the node from this InterfaceTypeVersionGraph 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 InterfaceTypeVersionGraph 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(IInterfaceTypeVersionGraph InterfaceTypeVersionGraphToCheck)

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

Parameters:

InterfaceTypeVersionGraphToCheck - InterfaceTypeVersionGraph to compare with this one.

isEquivalent

public boolean isEquivalent(IInterfaceTypeVersionGraph InterfaceTypeVersionGraphToCheck)

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

Parameters:

InterfaceTypeVersionGraphToCheck - InterfaceTypeVersionGraph to compare to this one.

Returns:

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