edu.uci.isr.xarch.hints
Class HintsImpl

java.lang.Object
  edu.uci.isr.xarch.hints.HintsImpl

All Implemented Interfaces:

DOMBased, IHints, IXArchElement

public class HintsImpl

extends Object

implements IHints, DOMBased

DOM-Based implementation of the IHints interface.

Author:

Automatically generated by xArch apigen.

Field Summary

protected Element	elt
static String	HINTED_THING_ELT_NAME Tag name for hintedThings in this object.
static String	PROPERTY_HINT_ELT_NAME Tag name for propertyHints in this object.
protected IXArch	xArch
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from interface edu.uci.isr.xarch.hints.IHints

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

HintsImpl(Element elt)

Method Summary

void	addPropertyHint(IPropertyHint newPropertyHint) Add a propertyHint to this Hints.
void	addPropertyHints(Collection propertyHints) Add a collection of propertyHints to this Hints.
void	clearHintedThing() Clear the hintedThing from this Hints.
void	clearPropertyHints() Remove all propertyHints from this Hints.
IXArchElement	cloneElement(int depth)
boolean	equals(Object o)
Collection	getAllPropertyHints() Get all the propertyHints from this Hints.
Node	getDOMNode() Gets the DOM node on which this implementation is based.
IXMLLink	getHintedThing() Get the hintedThing from this Hints.
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	hasAllPropertyHints(Collection propertyHintsToCheck) Determine if this Hints contains each element in the given set of propertyHints.
int	hashCode()
boolean	hasHintedThing(IXMLLink value) Determine if this Hints has the given hintedThing
boolean	hasPropertyHint(IPropertyHint propertyHintToCheck) Determine if this Hints contains a given propertyHint.
Collection	hasPropertyHints(Collection propertyHintsToCheck) Determine if this Hints contains the given set of propertyHints.
boolean	isEquivalent(IHints c) Determine if another Hints is equivalent to this one, ignoring ID's.
void	removePropertyHint(IPropertyHint propertyHintToRemove) Remove the given propertyHint from this Hints.
void	removePropertyHints(Collection propertyHints) Remove all the given propertyHints from this Hints.
void	setDOMNode(Node node) Sets the DOM node on which this implementation is based.
void	setHintedThing(IXMLLink value) Set the hintedThing for this Hints.
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

HINTED_THING_ELT_NAME

public static final String HINTED_THING_ELT_NAME

Tag name for hintedThings in this object.

See Also:

Constant Field Values

PROPERTY_HINT_ELT_NAME

public static final String PROPERTY_HINT_ELT_NAME

Tag name for propertyHints in this object.

See Also:

Constant Field Values

elt

protected Element elt

Constructor Detail

HintsImpl

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

setHintedThing

public void setHintedThing(IXMLLink value)

Description copied from interface: IHints

Set the hintedThing for this Hints.

Specified by:

setHintedThing in interface IHints

Parameters:

value - new hintedThing

clearHintedThing

public void clearHintedThing()

Description copied from interface: IHints

Clear the hintedThing from this Hints.

Specified by:

clearHintedThing in interface IHints

getHintedThing

public IXMLLink getHintedThing()

Description copied from interface: IHints

Get the hintedThing from this Hints.

Specified by:

getHintedThing in interface IHints

Returns:

hintedThing

hasHintedThing

public boolean hasHintedThing(IXMLLink value)

Description copied from interface: IHints

Determine if this Hints has the given hintedThing

Specified by:

hasHintedThing in interface IHints

Parameters:

value - hintedThing to compare

Returns:

true if the hintedThings are equivalent, false otherwise

addPropertyHint

public void addPropertyHint(IPropertyHint newPropertyHint)

Description copied from interface: IHints

Add a propertyHint to this Hints.

Specified by:

addPropertyHint in interface IHints

Parameters:

newPropertyHint - propertyHint to add.

addPropertyHints

public void addPropertyHints(Collection propertyHints)

Description copied from interface: IHints

Add a collection of propertyHints to this Hints.

Specified by:

addPropertyHints in interface IHints

Parameters:

propertyHints - propertyHints to add.

clearPropertyHints

public void clearPropertyHints()

Description copied from interface: IHints

Remove all propertyHints from this Hints.

Specified by:

clearPropertyHints in interface IHints

removePropertyHint

public void removePropertyHint(IPropertyHint propertyHintToRemove)

Description copied from interface: IHints

Remove the given propertyHint from this Hints. Matching is done by the isEquivalent(...) function.

Specified by:

removePropertyHint in interface IHints

Parameters:

propertyHintToRemove - propertyHint to remove.

removePropertyHints

public void removePropertyHints(Collection propertyHints)

Description copied from interface: IHints

Remove all the given propertyHints from this Hints. Matching is done by the isEquivalent(...) function.

Specified by:

removePropertyHints in interface IHints

Parameters:

propertyHints - propertyHint to remove.

getAllPropertyHints

public Collection getAllPropertyHints()

Description copied from interface: IHints

Get all the propertyHints from this Hints.

Specified by:

getAllPropertyHints in interface IHints

Returns:

all propertyHints in this Hints.

hasPropertyHint

public boolean hasPropertyHint(IPropertyHint propertyHintToCheck)

Description copied from interface: IHints

Determine if this Hints contains a given propertyHint.

Specified by:

hasPropertyHint in interface IHints

Returns:

true if this Hints contains the given propertyHintToCheck, false otherwise.

hasPropertyHints

public Collection hasPropertyHints(Collection propertyHintsToCheck)

Description copied from interface: IHints

Determine if this Hints contains the given set of propertyHints.

Specified by:

hasPropertyHints in interface IHints

Parameters:

propertyHintsToCheck - propertyHints to check for.

Returns:

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

hasAllPropertyHints

public boolean hasAllPropertyHints(Collection propertyHintsToCheck)

Description copied from interface: IHints

Determine if this Hints contains each element in the given set of propertyHints.

Specified by:

hasAllPropertyHints in interface IHints

Parameters:

propertyHintsToCheck - propertyHints to check for.

Returns:

true if every element in propertyHints is found in this Hints, false otherwise.

isEquivalent

public boolean isEquivalent(IHints c)

Description copied from interface: IHints

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

Specified by:

isEquivalent in interface IHints

Parameters:

c - Hints to compare to this one.

Returns:

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