edu.uci.isr.xarch.types
Interface ISignature

All Superinterfaces:

IXArchElement

All Known Subinterfaces:

IOptionalSignature, IOptionalSignaturePosition

All Known Implementing Classes:

OptionalSignatureImpl, OptionalSignaturePositionImpl, SignatureImpl

public interface ISignature

extends IXArchElement

Interface for accessing objects of the Signature xsi:type in the types 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	clearDescription() Clear the description from this Signature.
void	clearDirection() Clear the direction from this Signature.
void	clearId() Remove the id attribute from this Signature.
void	clearType() Clear the type from this Signature.
IDescription	getDescription() Get the description from this Signature.
IDirection	getDirection() Get the direction from this Signature.
String	getId() Get the id attribute from this Signature.
IXMLLink	getType() Get the type from this Signature.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this Signature has the given description
boolean	hasDirection(IDirection directionToCheck) Determine if this Signature has the given direction
boolean	hasId(String id) Determine if the id attribute on this Signature has the given value.
boolean	hasType(IXMLLink typeToCheck) Determine if this Signature has the given type
boolean	isEqual(ISignature SignatureToCheck) Determine if another Signature has the same id as this one.
boolean	isEquivalent(ISignature SignatureToCheck) Determine if another Signature is equivalent to this one, ignoring ID's.
void	setDescription(IDescription value) Set the description for this Signature.
void	setDirection(IDirection value) Set the direction for this Signature.
void	setId(String id) Set the id attribute on this Signature.
void	setType(IXMLLink value) Set the type for this Signature.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this Signature.

getDescription

public IDescription getDescription()

Get the description from this Signature.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this Signature has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setDirection

public void setDirection(IDirection value)

Set the direction for this Signature.

Parameters:

value - new direction

clearDirection

public void clearDirection()

Clear the direction from this Signature.

getDirection

public IDirection getDirection()

Get the direction from this Signature.

Returns:

direction

hasDirection

public boolean hasDirection(IDirection directionToCheck)

Determine if this Signature has the given direction

Parameters:

directionToCheck - direction to compare

Returns:

true if the directions are equivalent, false otherwise

setType

public void setType(IXMLLink value)

Set the type for this Signature.

Parameters:

value - new type

clearType

public void clearType()

Clear the type from this Signature.

getType

public IXMLLink getType()

Get the type from this Signature.

Returns:

type

hasType

public boolean hasType(IXMLLink typeToCheck)

Determine if this Signature has the given type

Parameters:

typeToCheck - type to compare

Returns:

true if the types are equivalent, false otherwise

isEqual

public boolean isEqual(ISignature SignatureToCheck)

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

Parameters:

SignatureToCheck - Signature to compare with this one.

isEquivalent

public boolean isEquivalent(ISignature SignatureToCheck)

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

Parameters:

SignatureToCheck - Signature to compare to this one.

Returns:

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