edu.uci.isr.xarch.options
Class OptionalLinkImpl

java.lang.Object
  edu.uci.isr.xarch.types.LinkImpl
      edu.uci.isr.xarch.options.OptionalLinkImpl

All Implemented Interfaces:

DOMBased, ILink, IOptionalLink, IXArchElement

public class OptionalLinkImpl

extends LinkImpl

implements IOptionalLink, ILink, DOMBased

DOM-Based implementation of the IOptionalLink interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	OPTIONAL_ELT_NAME Tag name for optionals in this object.
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from class edu.uci.isr.xarch.types.LinkImpl

DESCRIPTION_ELT_NAME, elt, ID_ATTR_NAME, POINT_ELT_NAME, xArch

Fields inherited from interface edu.uci.isr.xarch.options.IOptionalLink

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

OptionalLinkImpl(Element elt)

Method Summary

void	clearOptional() Clear the optional from this OptionalLink.
IXArchElement	cloneElement(int depth)
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
IOptional	getOptional() Get the optional from this OptionalLink.
protected static SequenceOrder	getSequenceOrder()
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
boolean	hasOptional(IOptional value) Determine if this OptionalLink has the given optional
boolean	isEquivalent(IOptionalLink c) Determine if another OptionalLink is equivalent to this one, ignoring ID's.
void	setOptional(IOptional value) Set the optional for this OptionalLink.

Methods inherited from class edu.uci.isr.xarch.types.LinkImpl

addPoint, addPoints, clearDescription, clearId, clearPoints, equals, getAllPoints, getDescription, getDOMNode, getId, getXArch, hasAllPoints, hasDescription, hashCode, hasId, hasPoint, hasPoints, isEqual, isEquivalent, removePoint, removePoints, setDescription, setDOMNode, setId, setXArch

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.uci.isr.xarch.types.ILink

addPoint, addPoints, clearDescription, clearId, clearPoints, getAllPoints, getDescription, getId, hasAllPoints, hasDescription, hasId, hasPoint, hasPoints, isEqual, isEquivalent, removePoint, removePoints, setDescription, setId

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

getXArch, setXArch

Methods inherited from interface edu.uci.isr.xarch.DOMBased

getDOMNode, setDOMNode

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

OPTIONAL_ELT_NAME

public static final String OPTIONAL_ELT_NAME

Tag name for optionals in this object.

See Also:

Constant Field Values

Constructor Detail

OptionalLinkImpl

public OptionalLinkImpl(Element elt)

Method Detail

getSequenceOrder

protected static SequenceOrder getSequenceOrder()

cloneElement

public IXArchElement cloneElement(int depth)

Specified by:

cloneElement in interface IXArchElement

Overrides:

cloneElement in class LinkImpl

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchElement

Overrides:

getTypeMetadata in class LinkImpl

getInstanceMetadata

public XArchInstanceMetadata getInstanceMetadata()

Description copied from interface: IXArchElement

Gets metadata describing the instance of this element.

Specified by:

getInstanceMetadata in interface IXArchElement

Overrides:

getInstanceMetadata in class LinkImpl

setOptional

public void setOptional(IOptional value)

Description copied from interface: IOptionalLink

Set the optional for this OptionalLink.

Specified by:

setOptional in interface IOptionalLink

Parameters:

value - new optional

clearOptional

public void clearOptional()

Description copied from interface: IOptionalLink

Clear the optional from this OptionalLink.

Specified by:

clearOptional in interface IOptionalLink

getOptional

public IOptional getOptional()

Description copied from interface: IOptionalLink

Get the optional from this OptionalLink.

Specified by:

getOptional in interface IOptionalLink

Returns:

optional

hasOptional

public boolean hasOptional(IOptional value)

Description copied from interface: IOptionalLink

Determine if this OptionalLink has the given optional

Specified by:

hasOptional in interface IOptionalLink

Parameters:

value - optional to compare

Returns:

true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalLink c)

Description copied from interface: IOptionalLink

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

Specified by:

isEquivalent in interface IOptionalLink

Parameters:

c - OptionalLink to compare to this one.

Returns:

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