edu.uci.isr.xarch.variants
Class VariantsContext

java.lang.Object
  edu.uci.isr.xarch.variants.VariantsContext

All Implemented Interfaces:

IVariantsContext, IXArchContext

public class VariantsContext

extends Object

implements IVariantsContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

protected Element	createElement(String name)
IGuard	createGuard() Create an edu.uci.isr.xarch.options.IGuard object in this namespace.
IVariant	createVariant() Create an IVariant object in this namespace.
IVariantComponentType	createVariantComponentType() Create an IVariantComponentType object in this namespace.
IVariantConnectorType	createVariantConnectorType() Create an IVariantConnectorType object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
XArchTypeMetadata	getTypeMetadata() Gets metadata describing the xsi:type of this element.
IXArch	getXArch() Get the IXArch object that this context is based upon.
IVariantComponentType	promoteToVariantComponentType(IComponentType value) Promote an object of type edu.uci.isr.xarch.types.IComponentType to one of type IVariantComponentType.
IVariantConnectorType	promoteToVariantConnectorType(IConnectorType value) Promote an object of type edu.uci.isr.xarch.types.IConnectorType to one of type IVariantConnectorType.
IGuard	recontextualizeGuard(IGuard value) Brings an edu.uci.isr.xarch.options.IGuard object created in another context into this context.
IVariant	recontextualizeVariant(IVariant value) Brings an IVariant object created in another context into this context.
IVariantComponentType	recontextualizeVariantComponentType(IVariantComponentType value) Brings an IVariantComponentType object created in another context into this context.
IVariantConnectorType	recontextualizeVariantConnectorType(IVariantConnectorType value) Brings an IVariantConnectorType 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

VariantsContext

public VariantsContext(IXArch xArch)

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

createVariant

public IVariant createVariant()

Create an IVariant object in this namespace.

Specified by:

createVariant in interface IVariantsContext

Returns:

New IVariant object.

recontextualizeVariant

public IVariant recontextualizeVariant(IVariant value)

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

Specified by:

recontextualizeVariant in interface IVariantsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createGuard

public IGuard createGuard()

Create an edu.uci.isr.xarch.options.IGuard object in this namespace.

Specified by:

createGuard in interface IVariantsContext

Returns:

New edu.uci.isr.xarch.options.IGuard object.

recontextualizeGuard

public IGuard recontextualizeGuard(IGuard value)

Brings an edu.uci.isr.xarch.options.IGuard object created in another context into this context.

Specified by:

recontextualizeGuard in interface IVariantsContext

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 IVariantsContext

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 IVariantsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createVariantComponentType

public IVariantComponentType createVariantComponentType()

Create an IVariantComponentType object in this namespace.

Specified by:

createVariantComponentType in interface IVariantsContext

Returns:

New IVariantComponentType object.

recontextualizeVariantComponentType

public IVariantComponentType recontextualizeVariantComponentType(IVariantComponentType value)

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

Specified by:

recontextualizeVariantComponentType in interface IVariantsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantComponentType

public IVariantComponentType promoteToVariantComponentType(IComponentType value)

Promote an object of type edu.uci.isr.xarch.types.IComponentType to one of type IVariantComponentType. 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.types.IComponentType 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:

promoteToVariantComponentType in interface IVariantsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createVariantConnectorType

public IVariantConnectorType createVariantConnectorType()

Create an IVariantConnectorType object in this namespace.

Specified by:

createVariantConnectorType in interface IVariantsContext

Returns:

New IVariantConnectorType object.

recontextualizeVariantConnectorType

public IVariantConnectorType recontextualizeVariantConnectorType(IVariantConnectorType value)

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

Specified by:

recontextualizeVariantConnectorType in interface IVariantsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantConnectorType

public IVariantConnectorType promoteToVariantConnectorType(IConnectorType value)

Promote an object of type edu.uci.isr.xarch.types.IConnectorType to one of type IVariantConnectorType. 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.types.IConnectorType 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:

promoteToVariantConnectorType in interface IVariantsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.