edu.uci.isr.xarch.analysis
Class AnalysisContext

java.lang.Object
  edu.uci.isr.xarch.analysis.AnalysisContext

All Implemented Interfaces:

IAnalysisContext, IXArchContext

public class AnalysisContext

extends Object

implements IAnalysisContext

The context object for the analysis package. This object is used to create objects that are used in the analysis namespace.

Author:

Automatically Generated by xArch apigen

Field Summary

protected static String	DEFAULT_ELT_NAME
protected Document	doc
protected IXArch	xArch

Fields inherited from interface edu.uci.isr.xarch.analysis.IAnalysisContext

TYPE_METADATA

Constructor Summary

AnalysisContext(IXArch xArch)
Create a new AnalysisContext for the given IXArch object.

Method Summary

IAnalysis	createAnalysis() Create an IAnalysis object in this namespace.
IArchAnalysis	createArchAnalysis() Create an IArchAnalysis object in this namespace.
IArchAnalysis	createArchAnalysisElement() Create a top-level element of type IArchAnalysis.
protected Element	createElement(String name)
Collection	getAllArchAnalysiss(IXArch xArch) Gets all the IArchAnalysis children from the given IXArch element.
IArchAnalysis	getArchAnalysis(IXArch xArch) Gets the IArchAnalysis child from the given IXArch element.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch() Get the IXArch object that this context is based upon.
IAnalysis	recontextualizeAnalysis(IAnalysis value) Brings an IAnalysis object created in another context into this context.
IArchAnalysis	recontextualizeArchAnalysis(IArchAnalysis value) Brings an IArchAnalysis object created in another context into this context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ELT_NAME

protected static final String DEFAULT_ELT_NAME

See Also:

Constant Field Values

doc

protected Document doc

xArch

protected IXArch xArch

Constructor Detail

AnalysisContext

public AnalysisContext(IXArch xArch)

Create a new AnalysisContext for the given IXArch object.

Parameters:

xArch - XArch object to contextualize in this namespace.

Method Detail

getXArch

public IXArch getXArch()

Description copied from interface: IXArchContext

Get the IXArch object that this context is based upon.

Specified by:

getXArch in interface IXArchContext

Returns:

IXArch object upon which this context is based.

createElement

protected Element createElement(String name)

getTypeMetadata

public XArchTypeMetadata getTypeMetadata()

Description copied from interface: IXArchContext

Gets metadata describing the xsi:type of this element.

Specified by:

getTypeMetadata in interface IXArchContext

Returns:

metadata describing the xsi:type of this element.

createArchAnalysis

public IArchAnalysis createArchAnalysis()

Create an IArchAnalysis object in this namespace.

Specified by:

createArchAnalysis in interface IAnalysisContext

Returns:

New IArchAnalysis object.

recontextualizeArchAnalysis

public IArchAnalysis recontextualizeArchAnalysis(IArchAnalysis value)

Brings an IArchAnalysis object created in another context into this context.

Specified by:

recontextualizeArchAnalysis in interface IAnalysisContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createAnalysis

public IAnalysis createAnalysis()

Create an IAnalysis object in this namespace.

Specified by:

createAnalysis in interface IAnalysisContext

Returns:

New IAnalysis object.

recontextualizeAnalysis

public IAnalysis recontextualizeAnalysis(IAnalysis value)

Brings an IAnalysis object created in another context into this context.

Specified by:

recontextualizeAnalysis in interface IAnalysisContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchAnalysisElement

public IArchAnalysis createArchAnalysisElement()

Create a top-level element of type IArchAnalysis. This function should be used in lieu of createArchAnalysis if the element is to be added as a sub-object of IXArch.

Specified by:

createArchAnalysisElement in interface IAnalysisContext

Returns:

new IArchAnalysis suitable for adding as a child of xArch.

getArchAnalysis

public IArchAnalysis getArchAnalysis(IXArch xArch)

Gets the IArchAnalysis child from the given IXArch element. If there are multiple matching children, this returns the first one.

Specified by:

getArchAnalysis in interface IAnalysisContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

IArchAnalysis that is the child of xArch or null if no such object exists.

getAllArchAnalysiss

public Collection getAllArchAnalysiss(IXArch xArch)

Gets all the IArchAnalysis children from the given IXArch element.

Specified by:

getAllArchAnalysiss in interface IAnalysisContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

Collection of IArchAnalysis that are the children of xArch or an empty collection if no such object exists.