edu.uci.isr.xarch.boolguard
Class InSetImpl

java.lang.Object
  edu.uci.isr.xarch.boolguard.InSetImpl

All Implemented Interfaces:

DOMBased, IInSet, IXArchElement

public class InSetImpl

extends Object

implements IInSet, DOMBased

DOM-Based implementation of the IInSet interface.

Author:

Automatically generated by xArch apigen.

Field Summary

protected Element	elt
static String	SYMBOL_ELT_NAME Tag name for symbols in this object.
static String	VALUE_ELT_NAME Tag name for values in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.boolguard.IInSet

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

InSetImpl(Element elt)

Method Summary

void	addValue(IValue newValue) Add a value to this InSet.
void	addValues(Collection values) Add a collection of values to this InSet.
void	clearSymbol() Clear the symbol from this InSet.
void	clearValues() Remove all values from this InSet.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
Collection	getAllValues() Get all the values from this InSet.
Node	getDOMNode() Gets the DOM node on which this implementation is based.
XArchInstanceMetadata	getInstanceMetadata() Gets metadata describing the instance of this element.
protected static SequenceOrder	getSequenceOrder()
ISymbol	getSymbol() Get the symbol from this InSet.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch()
boolean	hasAllValues(Collection valuesToCheck) Determine if this InSet contains each element in the given set of values.
int	hashCode()
boolean	hasSymbol(ISymbol value) Determine if this InSet has the given symbol
boolean	hasValue(IValue valueToCheck) Determine if this InSet contains a given value.
Collection	hasValues(Collection valuesToCheck) Determine if this InSet contains the given set of values.
boolean	isEquivalent(IInSet c) Determine if another InSet is equivalent to this one, ignoring ID's.
void	removeValue(IValue valueToRemove) Remove the given value from this InSet.
void	removeValues(Collection values) Remove all the given values from this InSet.
void	setDOMNode(Node node) Sets the DOM node on which this implementation is based.
void	setSymbol(ISymbol value) Set the symbol for this InSet.
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

SYMBOL_ELT_NAME

public static final String SYMBOL_ELT_NAME

Tag name for symbols in this object.

See Also:

Constant Field Values

VALUE_ELT_NAME

public static final String VALUE_ELT_NAME

Tag name for values in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

InSetImpl

public InSetImpl(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.

setSymbol

public void setSymbol(ISymbol value)

Description copied from interface: IInSet

Set the symbol for this InSet.

Specified by:

setSymbol in interface IInSet

Parameters:

value - new symbol

clearSymbol

public void clearSymbol()

Description copied from interface: IInSet

Clear the symbol from this InSet.

Specified by:

clearSymbol in interface IInSet

getSymbol

public ISymbol getSymbol()

Description copied from interface: IInSet

Get the symbol from this InSet.

Specified by:

getSymbol in interface IInSet

Returns:

symbol

hasSymbol

public boolean hasSymbol(ISymbol value)

Description copied from interface: IInSet

Determine if this InSet has the given symbol

Specified by:

hasSymbol in interface IInSet

Parameters:

value - symbol to compare

Returns:

true if the symbols are equivalent, false otherwise

addValue

public void addValue(IValue newValue)

Description copied from interface: IInSet

Add a value to this InSet.

Specified by:

addValue in interface IInSet

Parameters:

newValue - value to add.

addValues

public void addValues(Collection values)

Description copied from interface: IInSet

Add a collection of values to this InSet.

Specified by:

addValues in interface IInSet

Parameters:

values - values to add.

clearValues

public void clearValues()

Description copied from interface: IInSet

Remove all values from this InSet.

Specified by:

clearValues in interface IInSet

removeValue

public void removeValue(IValue valueToRemove)

Description copied from interface: IInSet

Remove the given value from this InSet. Matching is done by the isEquivalent(...) function.

Specified by:

removeValue in interface IInSet

Parameters:

valueToRemove - value to remove.

removeValues

public void removeValues(Collection values)

Description copied from interface: IInSet

Remove all the given values from this InSet. Matching is done by the isEquivalent(...) function.

Specified by:

removeValues in interface IInSet

Parameters:

values - value to remove.

getAllValues

public Collection getAllValues()

Description copied from interface: IInSet

Get all the values from this InSet.

Specified by:

getAllValues in interface IInSet

Returns:

all values in this InSet.

hasValue

public boolean hasValue(IValue valueToCheck)

Description copied from interface: IInSet

Determine if this InSet contains a given value.

Specified by:

hasValue in interface IInSet

Returns:

true if this InSet contains the given valueToCheck, false otherwise.

hasValues

public Collection hasValues(Collection valuesToCheck)

Description copied from interface: IInSet

Determine if this InSet contains the given set of values.

Specified by:

hasValues in interface IInSet

Parameters:

valuesToCheck - values to check for.

Returns:

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

hasAllValues

public boolean hasAllValues(Collection valuesToCheck)

Description copied from interface: IInSet

Determine if this InSet contains each element in the given set of values.

Specified by:

hasAllValues in interface IInSet

Parameters:

valuesToCheck - values to check for.

Returns:

true if every element in values is found in this InSet, false otherwise.

isEquivalent

public boolean isEquivalent(IInSet c)

Description copied from interface: IInSet

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

Specified by:

isEquivalent in interface IInSet

Parameters:

c - InSet to compare to this one.

Returns:

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