edu.uci.isr.xarch.messages
Class GenericMessageImpl

java.lang.Object
  edu.uci.isr.xarch.messages.GenericMessageImpl

All Implemented Interfaces:

DOMBased, IGenericMessage, IXArchElement

Direct Known Subclasses:

NamedPropertyMessageImpl

public class GenericMessageImpl

extends Object

implements IGenericMessage, DOMBased

DOM-Based implementation of the IGenericMessage interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	COUNT_ELT_NAME Tag name for counts in this object.
static String	DESCRIPTION_ELT_NAME Tag name for descriptions in this object.
protected Element	elt
static String	ID_ATTR_NAME Tag name for ids in this object.
static String	KIND_ATTR_NAME Tag name for kinds in this object.
static String	TYPE_ELT_NAME Tag name for types in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.messages.IGenericMessage

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

GenericMessageImpl(Element elt)

Method Summary

void	clearCount() Clear the count from this GenericMessage.
void	clearDescription() Clear the description from this GenericMessage.
void	clearId() Removes the id attribute from this object.
void	clearKind() Removes the kind attribute from this object.
void	clearType() Clear the type from this GenericMessage.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
ICount	getCount() Get the count from this GenericMessage.
IDescription	getDescription() Get the description from this GenericMessage.
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.
String	getKind() Gets the value of the kind attribute on this object.
protected static SequenceOrder	getSequenceOrder()
IMessageType	getType() Get the type from this GenericMessage.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasCount(ICount value) Determine if this GenericMessage has the given count
boolean	hasDescription(IDescription value) Determine if this GenericMessage has the given description
int	hashCode()
boolean	hasId(String id) Determines if this object's id attribute has the given value.
boolean	hasKind(String kind) Determines if this object's kind attribute has the given value.
boolean	hasType(IMessageType value) Determine if this GenericMessage has the given type
boolean	isEqual(IGenericMessage GenericMessageToCheck) Determine if another GenericMessage has the same id as this one.
boolean	isEquivalent(IGenericMessage c) Determine if another GenericMessage is equivalent to this one, ignoring ID's.
void	setCount(ICount value) Set the count for this GenericMessage.
void	setDescription(IDescription value) Set the description for this GenericMessage.
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	setKind(String kind) Set the kind attribute on this object.
void	setType(IMessageType value) Set the type for this GenericMessage.
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

KIND_ATTR_NAME

public static final String KIND_ATTR_NAME

Tag name for kinds 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

COUNT_ELT_NAME

public static final String COUNT_ELT_NAME

Tag name for counts in this object.

See Also:

Constant Field Values

TYPE_ELT_NAME

public static final String TYPE_ELT_NAME

Tag name for types in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

GenericMessageImpl

public GenericMessageImpl(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 IGenericMessage

Parameters:

id - attribute value.

clearId

public void clearId()

Removes the id attribute from this object.

Specified by:

clearId in interface IGenericMessage

getId

public String getId()

Gets the value of the id attribute on this object.

Specified by:

getId in interface IGenericMessage

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 IGenericMessage

Parameters:

id - value to test.

Returns:

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

setKind

public void setKind(String kind)

Set the kind attribute on this object.

Specified by:

setKind in interface IGenericMessage

Parameters:

kind - attribute value.

clearKind

public void clearKind()

Removes the kind attribute from this object.

Specified by:

clearKind in interface IGenericMessage

getKind

public String getKind()

Gets the value of the kind attribute on this object.

Specified by:

getKind in interface IGenericMessage

Returns:

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

hasKind

public boolean hasKind(String kind)

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

Specified by:

hasKind in interface IGenericMessage

Parameters:

kind - 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: IGenericMessage

Set the description for this GenericMessage.

Specified by:

setDescription in interface IGenericMessage

Parameters:

value - new description

clearDescription

public void clearDescription()

Description copied from interface: IGenericMessage

Clear the description from this GenericMessage.

Specified by:

clearDescription in interface IGenericMessage

getDescription

public IDescription getDescription()

Description copied from interface: IGenericMessage

Get the description from this GenericMessage.

Specified by:

getDescription in interface IGenericMessage

Returns:

description

hasDescription

public boolean hasDescription(IDescription value)

Description copied from interface: IGenericMessage

Determine if this GenericMessage has the given description

Specified by:

hasDescription in interface IGenericMessage

Parameters:

value - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

setCount

public void setCount(ICount value)

Description copied from interface: IGenericMessage

Set the count for this GenericMessage.

Specified by:

setCount in interface IGenericMessage

Parameters:

value - new count

clearCount

public void clearCount()

Description copied from interface: IGenericMessage

Clear the count from this GenericMessage.

Specified by:

clearCount in interface IGenericMessage

getCount

public ICount getCount()

Description copied from interface: IGenericMessage

Get the count from this GenericMessage.

Specified by:

getCount in interface IGenericMessage

Returns:

count

hasCount

public boolean hasCount(ICount value)

Description copied from interface: IGenericMessage

Determine if this GenericMessage has the given count

Specified by:

hasCount in interface IGenericMessage

Parameters:

value - count to compare

Returns:

true if the counts are equivalent, false otherwise

setType

public void setType(IMessageType value)

Description copied from interface: IGenericMessage

Set the type for this GenericMessage.

Specified by:

setType in interface IGenericMessage

Parameters:

value - new type

clearType

public void clearType()

Description copied from interface: IGenericMessage

Clear the type from this GenericMessage.

Specified by:

clearType in interface IGenericMessage

getType

public IMessageType getType()

Description copied from interface: IGenericMessage

Get the type from this GenericMessage.

Specified by:

getType in interface IGenericMessage

Returns:

type

hasType

public boolean hasType(IMessageType value)

Description copied from interface: IGenericMessage

Determine if this GenericMessage has the given type

Specified by:

hasType in interface IGenericMessage

Parameters:

value - type to compare

Returns:

true if the types are equivalent, false otherwise

isEqual

public boolean isEqual(IGenericMessage GenericMessageToCheck)

Description copied from interface: IGenericMessage

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

Specified by:

isEqual in interface IGenericMessage

Parameters:

GenericMessageToCheck - GenericMessage to compare with this one.

isEquivalent

public boolean isEquivalent(IGenericMessage c)

Description copied from interface: IGenericMessage

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

Specified by:

isEquivalent in interface IGenericMessage

Parameters:

c - GenericMessage to compare to this one.

Returns:

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