edu.uci.isr.xarch.instance
Class InterfaceInstanceImpl

java.lang.Object
  edu.uci.isr.xarch.instance.InterfaceInstanceImpl

All Implemented Interfaces:

DOMBased, IInterfaceInstance, IXArchElement

Direct Known Subclasses:

PrescribedInterfaceInstanceImpl

public class InterfaceInstanceImpl

extends Object

implements IInterfaceInstance, DOMBased

DOM-Based implementation of the IInterfaceInstance interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	DESCRIPTION_ELT_NAME Tag name for descriptions in this object.
static String	DIRECTION_ELT_NAME Tag name for directions in this object.
protected Element	elt
static String	ID_ATTR_NAME Tag name for ids in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.instance.IInterfaceInstance

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

InterfaceInstanceImpl(Element elt)

Method Summary

void	clearDescription() Clear the description from this InterfaceInstance.
void	clearDirection() Clear the direction from this InterfaceInstance.
void	clearId() Removes the id attribute from this object.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
IDescription	getDescription() Get the description from this InterfaceInstance.
IDirection	getDirection() Get the direction from this InterfaceInstance.
Node	getDOMNode() Gets the DOM node on which this implementation is based.
String	getId() Gets the value of the id attribute on this object.
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
protected static SequenceOrder	getSequenceOrder()
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasDescription(IDescription value) Determine if this InterfaceInstance has the given description
boolean	hasDirection(IDirection value) Determine if this InterfaceInstance has the given direction
int	hashCode()
boolean	hasId(String id) Determines if this object's id attribute has the given value.
boolean	isEqual(IInterfaceInstance InterfaceInstanceToCheck) Determine if another InterfaceInstance has the same id as this one.
boolean	isEquivalent(IInterfaceInstance c) Determine if another InterfaceInstance is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this InterfaceInstance.
void	setDirection(IDirection value) Set the direction for this InterfaceInstance.
void	setDOMNode(Node node) Sets the DOM node on which this implementation is based.
void	setId(String id) Set the id attribute on this object.
void	setXArch(IXArch xArch)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

XSD_TYPE_NSURI

public static final String XSD_TYPE_NSURI

See Also:

Constant Field Values

XSD_TYPE_NAME

public static final String XSD_TYPE_NAME

See Also:

Constant Field Values

xArch

protected IXArch xArch

ID_ATTR_NAME

public static final String ID_ATTR_NAME

Tag name for ids in this object.

See Also:

Constant Field Values

DESCRIPTION_ELT_NAME

public static final String DESCRIPTION_ELT_NAME

Tag name for descriptions in this object.

See Also:

Constant Field Values

DIRECTION_ELT_NAME

public static final String DIRECTION_ELT_NAME

Tag name for directions in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

InterfaceInstanceImpl

public InterfaceInstanceImpl(Element elt)

Method Detail

getDOMNode

public Node getDOMNode()

Description copied from interface: DOMBased

Gets the DOM node on which this implementation is based.

Specified by:

getDOMNode in interface DOMBased

Returns:

DOM node

setDOMNode

public void setDOMNode(Node node)

Description copied from interface: DOMBased

Sets the DOM node on which this implementation is based.

Specified by:

setDOMNode in interface DOMBased

Parameters:

node - DOM node

getSequenceOrder

protected static SequenceOrder getSequenceOrder()

setXArch

public void setXArch(IXArch xArch)

Specified by:

setXArch in interface IXArchElement

getXArch

public IXArch getXArch()

Specified by:

getXArch in interface IXArchElement

cloneElement

public IXArchElement cloneElement(int depth)

Specified by:

cloneElement in interface IXArchElement

equals

public boolean equals(Object o)

hashCode

public int hashCode()

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchElement

Returns:

metadata describing the xsi:type of this element.

getInstanceMetadata

public XArchInstanceMetadata getInstanceMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the instance of this element.

Specified by:

getInstanceMetadata in interface IXArchElement

Returns:

metadata describing the instance of this element.

setId

public void setId(String id)

Set the id attribute on this object.

Specified by:

setId in interface IInterfaceInstance

Parameters:

id - attribute value.

clearId

public void clearId()

Removes the id attribute from this object.

Specified by:

clearId in interface IInterfaceInstance

getId

public String getId()

Gets the value of the id attribute on this object.

Specified by:

getId in interface IInterfaceInstance

Returns:

id attribute's value or null if that attribute is not set.

hasId

public boolean hasId(String id)

Determines if this object's id attribute has the given value.

Specified by:

hasId in interface IInterfaceInstance

Parameters:

id - value to test.

Returns:

true if the values match, false otherwise. Matching is done by string-matching.

setDescription

public void setDescription(IDescription value)

Description copied from interface: IInterfaceInstance

Set the description for this InterfaceInstance.

Specified by:

setDescription in interface IInterfaceInstance

Parameters:

value - new description

clearDescription

public void clearDescription()

Description copied from interface: IInterfaceInstance

Clear the description from this InterfaceInstance.

Specified by:

clearDescription in interface IInterfaceInstance

getDescription

public IDescription getDescription()

Description copied from interface: IInterfaceInstance

Get the description from this InterfaceInstance.

Specified by:

getDescription in interface IInterfaceInstance

Returns:

description

hasDescription

public boolean hasDescription(IDescription value)

Description copied from interface: IInterfaceInstance

Determine if this InterfaceInstance has the given description

Specified by:

hasDescription in interface IInterfaceInstance

Parameters:

value - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setDirection

public void setDirection(IDirection value)

Description copied from interface: IInterfaceInstance

Set the direction for this InterfaceInstance.

Specified by:

setDirection in interface IInterfaceInstance

Parameters:

value - new direction

clearDirection

public void clearDirection()

Description copied from interface: IInterfaceInstance

Clear the direction from this InterfaceInstance.

Specified by:

clearDirection in interface IInterfaceInstance

getDirection

public IDirection getDirection()

Description copied from interface: IInterfaceInstance

Get the direction from this InterfaceInstance.

Specified by:

getDirection in interface IInterfaceInstance

Returns:

direction

hasDirection

public boolean hasDirection(IDirection value)

Description copied from interface: IInterfaceInstance

Determine if this InterfaceInstance has the given direction

Specified by:

hasDirection in interface IInterfaceInstance

Parameters:

value - direction to compare

Returns:

true if the directions are equivalent, false otherwise

isEqual

public boolean isEqual(IInterfaceInstance InterfaceInstanceToCheck)

Description copied from interface: IInterfaceInstance

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

Specified by:

isEqual in interface IInterfaceInstance

Parameters:

InterfaceInstanceToCheck - InterfaceInstance to compare with this one.

isEquivalent

public boolean isEquivalent(IInterfaceInstance c)

Description copied from interface: IInterfaceInstance

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

Specified by:

isEquivalent in interface IInterfaceInstance

Parameters:

c - InterfaceInstance to compare to this one.

Returns:

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