edu.uci.isr.xarch.messages
Class MessagesContext

java.lang.Object
  edu.uci.isr.xarch.messages.MessagesContext

All Implemented Interfaces:

IMessagesContext, IXArchContext

public class MessagesContext

extends Object

implements IMessagesContext

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

TYPE_METADATA

Constructor Summary

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

Method Summary

ICauseTime	createCauseTime() Create an ICauseTime object in this namespace.
ICount	createCount() Create an ICount object in this namespace.
IDescription	createDescription() Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.
protected Element	createElement(String name)
IGenericMessage	createGenericMessage() Create an IGenericMessage object in this namespace.
IKind	createKind() Create an IKind object in this namespace.
IMessageCausalitySpecification	createMessageCausalitySpecification() Create an IMessageCausalitySpecification object in this namespace.
IMessageName	createMessageName() Create an IMessageName object in this namespace.
IMessageType	createMessageType() Create an IMessageType object in this namespace.
INamedProperty	createNamedProperty() Create an INamedProperty object in this namespace.
INamedPropertyMessage	createNamedPropertyMessage() Create an INamedPropertyMessage object in this namespace.
IProductionRule	createProductionRule() Create an IProductionRule object in this namespace.
IPropertyName	createPropertyName() Create an IPropertyName object in this namespace.
IPropertyValue	createPropertyValue() Create an IPropertyValue object in this namespace.
IRuleSpecification	createRuleSpecification() Create an IRuleSpecification object in this namespace.
IRuleSpecification	createRuleSpecificationElement() Create a top-level element of type IRuleSpecification.
IVariantComponentTypeImplVersSpec	createVariantComponentTypeImplVersSpec() Create an IVariantComponentTypeImplVersSpec object in this namespace.
IVariantConnectorTypeImplVersSpec	createVariantConnectorTypeImplVersSpec() Create an IVariantConnectorTypeImplVersSpec object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
Collection	getAllRuleSpecifications(IXArch xArch) Gets all the IRuleSpecification children from the given IXArch element.
IRuleSpecification	getRuleSpecification(IXArch xArch) Gets the IRuleSpecification 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.
INamedPropertyMessage	promoteToNamedPropertyMessage(IGenericMessage value) Promote an object of type IGenericMessage to one of type INamedPropertyMessage.
IVariantComponentTypeImplVersSpec	promoteToVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVers value) Promote an object of type edu.uci.isr.xarch.versions.IVariantComponentTypeImplVers to one of type IVariantComponentTypeImplVersSpec.
IVariantConnectorTypeImplVersSpec	promoteToVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVers value) Promote an object of type edu.uci.isr.xarch.versions.IVariantConnectorTypeImplVers to one of type IVariantConnectorTypeImplVersSpec.
ICauseTime	recontextualizeCauseTime(ICauseTime value) Brings an ICauseTime object created in another context into this context.
ICount	recontextualizeCount(ICount value) Brings an ICount 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.
IGenericMessage	recontextualizeGenericMessage(IGenericMessage value) Brings an IGenericMessage object created in another context into this context.
IKind	recontextualizeKind(IKind value) Brings an IKind object created in another context into this context.
IMessageCausalitySpecification	recontextualizeMessageCausalitySpecification(IMessageCausalitySpecification value) Brings an IMessageCausalitySpecification object created in another context into this context.
IMessageName	recontextualizeMessageName(IMessageName value) Brings an IMessageName object created in another context into this context.
IMessageType	recontextualizeMessageType(IMessageType value) Brings an IMessageType object created in another context into this context.
INamedProperty	recontextualizeNamedProperty(INamedProperty value) Brings an INamedProperty object created in another context into this context.
INamedPropertyMessage	recontextualizeNamedPropertyMessage(INamedPropertyMessage value) Brings an INamedPropertyMessage object created in another context into this context.
IProductionRule	recontextualizeProductionRule(IProductionRule value) Brings an IProductionRule object created in another context into this context.
IPropertyName	recontextualizePropertyName(IPropertyName value) Brings an IPropertyName object created in another context into this context.
IPropertyValue	recontextualizePropertyValue(IPropertyValue value) Brings an IPropertyValue object created in another context into this context.
IRuleSpecification	recontextualizeRuleSpecification(IRuleSpecification value) Brings an IRuleSpecification object created in another context into this context.
IVariantComponentTypeImplVersSpec	recontextualizeVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVersSpec value) Brings an IVariantComponentTypeImplVersSpec object created in another context into this context.
IVariantConnectorTypeImplVersSpec	recontextualizeVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVersSpec value) Brings an IVariantConnectorTypeImplVersSpec 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

MessagesContext

public MessagesContext(IXArch xArch)

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

createKind

public IKind createKind()

Create an IKind object in this namespace.

Specified by:

createKind in interface IMessagesContext

Returns:

New IKind object.

recontextualizeKind

public IKind recontextualizeKind(IKind value)

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

Specified by:

recontextualizeKind in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRuleSpecification

public IRuleSpecification createRuleSpecification()

Create an IRuleSpecification object in this namespace.

Specified by:

createRuleSpecification in interface IMessagesContext

Returns:

New IRuleSpecification object.

recontextualizeRuleSpecification

public IRuleSpecification recontextualizeRuleSpecification(IRuleSpecification value)

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

Specified by:

recontextualizeRuleSpecification in interface IMessagesContext

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 IMessagesContext

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 IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createProductionRule

public IProductionRule createProductionRule()

Create an IProductionRule object in this namespace.

Specified by:

createProductionRule in interface IMessagesContext

Returns:

New IProductionRule object.

recontextualizeProductionRule

public IProductionRule recontextualizeProductionRule(IProductionRule value)

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

Specified by:

recontextualizeProductionRule in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec createVariantComponentTypeImplVersSpec()

Create an IVariantComponentTypeImplVersSpec object in this namespace.

Specified by:

createVariantComponentTypeImplVersSpec in interface IMessagesContext

Returns:

New IVariantComponentTypeImplVersSpec object.

recontextualizeVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec recontextualizeVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVersSpec value)

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

Specified by:

recontextualizeVariantComponentTypeImplVersSpec in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec promoteToVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVers value)

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

promoteToVariantComponentTypeImplVersSpec in interface IMessagesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec createVariantConnectorTypeImplVersSpec()

Create an IVariantConnectorTypeImplVersSpec object in this namespace.

Specified by:

createVariantConnectorTypeImplVersSpec in interface IMessagesContext

Returns:

New IVariantConnectorTypeImplVersSpec object.

recontextualizeVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec recontextualizeVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVersSpec value)

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

Specified by:

recontextualizeVariantConnectorTypeImplVersSpec in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec promoteToVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVers value)

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

promoteToVariantConnectorTypeImplVersSpec in interface IMessagesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createMessageCausalitySpecification

public IMessageCausalitySpecification createMessageCausalitySpecification()

Create an IMessageCausalitySpecification object in this namespace.

Specified by:

createMessageCausalitySpecification in interface IMessagesContext

Returns:

New IMessageCausalitySpecification object.

recontextualizeMessageCausalitySpecification

public IMessageCausalitySpecification recontextualizeMessageCausalitySpecification(IMessageCausalitySpecification value)

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

Specified by:

recontextualizeMessageCausalitySpecification in interface IMessagesContext

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 IMessagesContext

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 IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createGenericMessage

public IGenericMessage createGenericMessage()

Create an IGenericMessage object in this namespace.

Specified by:

createGenericMessage in interface IMessagesContext

Returns:

New IGenericMessage object.

recontextualizeGenericMessage

public IGenericMessage recontextualizeGenericMessage(IGenericMessage value)

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

Specified by:

recontextualizeGenericMessage in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createNamedPropertyMessage

public INamedPropertyMessage createNamedPropertyMessage()

Create an INamedPropertyMessage object in this namespace.

Specified by:

createNamedPropertyMessage in interface IMessagesContext

Returns:

New INamedPropertyMessage object.

recontextualizeNamedPropertyMessage

public INamedPropertyMessage recontextualizeNamedPropertyMessage(INamedPropertyMessage value)

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

Specified by:

recontextualizeNamedPropertyMessage in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToNamedPropertyMessage

public INamedPropertyMessage promoteToNamedPropertyMessage(IGenericMessage value)

Promote an object of type IGenericMessage to one of type INamedPropertyMessage. 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 IGenericMessage 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:

promoteToNamedPropertyMessage in interface IMessagesContext

Parameters:

value - Object to promote.

Returns:

Promoted object.

createCount

public ICount createCount()

Create an ICount object in this namespace.

Specified by:

createCount in interface IMessagesContext

Returns:

New ICount object.

recontextualizeCount

public ICount recontextualizeCount(ICount value)

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

Specified by:

recontextualizeCount in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createMessageName

public IMessageName createMessageName()

Create an IMessageName object in this namespace.

Specified by:

createMessageName in interface IMessagesContext

Returns:

New IMessageName object.

recontextualizeMessageName

public IMessageName recontextualizeMessageName(IMessageName value)

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

Specified by:

recontextualizeMessageName in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createMessageType

public IMessageType createMessageType()

Create an IMessageType object in this namespace.

Specified by:

createMessageType in interface IMessagesContext

Returns:

New IMessageType object.

recontextualizeMessageType

public IMessageType recontextualizeMessageType(IMessageType value)

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

Specified by:

recontextualizeMessageType in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createCauseTime

public ICauseTime createCauseTime()

Create an ICauseTime object in this namespace.

Specified by:

createCauseTime in interface IMessagesContext

Returns:

New ICauseTime object.

recontextualizeCauseTime

public ICauseTime recontextualizeCauseTime(ICauseTime value)

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

Specified by:

recontextualizeCauseTime in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createNamedProperty

public INamedProperty createNamedProperty()

Create an INamedProperty object in this namespace.

Specified by:

createNamedProperty in interface IMessagesContext

Returns:

New INamedProperty object.

recontextualizeNamedProperty

public INamedProperty recontextualizeNamedProperty(INamedProperty value)

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

Specified by:

recontextualizeNamedProperty in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPropertyName

public IPropertyName createPropertyName()

Create an IPropertyName object in this namespace.

Specified by:

createPropertyName in interface IMessagesContext

Returns:

New IPropertyName object.

recontextualizePropertyName

public IPropertyName recontextualizePropertyName(IPropertyName value)

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

Specified by:

recontextualizePropertyName in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPropertyValue

public IPropertyValue createPropertyValue()

Create an IPropertyValue object in this namespace.

Specified by:

createPropertyValue in interface IMessagesContext

Returns:

New IPropertyValue object.

recontextualizePropertyValue

public IPropertyValue recontextualizePropertyValue(IPropertyValue value)

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

Specified by:

recontextualizePropertyValue in interface IMessagesContext

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRuleSpecificationElement

public IRuleSpecification createRuleSpecificationElement()

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

Specified by:

createRuleSpecificationElement in interface IMessagesContext

Returns:

new IRuleSpecification suitable for adding as a child of xArch.

getRuleSpecification

public IRuleSpecification getRuleSpecification(IXArch xArch)

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

Specified by:

getRuleSpecification in interface IMessagesContext

Parameters:

xArch - IXArch object from which to get the child.

Returns:

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

getAllRuleSpecifications

public Collection getAllRuleSpecifications(IXArch xArch)

Gets all the IRuleSpecification children from the given IXArch element.

Specified by:

getAllRuleSpecifications in interface IMessagesContext

Parameters:

xArch - IXArch object from which to get the children.

Returns:

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