edu.uci.isr.xarch.instance
Interface ILinkInstance

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IPrescribedLinkInstance

All Known Implementing Classes:

LinkInstanceImpl, PrescribedLinkInstanceImpl

public interface ILinkInstance

extends IXArchElement

Interface for accessing objects of the LinkInstance xsi:type in the instance 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	addPoint(IPoint newPoint) Add a point to this LinkInstance.
void	addPoints(Collection points) Add a collection of points to this LinkInstance.
void	clearDescription() Clear the description from this LinkInstance.
void	clearId() Remove the id attribute from this LinkInstance.
void	clearPoints() Remove all points from this LinkInstance.
Collection	getAllPoints() Get all the points from this LinkInstance.
IDescription	getDescription() Get the description from this LinkInstance.
String	getId() Get the id attribute from this LinkInstance.
boolean	hasAllPoints(Collection pointsToCheck) Determine if this LinkInstance contains each element in the given set of points.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this LinkInstance has the given description
boolean	hasId(String id) Determine if the id attribute on this LinkInstance has the given value.
boolean	hasPoint(IPoint pointToCheck) Determine if this LinkInstance contains a given point.
Collection	hasPoints(Collection pointsToCheck) Determine if this LinkInstance contains the given set of points.
boolean	isEqual(ILinkInstance LinkInstanceToCheck) Determine if another LinkInstance has the same id as this one.
boolean	isEquivalent(ILinkInstance LinkInstanceToCheck) Determine if another LinkInstance is equivalent to this one, ignoring ID's.
void	removePoint(IPoint pointToRemove) Remove the given point from this LinkInstance.
void	removePoints(Collection points) Remove all the given points from this LinkInstance.
void	setDescription(IDescription value) Set the description for this LinkInstance.
void	setId(String id) Set the id attribute on this LinkInstance.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this LinkInstance.

getDescription

public IDescription getDescription()

Get the description from this LinkInstance.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this LinkInstance has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addPoint

public void addPoint(IPoint newPoint)

Add a point to this LinkInstance.

Parameters:

newPoint - point to add.

addPoints

public void addPoints(Collection points)

Add a collection of points to this LinkInstance.

Parameters:

points - points to add.

clearPoints

public void clearPoints()

Remove all points from this LinkInstance.

removePoint

public void removePoint(IPoint pointToRemove)

Remove the given point from this LinkInstance. Matching is done by the isEquivalent(...) function.

Parameters:

pointToRemove - point to remove.

removePoints

public void removePoints(Collection points)

Remove all the given points from this LinkInstance. Matching is done by the isEquivalent(...) function.

Parameters:

points - point to remove.

getAllPoints

public Collection getAllPoints()

Get all the points from this LinkInstance.

Returns:

all points in this LinkInstance.

hasPoint

public boolean hasPoint(IPoint pointToCheck)

Determine if this LinkInstance contains a given point.

Returns:

true if this LinkInstance contains the given pointToCheck, false otherwise.

hasPoints

public Collection hasPoints(Collection pointsToCheck)

Determine if this LinkInstance contains the given set of points.

Parameters:

pointsToCheck - points to check for.

Returns:

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

hasAllPoints

public boolean hasAllPoints(Collection pointsToCheck)

Determine if this LinkInstance contains each element in the given set of points.

Parameters:

pointsToCheck - points to check for.

Returns:

true if every element in points is found in this LinkInstance, false otherwise.

isEqual

public boolean isEqual(ILinkInstance LinkInstanceToCheck)

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

Parameters:

LinkInstanceToCheck - LinkInstance to compare with this one.

isEquivalent

public boolean isEquivalent(ILinkInstance LinkInstanceToCheck)

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

Parameters:

LinkInstanceToCheck - LinkInstance to compare to this one.

Returns:

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