edu.uci.isr.xarch.versions
Interface INode

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

NodeImpl

public interface INode

extends IXArchElement

Interface for accessing objects of the Node 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	addParent(IXMLLink newParent) Add a parent to this Node.
void	addParents(Collection parents) Add a collection of parents to this Node.
void	clearId() Remove the id attribute from this Node.
void	clearImmutable() Remove the immutable attribute from this Node.
void	clearParents() Remove all parents from this Node.
void	clearVersionID() Clear the versionID from this Node.
Collection	getAllParents() Get all the parents from this Node.
String	getId() Get the id attribute from this Node.
String	getImmutable() Get the immutable attribute from this Node.
IVersionID	getVersionID() Get the versionID from this Node.
boolean	hasAllParents(Collection parentsToCheck) Determine if this Node contains each element in the given set of parents.
boolean	hasId(String id) Determine if the id attribute on this Node has the given value.
boolean	hasImmutable(String immutable) Determine if the immutable attribute on this Node has the given value.
boolean	hasParent(IXMLLink parentToCheck) Determine if this Node contains a given parent.
Collection	hasParents(Collection parentsToCheck) Determine if this Node contains the given set of parents.
boolean	hasVersionID(IVersionID versionIDToCheck) Determine if this Node has the given versionID
boolean	isEqual(INode NodeToCheck) Determine if another Node has the same id as this one.
boolean	isEquivalent(INode NodeToCheck) Determine if another Node is equivalent to this one, ignoring ID's.
void	removeParent(IXMLLink parentToRemove) Remove the given parent from this Node.
void	removeParents(Collection parents) Remove all the given parents from this Node.
void	setId(String id) Set the id attribute on this Node.
void	setImmutable(String immutable) Set the immutable attribute on this Node.
void	setVersionID(IVersionID value) Set the versionID for this Node.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

Determine if the id attribute on this Node has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setImmutable

public void setImmutable(String immutable)

Set the immutable attribute on this Node.

Parameters:

immutable - immutable

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearImmutable

public void clearImmutable()

Remove the immutable attribute from this Node.

getImmutable

public String getImmutable()

Get the immutable attribute from this Node. 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:

immutable on this Node

hasImmutable

public boolean hasImmutable(String immutable)

Determine if the immutable attribute on this Node has the given value.

Parameters:

immutable - Attribute value to compare

Returns:

true if they match; false otherwise.

setVersionID

public void setVersionID(IVersionID value)

Set the versionID for this Node.

Parameters:

value - new versionID

clearVersionID

public void clearVersionID()

Clear the versionID from this Node.

getVersionID

public IVersionID getVersionID()

Get the versionID from this Node.

Returns:

versionID

hasVersionID

public boolean hasVersionID(IVersionID versionIDToCheck)

Determine if this Node has the given versionID

Parameters:

versionIDToCheck - versionID to compare

Returns:

true if the versionIDs are equivalent, false otherwise

addParent

public void addParent(IXMLLink newParent)

Add a parent to this Node.

Parameters:

newParent - parent to add.

addParents

public void addParents(Collection parents)

Add a collection of parents to this Node.

Parameters:

parents - parents to add.

clearParents

public void clearParents()

Remove all parents from this Node.

removeParent

public void removeParent(IXMLLink parentToRemove)

Remove the given parent from this Node. Matching is done by the isEquivalent(...) function.

Parameters:

parentToRemove - parent to remove.

removeParents

public void removeParents(Collection parents)

Remove all the given parents from this Node. Matching is done by the isEquivalent(...) function.

Parameters:

parents - parent to remove.

getAllParents

public Collection getAllParents()

Get all the parents from this Node.

Returns:

all parents in this Node.

hasParent

public boolean hasParent(IXMLLink parentToCheck)

Determine if this Node contains a given parent.

Returns:

true if this Node contains the given parentToCheck, false otherwise.

hasParents

public Collection hasParents(Collection parentsToCheck)

Determine if this Node contains the given set of parents.

Parameters:

parentsToCheck - parents to check for.

Returns:

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

hasAllParents

public boolean hasAllParents(Collection parentsToCheck)

Determine if this Node contains each element in the given set of parents.

Parameters:

parentsToCheck - parents to check for.

Returns:

true if every element in parents is found in this Node, false otherwise.

isEqual

public boolean isEqual(INode NodeToCheck)

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

Parameters:

NodeToCheck - Node to compare with this one.

isEquivalent

public boolean isEquivalent(INode NodeToCheck)

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

Parameters:

NodeToCheck - Node to compare to this one.

Returns:

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