edu.uci.isr.xarch.variants
Interface IVariantsContext

All Superinterfaces:

IXArchContext

All Known Implementing Classes:

VariantsContext

public interface IVariantsContext

extends IXArchContext

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

Author:

Automatically Generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Method Summary

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.
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 interface edu.uci.isr.xarch.IXArchContext

getTypeMetadata, getXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

createVariant

public IVariant createVariant()

Create an IVariant object in this namespace.

Returns:

New IVariant object.

recontextualizeVariant

public IVariant recontextualizeVariant(IVariant value)

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

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.

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.

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.

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.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createVariantComponentType

public IVariantComponentType createVariantComponentType()

Create an IVariantComponentType object in this namespace.

Returns:

New IVariantComponentType object.

recontextualizeVariantComponentType

public IVariantComponentType recontextualizeVariantComponentType(IVariantComponentType value)

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

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.

Parameters:

value - Object to promote.

Returns:

Promoted object.

createVariantConnectorType

public IVariantConnectorType createVariantConnectorType()

Create an IVariantConnectorType object in this namespace.

Returns:

New IVariantConnectorType object.

recontextualizeVariantConnectorType

public IVariantConnectorType recontextualizeVariantConnectorType(IVariantConnectorType value)

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

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.

Parameters:

value - Object to promote.

Returns:

Promoted object.