edu.uci.isr.xarch.versions
Class VersionsContext

java.lang.Object
  edu.uci.isr.xarch.versions.VersionsContext

All Implemented Interfaces:

IVersionsContext, IXArchContext

public class VersionsContext

extends Object

implements IVersionsContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

IArchVersions	createArchVersions() Create an IArchVersions object in this namespace.
IArchVersions	createArchVersionsElement() Create a top-level element of type IArchVersions.
IComponentTypeVersionGraph	createComponentTypeVersionGraph() Create an IComponentTypeVersionGraph object in this namespace.
IConnectorTypeVersionGraph	createConnectorTypeVersionGraph() Create an IConnectorTypeVersionGraph object in this namespace.
IDescription	createDescription() Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.
protected Element	createElement(String name)
IInterfaceTypeImplVers	createInterfaceTypeImplVers() Create an IInterfaceTypeImplVers object in this namespace.
IInterfaceTypeVersionGraph	createInterfaceTypeVersionGraph() Create an IInterfaceTypeVersionGraph object in this namespace.
INode	createNode() Create an INode object in this namespace.
IVariantComponentTypeImplVers	createVariantComponentTypeImplVers() Create an IVariantComponentTypeImplVers object in this namespace.
IVariantConnectorTypeImplVers	createVariantConnectorTypeImplVers() Create an IVariantConnectorTypeImplVers object in this namespace.
IVersionID	createVersionID() Create an IVersionID object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
Collection	getAllArchVersionss(IXArch xArch) Gets all the IArchVersions children from the given IXArch element.
IArchVersions	getArchVersions(IXArch xArch) Gets the IArchVersions 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.
IInterfaceTypeImplVers	promoteToInterfaceTypeImplVers(IInterfaceTypeImpl value) Promote an object of type edu.uci.isr.xarch.implementation.IInterfaceTypeImpl to one of type IInterfaceTypeImplVers.
IVariantComponentTypeImplVers	promoteToVariantComponentTypeImplVers(IVariantComponentTypeImpl value) Promote an object of type edu.uci.isr.xarch.implementation.IVariantComponentTypeImpl to one of type IVariantComponentTypeImplVers.
IVariantConnectorTypeImplVers	promoteToVariantConnectorTypeImplVers(IVariantConnectorTypeImpl value) Promote an object of type edu.uci.isr.xarch.implementation.IVariantConnectorTypeImpl to one of type IVariantConnectorTypeImplVers.
IArchVersions	recontextualizeArchVersions(IArchVersions value) Brings an IArchVersions object created in another context into this context.
IComponentTypeVersionGraph	recontextualizeComponentTypeVersionGraph(IComponentTypeVersionGraph value) Brings an IComponentTypeVersionGraph object created in another context into this context.
IConnectorTypeVersionGraph	recontextualizeConnectorTypeVersionGraph(IConnectorTypeVersionGraph value) Brings an IConnectorTypeVersionGraph 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.
IInterfaceTypeImplVers	recontextualizeInterfaceTypeImplVers(IInterfaceTypeImplVers value) Brings an IInterfaceTypeImplVers object created in another context into this context.
IInterfaceTypeVersionGraph	recontextualizeInterfaceTypeVersionGraph(IInterfaceTypeVersionGraph value) Brings an IInterfaceTypeVersionGraph object created in another context into this context.
INode	recontextualizeNode(INode value) Brings an INode object created in another context into this context.
IVariantComponentTypeImplVers	recontextualizeVariantComponentTypeImplVers(IVariantComponentTypeImplVers value) Brings an IVariantComponentTypeImplVers object created in another context into this context.
IVariantConnectorTypeImplVers	recontextualizeVariantConnectorTypeImplVers(IVariantConnectorTypeImplVers value) Brings an IVariantConnectorTypeImplVers object created in another context into this context.
IVersionID	recontextualizeVersionID(IVersionID value) Brings an IVersionID 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

VersionsContext

public VersionsContext(IXArch xArch)

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

createVersionID

public IVersionID createVersionID()

Create an IVersionID object in this namespace.

Specified by:

createVersionID in interface IVersionsContext

Returns:

New IVersionID object.

recontextualizeVersionID

public IVersionID recontextualizeVersionID(IVersionID value)

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

Specified by:

recontextualizeVersionID in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createNode

public INode createNode()

Create an INode object in this namespace.

Specified by:

createNode in interface IVersionsContext

Returns:

New INode object.

recontextualizeNode

public INode recontextualizeNode(INode value)

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

Specified by:

recontextualizeNode in interface IVersionsContext

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 IVersionsContext

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 IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createComponentTypeVersionGraph

public IComponentTypeVersionGraph createComponentTypeVersionGraph()

Create an IComponentTypeVersionGraph object in this namespace.

Specified by:

createComponentTypeVersionGraph in interface IVersionsContext

Returns:

New IComponentTypeVersionGraph object.

recontextualizeComponentTypeVersionGraph

public IComponentTypeVersionGraph recontextualizeComponentTypeVersionGraph(IComponentTypeVersionGraph value)

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

Specified by:

recontextualizeComponentTypeVersionGraph in interface IVersionsContext

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 IVersionsContext

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 IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createConnectorTypeVersionGraph

public IConnectorTypeVersionGraph createConnectorTypeVersionGraph()

Create an IConnectorTypeVersionGraph object in this namespace.

Specified by:

createConnectorTypeVersionGraph in interface IVersionsContext

Returns:

New IConnectorTypeVersionGraph object.

recontextualizeConnectorTypeVersionGraph

public IConnectorTypeVersionGraph recontextualizeConnectorTypeVersionGraph(IConnectorTypeVersionGraph value)

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

Specified by:

recontextualizeConnectorTypeVersionGraph in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createInterfaceTypeVersionGraph

public IInterfaceTypeVersionGraph createInterfaceTypeVersionGraph()

Create an IInterfaceTypeVersionGraph object in this namespace.

Specified by:

createInterfaceTypeVersionGraph in interface IVersionsContext

Returns:

New IInterfaceTypeVersionGraph object.

recontextualizeInterfaceTypeVersionGraph

public IInterfaceTypeVersionGraph recontextualizeInterfaceTypeVersionGraph(IInterfaceTypeVersionGraph value)

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

Specified by:

recontextualizeInterfaceTypeVersionGraph in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createArchVersions

public IArchVersions createArchVersions()

Create an IArchVersions object in this namespace.

Specified by:

createArchVersions in interface IVersionsContext

Returns:

New IArchVersions object.

recontextualizeArchVersions

public IArchVersions recontextualizeArchVersions(IArchVersions value)

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

Specified by:

recontextualizeArchVersions in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createVariantComponentTypeImplVers

public IVariantComponentTypeImplVers createVariantComponentTypeImplVers()

Create an IVariantComponentTypeImplVers object in this namespace.

Specified by:

createVariantComponentTypeImplVers in interface IVersionsContext

Returns:

New IVariantComponentTypeImplVers object.

recontextualizeVariantComponentTypeImplVers

public IVariantComponentTypeImplVers recontextualizeVariantComponentTypeImplVers(IVariantComponentTypeImplVers value)

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

Specified by:

recontextualizeVariantComponentTypeImplVers in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantComponentTypeImplVers

public IVariantComponentTypeImplVers promoteToVariantComponentTypeImplVers(IVariantComponentTypeImpl value)

Promote an object of type edu.uci.isr.xarch.implementation.IVariantComponentTypeImpl to one of type IVariantComponentTypeImplVers. 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.implementation.IVariantComponentTypeImpl 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:

promoteToVariantComponentTypeImplVers in interface IVersionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createVariantConnectorTypeImplVers

public IVariantConnectorTypeImplVers createVariantConnectorTypeImplVers()

Create an IVariantConnectorTypeImplVers object in this namespace.

Specified by:

createVariantConnectorTypeImplVers in interface IVersionsContext

Returns:

New IVariantConnectorTypeImplVers object.

recontextualizeVariantConnectorTypeImplVers

public IVariantConnectorTypeImplVers recontextualizeVariantConnectorTypeImplVers(IVariantConnectorTypeImplVers value)

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

Specified by:

recontextualizeVariantConnectorTypeImplVers in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantConnectorTypeImplVers

public IVariantConnectorTypeImplVers promoteToVariantConnectorTypeImplVers(IVariantConnectorTypeImpl value)

Promote an object of type edu.uci.isr.xarch.implementation.IVariantConnectorTypeImpl to one of type IVariantConnectorTypeImplVers. 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.implementation.IVariantConnectorTypeImpl 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:

promoteToVariantConnectorTypeImplVers in interface IVersionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createInterfaceTypeImplVers

public IInterfaceTypeImplVers createInterfaceTypeImplVers()

Create an IInterfaceTypeImplVers object in this namespace.

Specified by:

createInterfaceTypeImplVers in interface IVersionsContext

Returns:

New IInterfaceTypeImplVers object.

recontextualizeInterfaceTypeImplVers

public IInterfaceTypeImplVers recontextualizeInterfaceTypeImplVers(IInterfaceTypeImplVers value)

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

Specified by:

recontextualizeInterfaceTypeImplVers in interface IVersionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToInterfaceTypeImplVers

public IInterfaceTypeImplVers promoteToInterfaceTypeImplVers(IInterfaceTypeImpl value)

Promote an object of type edu.uci.isr.xarch.implementation.IInterfaceTypeImpl to one of type IInterfaceTypeImplVers. 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.implementation.IInterfaceTypeImpl 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:

promoteToInterfaceTypeImplVers in interface IVersionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createArchVersionsElement

public IArchVersions createArchVersionsElement()

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

Specified by:

createArchVersionsElement in interface IVersionsContext

Returns:

new IArchVersions suitable for adding as a child of xArch.

getArchVersions

public IArchVersions getArchVersions(IXArch xArch)

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

Specified by:

getArchVersions in interface IVersionsContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

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

getAllArchVersionss

public Collection getAllArchVersionss(IXArch xArch)

Gets all the IArchVersions children from the given IXArch element.

Specified by:

getAllArchVersionss in interface IVersionsContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

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