edu.uci.isr.xarch.types
Class TypesContext

java.lang.Object
  edu.uci.isr.xarch.types.TypesContext

All Implemented Interfaces:

ITypesContext, IXArchContext

public class TypesContext

extends Object

implements ITypesContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

IArchStructure	createArchStructure() Create an IArchStructure object in this namespace.
IArchStructure	createArchStructureElement() Create a top-level element of type IArchStructure.
IArchTypes	createArchTypes() Create an IArchTypes object in this namespace.
IArchTypes	createArchTypesElement() Create a top-level element of type IArchTypes.
IComponent	createComponent() Create an IComponent object in this namespace.
IComponentType	createComponentType() Create an IComponentType object in this namespace.
IConnector	createConnector() Create an IConnector object in this namespace.
IConnectorType	createConnectorType() Create an IConnectorType object in this namespace.
IDescription	createDescription() Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.
IDirection	createDirection() Create an edu.uci.isr.xarch.instance.IDirection object in this namespace.
protected Element	createElement(String name)
IGroup	createGroup() Create an edu.uci.isr.xarch.instance.IGroup object in this namespace.
IInterface	createInterface() Create an IInterface object in this namespace.
IInterfaceType	createInterfaceType() Create an IInterfaceType object in this namespace.
ILink	createLink() Create an ILink object in this namespace.
IPoint	createPoint() Create an edu.uci.isr.xarch.instance.IPoint object in this namespace.
IPrescribedComponentInstance	createPrescribedComponentInstance() Create an IPrescribedComponentInstance object in this namespace.
IPrescribedConnectorInstance	createPrescribedConnectorInstance() Create an IPrescribedConnectorInstance object in this namespace.
IPrescribedInterfaceInstance	createPrescribedInterfaceInstance() Create an IPrescribedInterfaceInstance object in this namespace.
IPrescribedLinkInstance	createPrescribedLinkInstance() Create an IPrescribedLinkInstance object in this namespace.
ISignature	createSignature() Create an ISignature object in this namespace.
ISignatureInterfaceMapping	createSignatureInterfaceMapping() Create an ISignatureInterfaceMapping object in this namespace.
ISubArchitecture	createSubArchitecture() Create an ISubArchitecture object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
Collection	getAllArchStructures(IXArch xArch) Gets all the IArchStructure children from the given IXArch element.
Collection	getAllArchTypess(IXArch xArch) Gets all the IArchTypes children from the given IXArch element.
IArchStructure	getArchStructure(IXArch xArch) Gets the IArchStructure child from the given IXArch element.
IArchTypes	getArchTypes(IXArch xArch) Gets the IArchTypes 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.
IPrescribedComponentInstance	promoteToPrescribedComponentInstance(IComponentInstance value) Promote an object of type edu.uci.isr.xarch.instance.IComponentInstance to one of type IPrescribedComponentInstance.
IPrescribedConnectorInstance	promoteToPrescribedConnectorInstance(IConnectorInstance value) Promote an object of type edu.uci.isr.xarch.instance.IConnectorInstance to one of type IPrescribedConnectorInstance.
IPrescribedInterfaceInstance	promoteToPrescribedInterfaceInstance(IInterfaceInstance value) Promote an object of type edu.uci.isr.xarch.instance.IInterfaceInstance to one of type IPrescribedInterfaceInstance.
IPrescribedLinkInstance	promoteToPrescribedLinkInstance(ILinkInstance value) Promote an object of type edu.uci.isr.xarch.instance.ILinkInstance to one of type IPrescribedLinkInstance.
IArchStructure	recontextualizeArchStructure(IArchStructure value) Brings an IArchStructure object created in another context into this context.
IArchTypes	recontextualizeArchTypes(IArchTypes value) Brings an IArchTypes object created in another context into this context.
IComponent	recontextualizeComponent(IComponent value) Brings an IComponent object created in another context into this context.
IComponentType	recontextualizeComponentType(IComponentType value) Brings an IComponentType object created in another context into this context.
IConnector	recontextualizeConnector(IConnector value) Brings an IConnector object created in another context into this context.
IConnectorType	recontextualizeConnectorType(IConnectorType value) Brings an IConnectorType object created in another context into this context.
IDescription	recontextualizeDescription(IDescription value) Brings an edu.uci.isr.xarch.instance.IDescription object created in another context into this context.
IDirection	recontextualizeDirection(IDirection value) Brings an edu.uci.isr.xarch.instance.IDirection object created in another context into this context.
IGroup	recontextualizeGroup(IGroup value) Brings an edu.uci.isr.xarch.instance.IGroup object created in another context into this context.
IInterface	recontextualizeInterface(IInterface value) Brings an IInterface object created in another context into this context.
IInterfaceType	recontextualizeInterfaceType(IInterfaceType value) Brings an IInterfaceType object created in another context into this context.
ILink	recontextualizeLink(ILink value) Brings an ILink object created in another context into this context.
IPoint	recontextualizePoint(IPoint value) Brings an edu.uci.isr.xarch.instance.IPoint object created in another context into this context.
IPrescribedComponentInstance	recontextualizePrescribedComponentInstance(IPrescribedComponentInstance value) Brings an IPrescribedComponentInstance object created in another context into this context.
IPrescribedConnectorInstance	recontextualizePrescribedConnectorInstance(IPrescribedConnectorInstance value) Brings an IPrescribedConnectorInstance object created in another context into this context.
IPrescribedInterfaceInstance	recontextualizePrescribedInterfaceInstance(IPrescribedInterfaceInstance value) Brings an IPrescribedInterfaceInstance object created in another context into this context.
IPrescribedLinkInstance	recontextualizePrescribedLinkInstance(IPrescribedLinkInstance value) Brings an IPrescribedLinkInstance object created in another context into this context.
ISignature	recontextualizeSignature(ISignature value) Brings an ISignature object created in another context into this context.
ISignatureInterfaceMapping	recontextualizeSignatureInterfaceMapping(ISignatureInterfaceMapping value) Brings an ISignatureInterfaceMapping 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 edu.uci.isr.xarch.instance.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

TypesContext

public TypesContext(IXArch xArch)

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

createInterface

public IInterface createInterface()

Create an IInterface object in this namespace.

Specified by:

createInterface in interface ITypesContext

Returns:

New IInterface object.

recontextualizeInterface

public IInterface recontextualizeInterface(IInterface value)

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

Specified by:

recontextualizeInterface in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDescription

public IDescription createDescription()

Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.

Specified by:

createDescription in interface ITypesContext

Returns:

New edu.uci.isr.xarch.instance.IDescription object.

recontextualizeDescription

public IDescription recontextualizeDescription(IDescription value)

Brings an edu.uci.isr.xarch.instance.IDescription object created in another context into this context.

Specified by:

recontextualizeDescription in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDirection

public IDirection createDirection()

Create an edu.uci.isr.xarch.instance.IDirection object in this namespace.

Specified by:

createDirection in interface ITypesContext

Returns:

New edu.uci.isr.xarch.instance.IDirection object.

recontextualizeDirection

public IDirection recontextualizeDirection(IDirection value)

Brings an edu.uci.isr.xarch.instance.IDirection object created in another context into this context.

Specified by:

recontextualizeDirection in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createXMLLink

public IXMLLink createXMLLink()

Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.

Specified by:

createXMLLink in interface ITypesContext

Returns:

New edu.uci.isr.xarch.instance.IXMLLink object.

recontextualizeXMLLink

public IXMLLink recontextualizeXMLLink(IXMLLink value)

Brings an edu.uci.isr.xarch.instance.IXMLLink object created in another context into this context.

Specified by:

recontextualizeXMLLink in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createComponent

public IComponent createComponent()

Create an IComponent object in this namespace.

Specified by:

createComponent in interface ITypesContext

Returns:

New IComponent object.

recontextualizeComponent

public IComponent recontextualizeComponent(IComponent value)

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

Specified by:

recontextualizeComponent in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createConnector

public IConnector createConnector()

Create an IConnector object in this namespace.

Specified by:

createConnector in interface ITypesContext

Returns:

New IConnector object.

recontextualizeConnector

public IConnector recontextualizeConnector(IConnector value)

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

Specified by:

recontextualizeConnector in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createLink

public ILink createLink()

Create an ILink object in this namespace.

Specified by:

createLink in interface ITypesContext

Returns:

New ILink object.

recontextualizeLink

public ILink recontextualizeLink(ILink value)

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

Specified by:

recontextualizeLink in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPoint

public IPoint createPoint()

Create an edu.uci.isr.xarch.instance.IPoint object in this namespace.

Specified by:

createPoint in interface ITypesContext

Returns:

New edu.uci.isr.xarch.instance.IPoint object.

recontextualizePoint

public IPoint recontextualizePoint(IPoint value)

Brings an edu.uci.isr.xarch.instance.IPoint object created in another context into this context.

Specified by:

recontextualizePoint in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createSignatureInterfaceMapping

public ISignatureInterfaceMapping createSignatureInterfaceMapping()

Create an ISignatureInterfaceMapping object in this namespace.

Specified by:

createSignatureInterfaceMapping in interface ITypesContext

Returns:

New ISignatureInterfaceMapping object.

recontextualizeSignatureInterfaceMapping

public ISignatureInterfaceMapping recontextualizeSignatureInterfaceMapping(ISignatureInterfaceMapping value)

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

Specified by:

recontextualizeSignatureInterfaceMapping in interface ITypesContext

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 ITypesContext

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 ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchStructure

public IArchStructure createArchStructure()

Create an IArchStructure object in this namespace.

Specified by:

createArchStructure in interface ITypesContext

Returns:

New IArchStructure object.

recontextualizeArchStructure

public IArchStructure recontextualizeArchStructure(IArchStructure value)

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

Specified by:

recontextualizeArchStructure in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createGroup

public IGroup createGroup()

Create an edu.uci.isr.xarch.instance.IGroup object in this namespace.

Specified by:

createGroup in interface ITypesContext

Returns:

New edu.uci.isr.xarch.instance.IGroup object.

recontextualizeGroup

public IGroup recontextualizeGroup(IGroup value)

Brings an edu.uci.isr.xarch.instance.IGroup object created in another context into this context.

Specified by:

recontextualizeGroup in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createSignature

public ISignature createSignature()

Create an ISignature object in this namespace.

Specified by:

createSignature in interface ITypesContext

Returns:

New ISignature object.

recontextualizeSignature

public ISignature recontextualizeSignature(ISignature value)

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

Specified by:

recontextualizeSignature in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createComponentType

public IComponentType createComponentType()

Create an IComponentType object in this namespace.

Specified by:

createComponentType in interface ITypesContext

Returns:

New IComponentType object.

recontextualizeComponentType

public IComponentType recontextualizeComponentType(IComponentType value)

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

Specified by:

recontextualizeComponentType in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createConnectorType

public IConnectorType createConnectorType()

Create an IConnectorType object in this namespace.

Specified by:

createConnectorType in interface ITypesContext

Returns:

New IConnectorType object.

recontextualizeConnectorType

public IConnectorType recontextualizeConnectorType(IConnectorType value)

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

Specified by:

recontextualizeConnectorType in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createInterfaceType

public IInterfaceType createInterfaceType()

Create an IInterfaceType object in this namespace.

Specified by:

createInterfaceType in interface ITypesContext

Returns:

New IInterfaceType object.

recontextualizeInterfaceType

public IInterfaceType recontextualizeInterfaceType(IInterfaceType value)

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

Specified by:

recontextualizeInterfaceType in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchTypes

public IArchTypes createArchTypes()

Create an IArchTypes object in this namespace.

Specified by:

createArchTypes in interface ITypesContext

Returns:

New IArchTypes object.

recontextualizeArchTypes

public IArchTypes recontextualizeArchTypes(IArchTypes value)

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

Specified by:

recontextualizeArchTypes in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPrescribedComponentInstance

public IPrescribedComponentInstance createPrescribedComponentInstance()

Create an IPrescribedComponentInstance object in this namespace.

Specified by:

createPrescribedComponentInstance in interface ITypesContext

Returns:

New IPrescribedComponentInstance object.

recontextualizePrescribedComponentInstance

public IPrescribedComponentInstance recontextualizePrescribedComponentInstance(IPrescribedComponentInstance value)

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

Specified by:

recontextualizePrescribedComponentInstance in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToPrescribedComponentInstance

public IPrescribedComponentInstance promoteToPrescribedComponentInstance(IComponentInstance value)

Promote an object of type edu.uci.isr.xarch.instance.IComponentInstance to one of type IPrescribedComponentInstance. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.instance.IComponentInstance object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Specified by:

promoteToPrescribedComponentInstance in interface ITypesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createPrescribedConnectorInstance

public IPrescribedConnectorInstance createPrescribedConnectorInstance()

Create an IPrescribedConnectorInstance object in this namespace.

Specified by:

createPrescribedConnectorInstance in interface ITypesContext

Returns:

New IPrescribedConnectorInstance object.

recontextualizePrescribedConnectorInstance

public IPrescribedConnectorInstance recontextualizePrescribedConnectorInstance(IPrescribedConnectorInstance value)

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

Specified by:

recontextualizePrescribedConnectorInstance in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToPrescribedConnectorInstance

public IPrescribedConnectorInstance promoteToPrescribedConnectorInstance(IConnectorInstance value)

Promote an object of type edu.uci.isr.xarch.instance.IConnectorInstance to one of type IPrescribedConnectorInstance. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.instance.IConnectorInstance object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Specified by:

promoteToPrescribedConnectorInstance in interface ITypesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createPrescribedInterfaceInstance

public IPrescribedInterfaceInstance createPrescribedInterfaceInstance()

Create an IPrescribedInterfaceInstance object in this namespace.

Specified by:

createPrescribedInterfaceInstance in interface ITypesContext

Returns:

New IPrescribedInterfaceInstance object.

recontextualizePrescribedInterfaceInstance

public IPrescribedInterfaceInstance recontextualizePrescribedInterfaceInstance(IPrescribedInterfaceInstance value)

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

Specified by:

recontextualizePrescribedInterfaceInstance in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToPrescribedInterfaceInstance

public IPrescribedInterfaceInstance promoteToPrescribedInterfaceInstance(IInterfaceInstance value)

Promote an object of type edu.uci.isr.xarch.instance.IInterfaceInstance to one of type IPrescribedInterfaceInstance. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.instance.IInterfaceInstance object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Specified by:

promoteToPrescribedInterfaceInstance in interface ITypesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createPrescribedLinkInstance

public IPrescribedLinkInstance createPrescribedLinkInstance()

Create an IPrescribedLinkInstance object in this namespace.

Specified by:

createPrescribedLinkInstance in interface ITypesContext

Returns:

New IPrescribedLinkInstance object.

recontextualizePrescribedLinkInstance

public IPrescribedLinkInstance recontextualizePrescribedLinkInstance(IPrescribedLinkInstance value)

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

Specified by:

recontextualizePrescribedLinkInstance in interface ITypesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToPrescribedLinkInstance

public IPrescribedLinkInstance promoteToPrescribedLinkInstance(ILinkInstance value)

Promote an object of type edu.uci.isr.xarch.instance.ILinkInstance to one of type IPrescribedLinkInstance. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.instance.ILinkInstance object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Specified by:

promoteToPrescribedLinkInstance in interface ITypesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createArchStructureElement

public IArchStructure createArchStructureElement()

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

Specified by:

createArchStructureElement in interface ITypesContext

Returns:

new IArchStructure suitable for adding as a child of xArch.

getArchStructure

public IArchStructure getArchStructure(IXArch xArch)

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

Specified by:

getArchStructure in interface ITypesContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

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

getAllArchStructures

public Collection getAllArchStructures(IXArch xArch)

Gets all the IArchStructure children from the given IXArch element.

Specified by:

getAllArchStructures in interface ITypesContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

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

createArchTypesElement

public IArchTypes createArchTypesElement()

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

Specified by:

createArchTypesElement in interface ITypesContext

Returns:

new IArchTypes suitable for adding as a child of xArch.

getArchTypes

public IArchTypes getArchTypes(IXArch xArch)

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

Specified by:

getArchTypes in interface ITypesContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

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

getAllArchTypess

public Collection getAllArchTypess(IXArch xArch)

Gets all the IArchTypes children from the given IXArch element.

Specified by:

getAllArchTypess in interface ITypesContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

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