edu.uci.isr.xarch.instance
Interface IGroup

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

GroupImpl

public interface IGroup

extends IXArchElement

Interface for accessing objects of the Group xsi:type in the instance 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	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() Remove the id attribute from this Group.
void	clearMembers() Remove all members from this Group.
Collection	getAllMembers() Get all the members from this Group.
IDescription	getDescription() Get the description from this Group.
String	getId() Get the id attribute from this Group.
boolean	hasAllMembers(Collection membersToCheck) Determine if this Group contains each element in the given set of members.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this Group has the given description
boolean	hasId(String id) Determine if the id attribute on this Group 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 GroupToCheck) 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	setId(String id) Set the id attribute on this Group.

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this Group.

getDescription

public IDescription getDescription()

Get the description from this Group.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this Group has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addMember

public void addMember(IXMLLink newMember)

Add a member to this Group.

Parameters:

newMember - member to add.

addMembers

public void addMembers(Collection members)

Add a collection of members to this Group.

Parameters:

members - members to add.

clearMembers

public void clearMembers()

Remove all members from this Group.

removeMember

public void removeMember(IXMLLink memberToRemove)

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

Parameters:

memberToRemove - member to remove.

removeMembers

public void removeMembers(Collection members)

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

Parameters:

members - member to remove.

getAllMembers

public Collection getAllMembers()

Get all the members from this Group.

Returns:

all members in this Group.

hasMember

public boolean hasMember(IXMLLink memberToCheck)

Determine if this Group contains a given member.

Returns:

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

hasMembers

public Collection hasMembers(Collection membersToCheck)

Determine if this Group contains the given set of members.

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)

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

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)

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

Parameters:

GroupToCheck - Group to compare with this one.

isEquivalent

public boolean isEquivalent(IGroup GroupToCheck)

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

Parameters:

GroupToCheck - Group to compare to this one.

Returns:

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