edu.uci.isr.xarch.menage
Class MenageContext

java.lang.Object
  edu.uci.isr.xarch.menage.MenageContext

All Implemented Interfaces:

IMenageContext, IXArchContext

public class MenageContext

extends Object

implements IMenageContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

protected Element	createElement(String name)
IOptionalComponentPosition	createOptionalComponentPosition() Create an IOptionalComponentPosition object in this namespace.
IOptionalConnectorPosition	createOptionalConnectorPosition() Create an IOptionalConnectorPosition object in this namespace.
IOptionalInterfacePosition	createOptionalInterfacePosition() Create an IOptionalInterfacePosition object in this namespace.
IOptionalSignaturePosition	createOptionalSignaturePosition() Create an IOptionalSignaturePosition object in this namespace.
IPosition	createPosition() Create an IPosition 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.
IOptionalComponentPosition	promoteToOptionalComponentPosition(IOptionalComponent value) Promote an object of type edu.uci.isr.xarch.options.IOptionalComponent to one of type IOptionalComponentPosition.
IOptionalConnectorPosition	promoteToOptionalConnectorPosition(IOptionalConnector value) Promote an object of type edu.uci.isr.xarch.options.IOptionalConnector to one of type IOptionalConnectorPosition.
IOptionalInterfacePosition	promoteToOptionalInterfacePosition(IOptionalInterface value) Promote an object of type edu.uci.isr.xarch.options.IOptionalInterface to one of type IOptionalInterfacePosition.
IOptionalSignaturePosition	promoteToOptionalSignaturePosition(IOptionalSignature value) Promote an object of type edu.uci.isr.xarch.options.IOptionalSignature to one of type IOptionalSignaturePosition.
IOptionalComponentPosition	recontextualizeOptionalComponentPosition(IOptionalComponentPosition value) Brings an IOptionalComponentPosition object created in another context into this context.
IOptionalConnectorPosition	recontextualizeOptionalConnectorPosition(IOptionalConnectorPosition value) Brings an IOptionalConnectorPosition object created in another context into this context.
IOptionalInterfacePosition	recontextualizeOptionalInterfacePosition(IOptionalInterfacePosition value) Brings an IOptionalInterfacePosition object created in another context into this context.
IOptionalSignaturePosition	recontextualizeOptionalSignaturePosition(IOptionalSignaturePosition value) Brings an IOptionalSignaturePosition object created in another context into this context.
IPosition	recontextualizePosition(IPosition value) Brings an IPosition 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

MenageContext

public MenageContext(IXArch xArch)

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

createPosition

public IPosition createPosition()

Create an IPosition object in this namespace.

Specified by:

createPosition in interface IMenageContext

Returns:

New IPosition object.

recontextualizePosition

public IPosition recontextualizePosition(IPosition value)

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

Specified by:

recontextualizePosition in interface IMenageContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createOptionalComponentPosition

public IOptionalComponentPosition createOptionalComponentPosition()

Create an IOptionalComponentPosition object in this namespace.

Specified by:

createOptionalComponentPosition in interface IMenageContext

Returns:

New IOptionalComponentPosition object.

recontextualizeOptionalComponentPosition

public IOptionalComponentPosition recontextualizeOptionalComponentPosition(IOptionalComponentPosition value)

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

Specified by:

recontextualizeOptionalComponentPosition in interface IMenageContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalComponentPosition

public IOptionalComponentPosition promoteToOptionalComponentPosition(IOptionalComponent value)

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

promoteToOptionalComponentPosition in interface IMenageContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalConnectorPosition

public IOptionalConnectorPosition createOptionalConnectorPosition()

Create an IOptionalConnectorPosition object in this namespace.

Specified by:

createOptionalConnectorPosition in interface IMenageContext

Returns:

New IOptionalConnectorPosition object.

recontextualizeOptionalConnectorPosition

public IOptionalConnectorPosition recontextualizeOptionalConnectorPosition(IOptionalConnectorPosition value)

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

Specified by:

recontextualizeOptionalConnectorPosition in interface IMenageContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalConnectorPosition

public IOptionalConnectorPosition promoteToOptionalConnectorPosition(IOptionalConnector value)

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

promoteToOptionalConnectorPosition in interface IMenageContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalInterfacePosition

public IOptionalInterfacePosition createOptionalInterfacePosition()

Create an IOptionalInterfacePosition object in this namespace.

Specified by:

createOptionalInterfacePosition in interface IMenageContext

Returns:

New IOptionalInterfacePosition object.

recontextualizeOptionalInterfacePosition

public IOptionalInterfacePosition recontextualizeOptionalInterfacePosition(IOptionalInterfacePosition value)

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

Specified by:

recontextualizeOptionalInterfacePosition in interface IMenageContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalInterfacePosition

public IOptionalInterfacePosition promoteToOptionalInterfacePosition(IOptionalInterface value)

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

promoteToOptionalInterfacePosition in interface IMenageContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createOptionalSignaturePosition

public IOptionalSignaturePosition createOptionalSignaturePosition()

Create an IOptionalSignaturePosition object in this namespace.

Specified by:

createOptionalSignaturePosition in interface IMenageContext

Returns:

New IOptionalSignaturePosition object.

recontextualizeOptionalSignaturePosition

public IOptionalSignaturePosition recontextualizeOptionalSignaturePosition(IOptionalSignaturePosition value)

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

Specified by:

recontextualizeOptionalSignaturePosition in interface IMenageContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToOptionalSignaturePosition

public IOptionalSignaturePosition promoteToOptionalSignaturePosition(IOptionalSignature value)

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

promoteToOptionalSignaturePosition in interface IMenageContext

Parameters:

value - Object to promote.

Returns:

Promoted object.