edu.uci.isr.xarch.messages
Class NamedPropertyMessageImpl

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

All Implemented Interfaces:

DOMBased, IGenericMessage, INamedPropertyMessage, IXArchElement

public class NamedPropertyMessageImpl

extends GenericMessageImpl

implements INamedPropertyMessage, IGenericMessage, DOMBased

DOM-Based implementation of the INamedPropertyMessage interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	NAME_ELT_NAME Tag name for names in this object.
static String	NAMED_PROPERTY_ELT_NAME Tag name for namedPropertys in this object.
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from class edu.uci.isr.xarch.messages.GenericMessageImpl

COUNT_ELT_NAME, DESCRIPTION_ELT_NAME, elt, ID_ATTR_NAME, KIND_ATTR_NAME, TYPE_ELT_NAME, xArch

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

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

NamedPropertyMessageImpl(Element elt)

Method Summary

void	addNamedProperty(INamedProperty newNamedProperty) Add a namedProperty to this NamedPropertyMessage.
void	addNamedPropertys(Collection namedPropertys) Add a collection of namedPropertys to this NamedPropertyMessage.
void	clearName() Clear the name from this NamedPropertyMessage.
void	clearNamedPropertys() Remove all namedPropertys from this NamedPropertyMessage.
IXArchElement	cloneElement(int depth)
Collection	getAllNamedPropertys() Get all the namedPropertys from this NamedPropertyMessage.
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
IMessageName	getName() Get the name from this NamedPropertyMessage.
protected static SequenceOrder	getSequenceOrder()
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
boolean	hasAllNamedPropertys(Collection namedPropertysToCheck) Determine if this NamedPropertyMessage contains each element in the given set of namedPropertys.
boolean	hasName(IMessageName value) Determine if this NamedPropertyMessage has the given name
boolean	hasNamedProperty(INamedProperty namedPropertyToCheck) Determine if this NamedPropertyMessage contains a given namedProperty.
Collection	hasNamedPropertys(Collection namedPropertysToCheck) Determine if this NamedPropertyMessage contains the given set of namedPropertys.
boolean	isEquivalent(INamedPropertyMessage c) Determine if another NamedPropertyMessage is equivalent to this one, ignoring ID's.
void	removeNamedProperty(INamedProperty namedPropertyToRemove) Remove the given namedProperty from this NamedPropertyMessage.
void	removeNamedPropertys(Collection namedPropertys) Remove all the given namedPropertys from this NamedPropertyMessage.
void	setName(IMessageName value) Set the name for this NamedPropertyMessage.

Methods inherited from class edu.uci.isr.xarch.messages.GenericMessageImpl

clearCount, clearDescription, clearId, clearKind, clearType, equals, getCount, getDescription, getDOMNode, getId, getKind, getType, getXArch, hasCount, hasDescription, hashCode, hasId, hasKind, hasType, isEqual, isEquivalent, setCount, setDescription, setDOMNode, setId, setKind, 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.messages.IGenericMessage

clearCount, clearDescription, clearId, clearKind, clearType, getCount, getDescription, getId, getKind, getType, hasCount, hasDescription, hasId, hasKind, hasType, isEqual, isEquivalent, setCount, setDescription, setId, setKind, 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

NAME_ELT_NAME

public static final String NAME_ELT_NAME

Tag name for names in this object.

See Also:

Constant Field Values

NAMED_PROPERTY_ELT_NAME

public static final String NAMED_PROPERTY_ELT_NAME

Tag name for namedPropertys in this object.

See Also:

Constant Field Values

Constructor Detail

NamedPropertyMessageImpl

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

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 GenericMessageImpl

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 GenericMessageImpl

setName

public void setName(IMessageName value)

Description copied from interface: INamedPropertyMessage

Set the name for this NamedPropertyMessage.

Specified by:

setName in interface INamedPropertyMessage

Parameters:

value - new name

clearName

public void clearName()

Description copied from interface: INamedPropertyMessage

Clear the name from this NamedPropertyMessage.

Specified by:

clearName in interface INamedPropertyMessage

getName

public IMessageName getName()

Description copied from interface: INamedPropertyMessage

Get the name from this NamedPropertyMessage.

Specified by:

getName in interface INamedPropertyMessage

Returns:

name

hasName

public boolean hasName(IMessageName value)

Description copied from interface: INamedPropertyMessage

Determine if this NamedPropertyMessage has the given name

Specified by:

hasName in interface INamedPropertyMessage

Parameters:

value - name to compare

Returns:

true if the names are equivalent, false otherwise

addNamedProperty

public void addNamedProperty(INamedProperty newNamedProperty)

Description copied from interface: INamedPropertyMessage

Add a namedProperty to this NamedPropertyMessage.

Specified by:

addNamedProperty in interface INamedPropertyMessage

Parameters:

newNamedProperty - namedProperty to add.

addNamedPropertys

public void addNamedPropertys(Collection namedPropertys)

Description copied from interface: INamedPropertyMessage

Add a collection of namedPropertys to this NamedPropertyMessage.

Specified by:

addNamedPropertys in interface INamedPropertyMessage

Parameters:

namedPropertys - namedPropertys to add.

clearNamedPropertys

public void clearNamedPropertys()

Description copied from interface: INamedPropertyMessage

Remove all namedPropertys from this NamedPropertyMessage.

Specified by:

clearNamedPropertys in interface INamedPropertyMessage

removeNamedProperty

public void removeNamedProperty(INamedProperty namedPropertyToRemove)

Description copied from interface: INamedPropertyMessage

Remove the given namedProperty from this NamedPropertyMessage. Matching is done by the isEquivalent(...) function.

Specified by:

removeNamedProperty in interface INamedPropertyMessage

Parameters:

namedPropertyToRemove - namedProperty to remove.

removeNamedPropertys

public void removeNamedPropertys(Collection namedPropertys)

Description copied from interface: INamedPropertyMessage

Remove all the given namedPropertys from this NamedPropertyMessage. Matching is done by the isEquivalent(...) function.

Specified by:

removeNamedPropertys in interface INamedPropertyMessage

Parameters:

namedPropertys - namedProperty to remove.

getAllNamedPropertys

public Collection getAllNamedPropertys()

Description copied from interface: INamedPropertyMessage

Get all the namedPropertys from this NamedPropertyMessage.

Specified by:

getAllNamedPropertys in interface INamedPropertyMessage

Returns:

all namedPropertys in this NamedPropertyMessage.

hasNamedProperty

public boolean hasNamedProperty(INamedProperty namedPropertyToCheck)

Description copied from interface: INamedPropertyMessage

Determine if this NamedPropertyMessage contains a given namedProperty.

Specified by:

hasNamedProperty in interface INamedPropertyMessage

Returns:

true if this NamedPropertyMessage contains the given namedPropertyToCheck, false otherwise.

hasNamedPropertys

public Collection hasNamedPropertys(Collection namedPropertysToCheck)

Description copied from interface: INamedPropertyMessage

Determine if this NamedPropertyMessage contains the given set of namedPropertys.

Specified by:

hasNamedPropertys in interface INamedPropertyMessage

Parameters:

namedPropertysToCheck - namedPropertys to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in namedPropertys was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllNamedPropertys

public boolean hasAllNamedPropertys(Collection namedPropertysToCheck)

Description copied from interface: INamedPropertyMessage

Determine if this NamedPropertyMessage contains each element in the given set of namedPropertys.

Specified by:

hasAllNamedPropertys in interface INamedPropertyMessage

Parameters:

namedPropertysToCheck - namedPropertys to check for.

Returns:

true if every element in namedPropertys is found in this NamedPropertyMessage, false otherwise.

isEquivalent

public boolean isEquivalent(INamedPropertyMessage c)

Description copied from interface: INamedPropertyMessage

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

Specified by:

isEquivalent in interface INamedPropertyMessage

Parameters:

c - NamedPropertyMessage to compare to this one.

Returns:

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