edu.uci.isr.xarch.options
Class OptionsContext

java.lang.Object
  edu.uci.isr.xarch.options.OptionsContext

All Implemented Interfaces:

IOptionsContext, IXArchContext

public class OptionsContext

extends Object

implements IOptionsContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

protected Element	createElement(String name)
IGuard	createGuard() Create an IGuard object in this namespace.
IOptional	createOptional() Create an IOptional object in this namespace.
IOptionalComponent	createOptionalComponent() Create an IOptionalComponent object in this namespace.
IOptionalConnector	createOptionalConnector() Create an IOptionalConnector object in this namespace.
IOptionalInterface	createOptionalInterface() Create an IOptionalInterface object in this namespace.
IOptionalLink	createOptionalLink() Create an IOptionalLink object in this namespace.
IOptionalSignature	createOptionalSignature() Create an IOptionalSignature object in this namespace.
IOptionalSignatureInterfaceMapping	createOptionalSignatureInterfaceMapping() Create an IOptionalSignatureInterfaceMapping 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.
IOptionalComponent	promoteToOptionalComponent(IComponent value) Promote an object of type edu.uci.isr.xarch.types.IComponent to one of type IOptionalComponent.
IOptionalConnector	promoteToOptionalConnector(IConnector value) Promote an object of type edu.uci.isr.xarch.types.IConnector to one of type IOptionalConnector.
IOptionalInterface	promoteToOptionalInterface(IInterface value) Promote an object of type edu.uci.isr.xarch.types.IInterface to one of type IOptionalInterface.
IOptionalLink	promoteToOptionalLink(ILink value) Promote an object of type edu.uci.isr.xarch.types.ILink to one of type IOptionalLink.
IOptionalSignature	promoteToOptionalSignature(ISignature value) Promote an object of type edu.uci.isr.xarch.types.ISignature to one of type IOptionalSignature.
IOptionalSignatureInterfaceMapping	promoteToOptionalSignatureInterfaceMapping(ISignatureInterfaceMapping value) Promote an object of type edu.uci.isr.xarch.types.ISignatureInterfaceMapping to one of type IOptionalSignatureInterfaceMapping.
IGuard	recontextualizeGuard(IGuard value) Brings an IGuard object created in another context into this context.
IOptional	recontextualizeOptional(IOptional value) Brings an IOptional object created in another context into this context.
IOptionalComponent	recontextualizeOptionalComponent(IOptionalComponent value) Brings an IOptionalComponent object created in another context into this context.
IOptionalConnector	recontextualizeOptionalConnector(IOptionalConnector value) Brings an IOptionalConnector object created in another context into this context.
IOptionalInterface	recontextualizeOptionalInterface(IOptionalInterface value) Brings an IOptionalInterface object created in another context into this context.
IOptionalLink	recontextualizeOptionalLink(IOptionalLink value) Brings an IOptionalLink object created in another context into this context.
IOptionalSignature	recontextualizeOptionalSignature(IOptionalSignature value) Brings an IOptionalSignature object created in another context into this context.
IOptionalSignatureInterfaceMapping	recontextualizeOptionalSignatureInterfaceMapping(IOptionalSignatureInterfaceMapping value) Brings an IOptionalSignatureInterfaceMapping 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

OptionsContext

public OptionsContext(IXArch xArch)

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

createGuard

public IGuard createGuard()

Create an IGuard object in this namespace.

Specified by:

createGuard in interface IOptionsContext

Returns:

New IGuard object.

recontextualizeGuard

public IGuard recontextualizeGuard(IGuard value)

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

Specified by:

recontextualizeGuard in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createOptional

public IOptional createOptional()

Create an IOptional object in this namespace.

Specified by:

createOptional in interface IOptionsContext

Returns:

New IOptional object.

recontextualizeOptional

public IOptional recontextualizeOptional(IOptional value)

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

Specified by:

recontextualizeOptional in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createOptionalComponent

public IOptionalComponent createOptionalComponent()

Create an IOptionalComponent object in this namespace.

Specified by:

createOptionalComponent in interface IOptionsContext

Returns:

New IOptionalComponent object.

recontextualizeOptionalComponent

public IOptionalComponent recontextualizeOptionalComponent(IOptionalComponent value)

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

Specified by:

recontextualizeOptionalComponent in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalComponent

public IOptionalComponent promoteToOptionalComponent(IComponent value)

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

promoteToOptionalComponent in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalConnector

public IOptionalConnector createOptionalConnector()

Create an IOptionalConnector object in this namespace.

Specified by:

createOptionalConnector in interface IOptionsContext

Returns:

New IOptionalConnector object.

recontextualizeOptionalConnector

public IOptionalConnector recontextualizeOptionalConnector(IOptionalConnector value)

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

Specified by:

recontextualizeOptionalConnector in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalConnector

public IOptionalConnector promoteToOptionalConnector(IConnector value)

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

promoteToOptionalConnector in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalLink

public IOptionalLink createOptionalLink()

Create an IOptionalLink object in this namespace.

Specified by:

createOptionalLink in interface IOptionsContext

Returns:

New IOptionalLink object.

recontextualizeOptionalLink

public IOptionalLink recontextualizeOptionalLink(IOptionalLink value)

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

Specified by:

recontextualizeOptionalLink in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalLink

public IOptionalLink promoteToOptionalLink(ILink value)

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

promoteToOptionalLink in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalInterface

public IOptionalInterface createOptionalInterface()

Create an IOptionalInterface object in this namespace.

Specified by:

createOptionalInterface in interface IOptionsContext

Returns:

New IOptionalInterface object.

recontextualizeOptionalInterface

public IOptionalInterface recontextualizeOptionalInterface(IOptionalInterface value)

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

Specified by:

recontextualizeOptionalInterface in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalInterface

public IOptionalInterface promoteToOptionalInterface(IInterface value)

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

promoteToOptionalInterface in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalSignature

public IOptionalSignature createOptionalSignature()

Create an IOptionalSignature object in this namespace.

Specified by:

createOptionalSignature in interface IOptionsContext

Returns:

New IOptionalSignature object.

recontextualizeOptionalSignature

public IOptionalSignature recontextualizeOptionalSignature(IOptionalSignature value)

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

Specified by:

recontextualizeOptionalSignature in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalSignature

public IOptionalSignature promoteToOptionalSignature(ISignature value)

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

promoteToOptionalSignature in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalSignatureInterfaceMapping

public IOptionalSignatureInterfaceMapping createOptionalSignatureInterfaceMapping()

Create an IOptionalSignatureInterfaceMapping object in this namespace.

Specified by:

createOptionalSignatureInterfaceMapping in interface IOptionsContext

Returns:

New IOptionalSignatureInterfaceMapping object.

recontextualizeOptionalSignatureInterfaceMapping

public IOptionalSignatureInterfaceMapping recontextualizeOptionalSignatureInterfaceMapping(IOptionalSignatureInterfaceMapping value)

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

Specified by:

recontextualizeOptionalSignatureInterfaceMapping in interface IOptionsContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalSignatureInterfaceMapping

public IOptionalSignatureInterfaceMapping promoteToOptionalSignatureInterfaceMapping(ISignatureInterfaceMapping value)

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

promoteToOptionalSignatureInterfaceMapping in interface IOptionsContext

Parameters:

value - Object to promote.

Returns:

Promoted object.