edu.uci.isr.xarch.menage
Interface IPosition

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

PositionImpl

public interface IPosition

extends IXArchElement

Interface for accessing objects of the Position xsi:type in the menage 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	clearX() Remove the x attribute from this Position.
void	clearY() Remove the y attribute from this Position.
String	getX() Get the x attribute from this Position.
String	getY() Get the y attribute from this Position.
boolean	hasX(String x) Determine if the x attribute on this Position has the given value.
boolean	hasY(String y) Determine if the y attribute on this Position has the given value.
boolean	isEquivalent(IPosition PositionToCheck) Determine if another Position is equivalent to this one, ignoring ID's.
void	setX(String x) Set the x attribute on this Position.
void	setY(String y) Set the y attribute on this Position.

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

setX

public void setX(String x)

Set the x attribute on this Position.

Parameters:

x - x

Throws:

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

clearX

public void clearX()

Remove the x attribute from this Position.

getX

public String getX()

Get the x attribute from this Position. 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:

x on this Position

hasX

public boolean hasX(String x)

Determine if the x attribute on this Position has the given value.

Parameters:

x - Attribute value to compare

Returns:

true if they match; false otherwise.

setY

public void setY(String y)

Set the y attribute on this Position.

Parameters:

y - y

Throws:

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

clearY

public void clearY()

Remove the y attribute from this Position.

getY

public String getY()

Get the y attribute from this Position. 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:

y on this Position

hasY

public boolean hasY(String y)

Determine if the y attribute on this Position has the given value.

Parameters:

y - Attribute value to compare

Returns:

true if they match; false otherwise.

isEquivalent

public boolean isEquivalent(IPosition PositionToCheck)

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

Parameters:

PositionToCheck - Position to compare to this one.

Returns:

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