xArch/xADL 2.0 Data Binding Library

edu.uci.isr.xarch.options
Class OptionalSignatureImpl

java.lang.Object
  extended byedu.uci.isr.xarch.types.SignatureImpl
      extended byedu.uci.isr.xarch.options.OptionalSignatureImpl
All Implemented Interfaces:
DOMBased, IOptionalSignature, ISignature, IXArchElement
Direct Known Subclasses:
OptionalSignaturePositionImpl

public class OptionalSignatureImpl
extends SignatureImpl
implements IOptionalSignature, ISignature, DOMBased

DOM-Based implementation of the IOptionalSignature 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.SignatureImpl
DESCRIPTION_ELT_NAME, DIRECTION_ELT_NAME, elt, ID_ATTR_NAME, TYPE_ELT_NAME, xArch
 
Fields inherited from interface edu.uci.isr.xarch.options.IOptionalSignature
TYPE_METADATA
 
Fields inherited from interface edu.uci.isr.xarch.IXArchElement
DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO
 
Constructor Summary
OptionalSignatureImpl(Element elt)
           
 
Method Summary
 void clearOptional()
          Clear the optional from this OptionalSignature.
 IXArchElement cloneElement(int depth)
           
 XArchInstanceMetadata getInstanceMetadata()
          Gets metadata describing the instance of this element.
 IOptional getOptional()
          Get the optional from this OptionalSignature.
protected static SequenceOrder getSequenceOrder()
           
 XArchTypeMetadata getTypeMetadata()
          Gets metadata describing the xsi:type of this element.
 boolean hasOptional(IOptional value)
          Determine if this OptionalSignature has the given optional
 boolean isEquivalent(IOptionalSignature c)
          Determine if another OptionalSignature is equivalent to this one, ignoring ID's.
 void setOptional(IOptional value)
          Set the optional for this OptionalSignature.
 
Methods inherited from class edu.uci.isr.xarch.types.SignatureImpl
clearDescription, clearDirection, clearId, clearType, equals, getDescription, getDirection, getDOMNode, getId, getType, getXArch, hasDescription, hasDirection, hashCode, hasId, hasType, isEqual, isEquivalent, setDescription, setDirection, setDOMNode, setId, setType, 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.ISignature
clearDescription, clearDirection, clearId, clearType, getDescription, getDirection, getId, getType, hasDescription, hasDirection, hasId, hasType, isEqual, isEquivalent, setDescription, setDirection, setId, setType
 
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

OptionalSignatureImpl

public OptionalSignatureImpl(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 SignatureImpl

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 SignatureImpl

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 SignatureImpl

setOptional

public void setOptional(IOptional value)
Description copied from interface: IOptionalSignature
Set the optional for this OptionalSignature.

Specified by:
setOptional in interface IOptionalSignature
Parameters:
value - new optional

clearOptional

public void clearOptional()
Description copied from interface: IOptionalSignature
Clear the optional from this OptionalSignature.

Specified by:
clearOptional in interface IOptionalSignature

getOptional

public IOptional getOptional()
Description copied from interface: IOptionalSignature
Get the optional from this OptionalSignature.

Specified by:
getOptional in interface IOptionalSignature
Returns:
optional

hasOptional

public boolean hasOptional(IOptional value)
Description copied from interface: IOptionalSignature
Determine if this OptionalSignature has the given optional

Specified by:
hasOptional in interface IOptionalSignature
Parameters:
value - optional to compare
Returns:
true if the optionals are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IOptionalSignature c)
Description copied from interface: IOptionalSignature
Determine if another OptionalSignature is equivalent to this one, ignoring ID's.

Specified by:
isEquivalent in interface IOptionalSignature
Parameters:
c - OptionalSignature to compare to this one.
Returns:
true if all the child elements of this OptionalSignature are equivalent, false otherwise.

xArch/xADL 2.0 Data Binding Library