Package de.mid.innovator.m2msdk.model.transformation.interfaces

Interface MappingElementIF

All Superinterfaces:

Serializable

All Known Implementing Classes:

MappingElementBaseImpl, MappingElementDummy, MappingElementInnovator, MappingElementInnovatorDTD, MappingElementJavaBeans, MappingElementRepresentant, MappingElementText, MappingElementVirtualIndexed

public interface MappingElementIF
extends Serializable

Mapping element is a model element which takes part in the mapping either in source or on target model.

Version:

10.1.1

Author:

jmback

Method Summary

Modifier and Type	Method	Description
MappingElementIF	cloneIndexed(int virtualIndex)	Creates from the original Element an cloned indexed element
MappingElementIF	createElement(ModelTransformationStepIF step, CreateDescriptorIF createDescriptor, MappingAnchor anchor)	Create a new element in the same model as this element.
void	delete()	Delete the mapping element.
boolean	equals(MappingElementIF obj)	Compare two mapping elements (by hash).
List<MetaBulkInfo>	getBulkInfo(MappingElementList list)
List<MetaBulkInfo>	getBulkInfoSpecialist(MappingElementList list)
MappingElementList	getChildren()	Get the children of the element.
String	getDisplayType()	Get the display name of element's type.
PropertyValue	getElementProperty(ExpressionContext expressionContext, PropertyDescriptorIF descriptor)	Get the property value for a property descriptor.
Long	getHash()	Get the hash value of the element inside the mapping model.
String	getIcon()	Get the icon of the element.
MetaModel	getMetaModel()
MappingModel	getModel()	Get the model of the element.
String	getName()	Get the name.
MappingElementIF	getObject(ExpressionContext expressionContext, String descriptor, PropertyDescriptorList subDescriptors)	Return the element associated.
MappingElementList	getObjects(ExpressionContext expressionContext, String descriptor, PropertyDescriptorList subDescriptors)	Return the element associated.
MappingElementIF	getOwner()	Get the owner of the element.
MappingElementList	getOwnerTransitive(MappingElementIF sentinel)	Get transitive owner up to a sentinel.
String	getPath()	Get the path of the element inside the model.
PropertyValue	getProperty(ExpressionContext expressionContext, String descriptor)	Return the property's value.
PropertyValue	getProperty(ExpressionContext expressionContext, String descriptor, PropertyDescriptorList subDescriptors)	Return the property.
MappingElementList	getTargets()	Get the targets of the element.
String	getType()	Get the name of element's type.
URI	getURI()	Get the URI.
OperationResult	setElementProperty(PropertyDescriptorIF descriptor, PropertyValue value)	Set the property.

Method Details

getHash

Long getHash()

Get the hash value of the element inside the mapping model. Equal elements have same hash. Different elements have different hash.

Returns:

the elements hash value unique within one model.

equals

boolean equals(MappingElementIF obj)

Compare two mapping elements (by hash).

Parameters:

obj - other mapping element

Returns:

true, if same hash code.

getName

String getName()

Get the name.

Returns:

the elements name

getType

String getType()

Get the name of element's type.

Returns:

the name of elements type

getDisplayType

String getDisplayType()
               throws RemoteException

Get the display name of element's type.

Returns:

the display name of elements type

Throws:

RemoteException

getPath

String getPath()

Get the path of the element inside the model.

Returns:

the elements path

getIcon

String getIcon()

Get the icon of the element. Either provide the fully qualified file name or the name in the classpath or the file name for Innovator bitmaps.

Returns:

the name of the elements icon, if exists

getURI

URI getURI()

Get the URI. The URI can be used to retrieve an element from the mapping meta model.

Returns:

URI of the element

getOwner

MappingElementIF getOwner()

Get the owner of the element.

Returns:

the owning element

getOwnerTransitive

MappingElementList getOwnerTransitive(MappingElementIF sentinel)

Get transitive owner up to a sentinel.

Parameters:

sentinel - maybe null

Returns:

gets owner transitive

getChildren

MappingElementList getChildren()

Get the children of the element.

Returns:

the children elements

getTargets

MappingElementList getTargets()

Get the targets of the element.

Returns:

the target elements ( e.g. dependency or relationship target ) otherwise returns nothing

getObject

MappingElementIF getObject(ExpressionContext expressionContext,
 String descriptor,
 PropertyDescriptorList subDescriptors)
                    throws M2MException,
RemoteException

Return the element associated.

Parameters:

expressionContext - the context in which the navigatable object should be calculated.

descriptor - navigation directive

subDescriptors - sub descriptors or parameters of the navigation directive

Returns:

Element, if found

Throws:

SevereException - an error has occured during access of Innovator

M2MException

RemoteException

getObjects

MappingElementList getObjects(ExpressionContext expressionContext,
 String descriptor,
 PropertyDescriptorList subDescriptors)
                       throws M2MException,
RemoteException

Return the element associated.

Parameters:

expressionContext - the context in which the related objects should be calculated.

descriptor - navigation directive

subDescriptors - sub descriptors or parameters of the navigation directive

Returns:

List of Elements

Throws:

M2MException

RemoteException

getProperty

PropertyValue getProperty(ExpressionContext expressionContext,
 String descriptor)
                   throws M2MException,
RemoteException

Return the property's value. Remark: This is the property of type "Property".

Parameters:

expressionContext - TODO

descriptor - property name

Returns:

primitive, if found

Throws:

SevereException - an error has occurred during access

M2MException

RemoteException

getProperty

PropertyValue getProperty(ExpressionContext expressionContext,
 String descriptor,
 PropertyDescriptorList subDescriptors)
                   throws M2MException,
RemoteException

Return the property.

Parameters:

expressionContext - TODO

descriptor - property name

subDescriptors - optional list of subdescriptors

Returns:

primitive, if found

Throws:

SevereException - an error has occurred during access

M2MException

RemoteException

getElementProperty

PropertyValue getElementProperty(ExpressionContext expressionContext,
 PropertyDescriptorIF descriptor)
                          throws M2MException,
RemoteException

Get the property value for a property descriptor.

Parameters:

expressionContext - TODO

descriptor -

Returns:

the elements property described by the PropertyDescriptor

Throws:

SevereException - non critical error

AbortException - critical error

M2MException

RemoteException

setElementProperty

OperationResult setElementProperty(PropertyDescriptorIF descriptor,
 PropertyValue value)
                            throws M2MException,
RemoteException

Set the property.

Parameters:

descriptor - property name

value -

Returns:

false on error

Throws:

M2MException

RemoteException

getModel

MappingModel getModel()
               throws M2MException,
RemoteException

Get the model of the element.

Returns:

the elements model

Throws:

AbortException

M2MException

RemoteException

getMetaModel

MetaModel getMetaModel()
                throws M2MException,
RemoteException

Throws:

M2MException

RemoteException

createElement

MappingElementIF createElement(ModelTransformationStepIF step,
 CreateDescriptorIF createDescriptor,
 MappingAnchor anchor)
                        throws M2MException,
RemoteException

Create a new element in the same model as this element.

Parameters:

createDescriptor - description what to create

anchor - additional anchor elements for the new element

Returns:

a newly created element with the current element as owner spawned through the additional target elements

Throws:

M2MException

RemoteException

delete

void delete()
     throws M2MException,
RemoteException

Delete the mapping element.

Throws:

M2MException

RemoteException

cloneIndexed

MappingElementIF cloneIndexed(int virtualIndex)

Creates from the original Element an cloned indexed element

Parameters:

virtualIndex -

Returns:

a copy of the mapping element with an index

getBulkInfo

List<MetaBulkInfo> getBulkInfo(MappingElementList list)
                        throws RemoteException

Throws:

RemoteException

getBulkInfoSpecialist

List<MetaBulkInfo> getBulkInfoSpecialist(MappingElementList list)
                                  throws RemoteException

Throws:

RemoteException