edu.uci.isr.xarch.instance
Class GroupImpl

java.lang.Object
  edu.uci.isr.xarch.instance.GroupImpl

All Implemented Interfaces:

DOMBased, IGroup, IXArchElement

public class GroupImpl

extends Object

implements IGroup, DOMBased

DOM-Based implementation of the IGroup interface.

Author:

Automatically generated by xArch apigen.

Field Summary

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	MEMBER_ELT_NAME Tag name for members in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.instance.IGroup

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

GroupImpl(Element elt)

Method Summary

void	addMember(IXMLLink newMember) Add a member to this Group.
void	addMembers(Collection members) Add a collection of members to this Group.
void	clearDescription() Clear the description from this Group.
void	clearId() Removes the id attribute from this object.
void	clearMembers() Remove all members from this Group.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
Collection	getAllMembers() Get all the members from this Group.
IDescription	getDescription() Get the description from this Group.
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.
protected static SequenceOrder	getSequenceOrder()
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasAllMembers(Collection membersToCheck) Determine if this Group contains each element in the given set of members.
boolean	hasDescription(IDescription value) Determine if this Group has the given description
int	hashCode()
boolean	hasId(String id) Determines if this object's id attribute has the given value.
boolean	hasMember(IXMLLink memberToCheck) Determine if this Group contains a given member.
Collection	hasMembers(Collection membersToCheck) Determine if this Group contains the given set of members.
boolean	isEqual(IGroup GroupToCheck) Determine if another Group has the same id as this one.
boolean	isEquivalent(IGroup c) Determine if another Group is equivalent to this one, ignoring ID's.
void	removeMember(IXMLLink memberToRemove) Remove the given member from this Group.
void	removeMembers(Collection members) Remove all the given members from this Group.
void	setDescription(IDescription value) Set the description for this Group.
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	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

DESCRIPTION_ELT_NAME

public static final String DESCRIPTION_ELT_NAME

Tag name for descriptions in this object.

See Also:

Constant Field Values

MEMBER_ELT_NAME

public static final String MEMBER_ELT_NAME

Tag name for members in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

GroupImpl

public GroupImpl(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 IGroup

Parameters:

id - attribute value.

clearId

public void clearId()

Removes the id attribute from this object.

Specified by:

clearId in interface IGroup

getId

public String getId()

Gets the value of the id attribute on this object.

Specified by:

getId in interface IGroup

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 IGroup

Parameters:

id - 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: IGroup

Set the description for this Group.

Specified by:

setDescription in interface IGroup

Parameters:

value - new description

clearDescription

public void clearDescription()

Description copied from interface: IGroup

Clear the description from this Group.

Specified by:

clearDescription in interface IGroup

getDescription

public IDescription getDescription()

Description copied from interface: IGroup

Get the description from this Group.

Specified by:

getDescription in interface IGroup

Returns:

description

hasDescription

public boolean hasDescription(IDescription value)

Description copied from interface: IGroup

Determine if this Group has the given description

Specified by:

hasDescription in interface IGroup

Parameters:

value - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addMember

public void addMember(IXMLLink newMember)

Description copied from interface: IGroup

Add a member to this Group.

Specified by:

addMember in interface IGroup

Parameters:

newMember - member to add.

addMembers

public void addMembers(Collection members)

Description copied from interface: IGroup

Add a collection of members to this Group.

Specified by:

addMembers in interface IGroup

Parameters:

members - members to add.

clearMembers

public void clearMembers()

Description copied from interface: IGroup

Remove all members from this Group.

Specified by:

clearMembers in interface IGroup

removeMember

public void removeMember(IXMLLink memberToRemove)

Description copied from interface: IGroup

Remove the given member from this Group. Matching is done by the isEquivalent(...) function.

Specified by:

removeMember in interface IGroup

Parameters:

memberToRemove - member to remove.

removeMembers

public void removeMembers(Collection members)

Description copied from interface: IGroup

Remove all the given members from this Group. Matching is done by the isEquivalent(...) function.

Specified by:

removeMembers in interface IGroup

Parameters:

members - member to remove.

getAllMembers

public Collection getAllMembers()

Description copied from interface: IGroup

Get all the members from this Group.

Specified by:

getAllMembers in interface IGroup

Returns:

all members in this Group.

hasMember

public boolean hasMember(IXMLLink memberToCheck)

Description copied from interface: IGroup

Determine if this Group contains a given member.

Specified by:

hasMember in interface IGroup

Returns:

true if this Group contains the given memberToCheck, false otherwise.

hasMembers

public Collection hasMembers(Collection membersToCheck)

Description copied from interface: IGroup

Determine if this Group contains the given set of members.

Specified by:

hasMembers in interface IGroup

Parameters:

membersToCheck - members to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in members 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.

hasAllMembers

public boolean hasAllMembers(Collection membersToCheck)

Description copied from interface: IGroup

Determine if this Group contains each element in the given set of members.

Specified by:

hasAllMembers in interface IGroup

Parameters:

membersToCheck - members to check for.

Returns:

true if every element in members is found in this Group, false otherwise.

isEqual

public boolean isEqual(IGroup GroupToCheck)

Description copied from interface: IGroup

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

Specified by:

isEqual in interface IGroup

Parameters:

GroupToCheck - Group to compare with this one.

isEquivalent

public boolean isEquivalent(IGroup c)

Description copied from interface: IGroup

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

Specified by:

isEquivalent in interface IGroup

Parameters:

c - Group to compare to this one.

Returns:

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