edu.uci.isr.xarch.tronanalysis
Class TronAnalysisImpl

java.lang.Object
  edu.uci.isr.xarch.analysis.AnalysisImpl
      edu.uci.isr.xarch.tronanalysis.TronAnalysisImpl

All Implemented Interfaces:

DOMBased, IAnalysis, ITronAnalysis, IXArchElement

public class TronAnalysisImpl

extends AnalysisImpl

implements ITronAnalysis, IAnalysis, DOMBased

DOM-Based implementation of the ITronAnalysis interface.

Author:

Automatically generated by xArch apigen.

Field Summary

static String	DESCRIPTION_ELT_NAME Tag name for descriptions in this object.
static String	ID_ATTR_NAME Tag name for ids in this object.
static String	TEST_ELT_NAME Tag name for tests in this object.
static String	XSD_TYPE_NAME
static String	XSD_TYPE_NSURI

Fields inherited from class edu.uci.isr.xarch.analysis.AnalysisImpl

elt, xArch

Fields inherited from interface edu.uci.isr.xarch.tronanalysis.ITronAnalysis

TYPE_METADATA

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

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Constructor Summary

TronAnalysisImpl(Element elt)

Method Summary

void	addTest(ITest newTest) Add a test to this TronAnalysis.
void	addTests(Collection tests) Add a collection of tests to this TronAnalysis.
void	clearDescription() Clear the description from this TronAnalysis.
void	clearId() Removes the id attribute from this object.
void	clearTests() Remove all tests from this TronAnalysis.
IXArchElement	cloneElement(int depth)
Collection	getAllTests() Get all the tests from this TronAnalysis.
IDescription	getDescription() Get the description from this TronAnalysis.
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()
ITest	getTest(String id) Gets the test from this TronAnalysis with the given id.
Collection	getTests(Collection ids) Gets the tests from this TronAnalysis with the given ids.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
boolean	hasAllTests(Collection testsToCheck) Determine if this TronAnalysis contains each element in the given set of tests.
boolean	hasDescription(IDescription value) Determine if this TronAnalysis has the given description
boolean	hasId(String id) Determines if this object's id attribute has the given value.
boolean	hasTest(ITest testToCheck) Determine if this TronAnalysis contains a given test.
Collection	hasTests(Collection testsToCheck) Determine if this TronAnalysis contains the given set of tests.
boolean	isEquivalent(ITronAnalysis c) Determine if another TronAnalysis is equivalent to this one, ignoring ID's.
void	removeTest(ITest testToRemove) Remove the given test from this TronAnalysis.
void	removeTests(Collection tests) Remove all the given tests from this TronAnalysis.
void	setDescription(IDescription value) Set the description for this TronAnalysis.
void	setId(String id) Set the id attribute on this object.

Methods inherited from class edu.uci.isr.xarch.analysis.AnalysisImpl

equals, getDOMNode, getXArch, hashCode, isEquivalent, setDOMNode, 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.analysis.IAnalysis

isEquivalent

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

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

TEST_ELT_NAME

public static final String TEST_ELT_NAME

Tag name for tests in this object.

See Also:

Constant Field Values

Constructor Detail

TronAnalysisImpl

public TronAnalysisImpl(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 AnalysisImpl

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 AnalysisImpl

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 AnalysisImpl

setId

public void setId(String id)

Set the id attribute on this object.

Specified by:

setId in interface ITronAnalysis

Parameters:

id - attribute value.

clearId

public void clearId()

Removes the id attribute from this object.

Specified by:

clearId in interface ITronAnalysis

getId

public String getId()

Gets the value of the id attribute on this object.

Specified by:

getId in interface ITronAnalysis

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 ITronAnalysis

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: ITronAnalysis

Set the description for this TronAnalysis.

Specified by:

setDescription in interface ITronAnalysis

Parameters:

value - new description

clearDescription

public void clearDescription()

Description copied from interface: ITronAnalysis

Clear the description from this TronAnalysis.

Specified by:

clearDescription in interface ITronAnalysis

getDescription

public IDescription getDescription()

Description copied from interface: ITronAnalysis

Get the description from this TronAnalysis.

Specified by:

getDescription in interface ITronAnalysis

Returns:

description

hasDescription

public boolean hasDescription(IDescription value)

Description copied from interface: ITronAnalysis

Determine if this TronAnalysis has the given description

Specified by:

hasDescription in interface ITronAnalysis

Parameters:

value - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addTest

public void addTest(ITest newTest)

Description copied from interface: ITronAnalysis

Add a test to this TronAnalysis.

Specified by:

addTest in interface ITronAnalysis

Parameters:

newTest - test to add.

addTests

public void addTests(Collection tests)

Description copied from interface: ITronAnalysis

Add a collection of tests to this TronAnalysis.

Specified by:

addTests in interface ITronAnalysis

Parameters:

tests - tests to add.

clearTests

public void clearTests()

Description copied from interface: ITronAnalysis

Remove all tests from this TronAnalysis.

Specified by:

clearTests in interface ITronAnalysis

removeTest

public void removeTest(ITest testToRemove)

Description copied from interface: ITronAnalysis

Remove the given test from this TronAnalysis. Matching is done by the isEquivalent(...) function.

Specified by:

removeTest in interface ITronAnalysis

Parameters:

testToRemove - test to remove.

removeTests

public void removeTests(Collection tests)

Description copied from interface: ITronAnalysis

Remove all the given tests from this TronAnalysis. Matching is done by the isEquivalent(...) function.

Specified by:

removeTests in interface ITronAnalysis

Parameters:

tests - test to remove.

getAllTests

public Collection getAllTests()

Description copied from interface: ITronAnalysis

Get all the tests from this TronAnalysis.

Specified by:

getAllTests in interface ITronAnalysis

Returns:

all tests in this TronAnalysis.

hasTest

public boolean hasTest(ITest testToCheck)

Description copied from interface: ITronAnalysis

Determine if this TronAnalysis contains a given test.

Specified by:

hasTest in interface ITronAnalysis

Returns:

true if this TronAnalysis contains the given testToCheck, false otherwise.

hasTests

public Collection hasTests(Collection testsToCheck)

Description copied from interface: ITronAnalysis

Determine if this TronAnalysis contains the given set of tests.

Specified by:

hasTests in interface ITronAnalysis

Parameters:

testsToCheck - tests to check for.

Returns:

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

hasAllTests

public boolean hasAllTests(Collection testsToCheck)

Description copied from interface: ITronAnalysis

Determine if this TronAnalysis contains each element in the given set of tests.

Specified by:

hasAllTests in interface ITronAnalysis

Parameters:

testsToCheck - tests to check for.

Returns:

true if every element in tests is found in this TronAnalysis, false otherwise.

getTest

public ITest getTest(String id)

Description copied from interface: ITronAnalysis

Gets the test from this TronAnalysis with the given id.

Specified by:

getTest in interface ITronAnalysis

Parameters:

id - ID to look for.

Returns:

test with the given ID, or null if not found.

getTests

public Collection getTests(Collection ids)

Description copied from interface: ITronAnalysis

Gets the tests from this TronAnalysis with the given ids.

Specified by:

getTests in interface ITronAnalysis

Parameters:

ids - ID to look for.

Returns:

tests with the given IDs. If an element with a given ID was not found, that ID is ignored.

isEquivalent

public boolean isEquivalent(ITronAnalysis c)

Description copied from interface: ITronAnalysis

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

Specified by:

isEquivalent in interface ITronAnalysis

Parameters:

c - TronAnalysis to compare to this one.

Returns:

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