edu.uci.isr.xarch.tronanalysis
Interface ITronAnalysis

All Superinterfaces:

IAnalysis, IXArchElement

All Known Implementing Classes:

TronAnalysisImpl

public interface ITronAnalysis

extends IAnalysis, IXArchElement

Interface for accessing objects of the TronAnalysis xsi:type in the tronanalysis namespace. Extends and inherits the properties of the Analysis xsi:type.

Author:

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	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() Remove the id attribute from this TronAnalysis.
void	clearTests() Remove all tests from this TronAnalysis.
Collection	getAllTests() Get all the tests from this TronAnalysis.
IDescription	getDescription() Get the description from this TronAnalysis.
String	getId() Get the id attribute from this TronAnalysis.
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.
boolean	hasAllTests(Collection testsToCheck) Determine if this TronAnalysis contains each element in the given set of tests.
boolean	hasDescription(IDescription descriptionToCheck) Determine if this TronAnalysis has the given description
boolean	hasId(String id) Determine if the id attribute on this TronAnalysis 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 TronAnalysisToCheck) 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 TronAnalysis.

Methods inherited from interface edu.uci.isr.xarch.analysis.IAnalysis

isEquivalent

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

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

getId

public String getId()

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

hasId

public boolean hasId(String id)

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

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this TronAnalysis.

getDescription

public IDescription getDescription()

Get the description from this TronAnalysis.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this TronAnalysis has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addTest

public void addTest(ITest newTest)

Add a test to this TronAnalysis.

Parameters:

newTest - test to add.

addTests

public void addTests(Collection tests)

Add a collection of tests to this TronAnalysis.

Parameters:

tests - tests to add.

clearTests

public void clearTests()

Remove all tests from this TronAnalysis.

removeTest

public void removeTest(ITest testToRemove)

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

Parameters:

testToRemove - test to remove.

removeTests

public void removeTests(Collection tests)

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

Parameters:

tests - test to remove.

getAllTests

public Collection getAllTests()

Get all the tests from this TronAnalysis.

Returns:

all tests in this TronAnalysis.

hasTest

public boolean hasTest(ITest testToCheck)

Determine if this TronAnalysis contains a given test.

Returns:

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

hasTests

public Collection hasTests(Collection testsToCheck)

Determine if this TronAnalysis contains the given set of tests.

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)

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

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)

Gets the test from this TronAnalysis with the given id.

Parameters:

id - ID to look for.

Returns:

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

getTests

public Collection getTests(Collection ids)

Gets the tests from this TronAnalysis with the given ids.

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 TronAnalysisToCheck)

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

Parameters:

TronAnalysisToCheck - TronAnalysis to compare to this one.

Returns:

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