edu.uci.isr.xarch.instance
Class InstanceContext

java.lang.Object
  edu.uci.isr.xarch.instance.InstanceContext

All Implemented Interfaces:

IInstanceContext, IXArchContext

public class InstanceContext

extends Object

implements IInstanceContext

The context object for the instance package. This object is used to create objects that are used in the instance 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.instance.IInstanceContext

TYPE_METADATA

Constructor Summary

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

Method Summary

IArchInstance	createArchInstance() Create an IArchInstance object in this namespace.
IArchInstance	createArchInstanceElement() Create a top-level element of type IArchInstance.
IComponentInstance	createComponentInstance() Create an IComponentInstance object in this namespace.
IConnectorInstance	createConnectorInstance() Create an IConnectorInstance object in this namespace.
IDescription	createDescription() Create an IDescription object in this namespace.
IDirection	createDirection() Create an IDirection object in this namespace.
IDirectionSimpleType	createDirectionSimpleType() Create an IDirectionSimpleType object in this namespace.
protected Element	createElement(String name)
IGroup	createGroup() Create an IGroup object in this namespace.
IIdentifier	createIdentifier() Create an IIdentifier object in this namespace.
IInterfaceInstance	createInterfaceInstance() Create an IInterfaceInstance object in this namespace.
IInterfaceInstanceMapping	createInterfaceInstanceMapping() Create an IInterfaceInstanceMapping object in this namespace.
ILinkInstance	createLinkInstance() Create an ILinkInstance object in this namespace.
IPoint	createPoint() Create an IPoint object in this namespace.
ISubArchitecture	createSubArchitecture() Create an ISubArchitecture object in this namespace.
IXMLLink	createXMLLink() Create an IXMLLink object in this namespace.
Collection	getAllArchInstances(IXArch xArch) Gets all the IArchInstance children from the given IXArch element.
IArchInstance	getArchInstance(IXArch xArch) Gets the IArchInstance 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.
IArchInstance	recontextualizeArchInstance(IArchInstance value) Brings an IArchInstance object created in another context into this context.
IComponentInstance	recontextualizeComponentInstance(IComponentInstance value) Brings an IComponentInstance object created in another context into this context.
IConnectorInstance	recontextualizeConnectorInstance(IConnectorInstance value) Brings an IConnectorInstance object created in another context into this context.
IDescription	recontextualizeDescription(IDescription value) Brings an IDescription object created in another context into this context.
IDirection	recontextualizeDirection(IDirection value) Brings an IDirection object created in another context into this context.
IDirectionSimpleType	recontextualizeDirectionSimpleType(IDirectionSimpleType value) Brings an IDirectionSimpleType object created in another context into this context.
IGroup	recontextualizeGroup(IGroup value) Brings an IGroup object created in another context into this context.
IIdentifier	recontextualizeIdentifier(IIdentifier value) Brings an IIdentifier object created in another context into this context.
IInterfaceInstance	recontextualizeInterfaceInstance(IInterfaceInstance value) Brings an IInterfaceInstance object created in another context into this context.
IInterfaceInstanceMapping	recontextualizeInterfaceInstanceMapping(IInterfaceInstanceMapping value) Brings an IInterfaceInstanceMapping object created in another context into this context.
ILinkInstance	recontextualizeLinkInstance(ILinkInstance value) Brings an ILinkInstance object created in another context into this context.
IPoint	recontextualizePoint(IPoint value) Brings an IPoint object created in another context into this context.
ISubArchitecture	recontextualizeSubArchitecture(ISubArchitecture value) Brings an ISubArchitecture object created in another context into this context.
IXMLLink	recontextualizeXMLLink(IXMLLink value) Brings an IXMLLink 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

InstanceContext

public InstanceContext(IXArch xArch)

Create a new InstanceContext 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.

createIdentifier

public IIdentifier createIdentifier()

Create an IIdentifier object in this namespace.

Specified by:

createIdentifier in interface IInstanceContext

Returns:

New IIdentifier object.

recontextualizeIdentifier

public IIdentifier recontextualizeIdentifier(IIdentifier value)

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

Specified by:

recontextualizeIdentifier in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDirectionSimpleType

public IDirectionSimpleType createDirectionSimpleType()

Create an IDirectionSimpleType object in this namespace.

Specified by:

createDirectionSimpleType in interface IInstanceContext

Returns:

New IDirectionSimpleType object.

recontextualizeDirectionSimpleType

public IDirectionSimpleType recontextualizeDirectionSimpleType(IDirectionSimpleType value)

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

Specified by:

recontextualizeDirectionSimpleType in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDescription

public IDescription createDescription()

Create an IDescription object in this namespace.

Specified by:

createDescription in interface IInstanceContext

Returns:

New IDescription object.

recontextualizeDescription

public IDescription recontextualizeDescription(IDescription value)

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

Specified by:

recontextualizeDescription in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDirection

public IDirection createDirection()

Create an IDirection object in this namespace.

Specified by:

createDirection in interface IInstanceContext

Returns:

New IDirection object.

recontextualizeDirection

public IDirection recontextualizeDirection(IDirection value)

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

Specified by:

recontextualizeDirection in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createXMLLink

public IXMLLink createXMLLink()

Create an IXMLLink object in this namespace.

Specified by:

createXMLLink in interface IInstanceContext

Returns:

New IXMLLink object.

recontextualizeXMLLink

public IXMLLink recontextualizeXMLLink(IXMLLink value)

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

Specified by:

recontextualizeXMLLink in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createInterfaceInstance

public IInterfaceInstance createInterfaceInstance()

Create an IInterfaceInstance object in this namespace.

Specified by:

createInterfaceInstance in interface IInstanceContext

Returns:

New IInterfaceInstance object.

recontextualizeInterfaceInstance

public IInterfaceInstance recontextualizeInterfaceInstance(IInterfaceInstance value)

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

Specified by:

recontextualizeInterfaceInstance in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createComponentInstance

public IComponentInstance createComponentInstance()

Create an IComponentInstance object in this namespace.

Specified by:

createComponentInstance in interface IInstanceContext

Returns:

New IComponentInstance object.

recontextualizeComponentInstance

public IComponentInstance recontextualizeComponentInstance(IComponentInstance value)

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

Specified by:

recontextualizeComponentInstance in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createConnectorInstance

public IConnectorInstance createConnectorInstance()

Create an IConnectorInstance object in this namespace.

Specified by:

createConnectorInstance in interface IInstanceContext

Returns:

New IConnectorInstance object.

recontextualizeConnectorInstance

public IConnectorInstance recontextualizeConnectorInstance(IConnectorInstance value)

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

Specified by:

recontextualizeConnectorInstance in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPoint

public IPoint createPoint()

Create an IPoint object in this namespace.

Specified by:

createPoint in interface IInstanceContext

Returns:

New IPoint object.

recontextualizePoint

public IPoint recontextualizePoint(IPoint value)

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

Specified by:

recontextualizePoint in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createLinkInstance

public ILinkInstance createLinkInstance()

Create an ILinkInstance object in this namespace.

Specified by:

createLinkInstance in interface IInstanceContext

Returns:

New ILinkInstance object.

recontextualizeLinkInstance

public ILinkInstance recontextualizeLinkInstance(ILinkInstance value)

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

Specified by:

recontextualizeLinkInstance in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createGroup

public IGroup createGroup()

Create an IGroup object in this namespace.

Specified by:

createGroup in interface IInstanceContext

Returns:

New IGroup object.

recontextualizeGroup

public IGroup recontextualizeGroup(IGroup value)

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

Specified by:

recontextualizeGroup in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createInterfaceInstanceMapping

public IInterfaceInstanceMapping createInterfaceInstanceMapping()

Create an IInterfaceInstanceMapping object in this namespace.

Specified by:

createInterfaceInstanceMapping in interface IInstanceContext

Returns:

New IInterfaceInstanceMapping object.

recontextualizeInterfaceInstanceMapping

public IInterfaceInstanceMapping recontextualizeInterfaceInstanceMapping(IInterfaceInstanceMapping value)

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

Specified by:

recontextualizeInterfaceInstanceMapping in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createSubArchitecture

public ISubArchitecture createSubArchitecture()

Create an ISubArchitecture object in this namespace.

Specified by:

createSubArchitecture in interface IInstanceContext

Returns:

New ISubArchitecture object.

recontextualizeSubArchitecture

public ISubArchitecture recontextualizeSubArchitecture(ISubArchitecture value)

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

Specified by:

recontextualizeSubArchitecture in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchInstance

public IArchInstance createArchInstance()

Create an IArchInstance object in this namespace.

Specified by:

createArchInstance in interface IInstanceContext

Returns:

New IArchInstance object.

recontextualizeArchInstance

public IArchInstance recontextualizeArchInstance(IArchInstance value)

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

Specified by:

recontextualizeArchInstance in interface IInstanceContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchInstanceElement

public IArchInstance createArchInstanceElement()

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

Specified by:

createArchInstanceElement in interface IInstanceContext

Returns:

new IArchInstance suitable for adding as a child of xArch.

getArchInstance

public IArchInstance getArchInstance(IXArch xArch)

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

Specified by:

getArchInstance in interface IInstanceContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

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

getAllArchInstances

public Collection getAllArchInstances(IXArch xArch)

Gets all the IArchInstance children from the given IXArch element.

Specified by:

getAllArchInstances in interface IInstanceContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

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