Package de.mid.innovator.m2msdk.model.log

Class MappingElementRepresentant

java.lang.Object

de.mid.innovator.m2msdk.model.log.MappingElementRepresentant

All Implemented Interfaces:

MappingElementIF, Serializable, Comparable<MappingElementRepresentant>

public class MappingElementRepresentant
extends Object
implements MappingElementIF, Comparable<MappingElementRepresentant>

Client side proxy of a mapping element. This class gets all the needed data serialized from a mapping element to show it to the user as a part of the log model.

Version:

11.4.1

Author:

jmback

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MappingElementRepresentant(MetaBulkInfo bulkInfo)

Method Summary

Modifier and Type	Method	Description
MappingElementIF	cloneIndexed(int virtualIndex)	Creates from the original Element an cloned indexed element
int	compareTo(MappingElementRepresentant o)
static List<MappingElementRepresentant>	create(MappingElementList iList)
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.
int	hashCode()
OperationResult	setElementProperty(PropertyDescriptorIF descriptor, PropertyValue value)	Set the property.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

MappingElementRepresentant

public MappingElementRepresentant(MetaBulkInfo bulkInfo)

Method Details

create

public static List<MappingElementRepresentant> create(MappingElementList iList)

createElement

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

Description copied from interface: MappingElementIF

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

Specified by:

createElement in interface MappingElementIF

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

equals

public boolean equals(MappingElementIF obj)

Description copied from interface: MappingElementIF

Compare two mapping elements (by hash).

Specified by:

equals in interface MappingElementIF

Parameters:

obj - other mapping element

Returns:

true, if same hash code.

getChildren

public MappingElementList getChildren()

Description copied from interface: MappingElementIF

Get the children of the element.

Specified by:

getChildren in interface MappingElementIF

Returns:

the children elements

getDisplayType

public String getDisplayType()

Description copied from interface: MappingElementIF

Get the display name of element's type.

Specified by:

getDisplayType in interface MappingElementIF

Returns:

the display name of elements type

getElementProperty

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

Description copied from interface: MappingElementIF

Get the property value for a property descriptor.

Specified by:

getElementProperty in interface MappingElementIF

Parameters:

expressionContext - TODO

descriptor -

Returns:

the elements property described by the PropertyDescriptor

Throws:

M2MException

RemoteException

getHash

public Long getHash()

Description copied from interface: MappingElementIF

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

Specified by:

getHash in interface MappingElementIF

Returns:

the elements hash value unique within one model.

getIcon

public String getIcon()

Description copied from interface: MappingElementIF

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.

Specified by:

getIcon in interface MappingElementIF

Returns:

the name of the elements icon, if exists

getModel

public MappingModel getModel()
                      throws M2MException,
RemoteException

Description copied from interface: MappingElementIF

Get the model of the element.

Specified by:

getModel in interface MappingElementIF

Returns:

the elements model

Throws:

M2MException

RemoteException

getMetaModel

public MetaModel getMetaModel()
                       throws M2MException,
RemoteException

Specified by:

getMetaModel in interface MappingElementIF

Throws:

M2MException

RemoteException

getName

public String getName()

Description copied from interface: MappingElementIF

Get the name.

Specified by:

getName in interface MappingElementIF

Returns:

the elements name

getObject

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

Description copied from interface: MappingElementIF

Return the element associated.

Specified by:

getObject in interface MappingElementIF

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:

M2MException

RemoteException

getObjects

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

Description copied from interface: MappingElementIF

Return the element associated.

Specified by:

getObjects in interface MappingElementIF

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

getOwner

public MappingElementIF getOwner()

Description copied from interface: MappingElementIF

Get the owner of the element.

Specified by:

getOwner in interface MappingElementIF

Returns:

the owning element

getOwnerTransitive

public MappingElementList getOwnerTransitive(MappingElementIF sentinel)

Description copied from interface: MappingElementIF

Get transitive owner up to a sentinel.

Specified by:

getOwnerTransitive in interface MappingElementIF

Parameters:

sentinel - maybe null

Returns:

gets owner transitive

getPath

public String getPath()

Description copied from interface: MappingElementIF

Get the path of the element inside the model.

Specified by:

getPath in interface MappingElementIF

Returns:

the elements path

getProperty

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

Description copied from interface: MappingElementIF

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

Specified by:

getProperty in interface MappingElementIF

Parameters:

expressionContext - TODO

descriptor - property name

Returns:

primitive, if found

Throws:

M2MException

RemoteException

getProperty

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

Description copied from interface: MappingElementIF

Return the property.

Specified by:

getProperty in interface MappingElementIF

Parameters:

expressionContext - TODO

descriptor - property name

subDescriptors - optional list of subdescriptors

Returns:

primitive, if found

Throws:

M2MException

RemoteException

getTargets

public MappingElementList getTargets()

Description copied from interface: MappingElementIF

Get the targets of the element.

Specified by:

getTargets in interface MappingElementIF

Returns:

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

getType

public String getType()

Description copied from interface: MappingElementIF

Get the name of element's type.

Specified by:

getType in interface MappingElementIF

Returns:

the name of elements type

getURI

public URI getURI()

Description copied from interface: MappingElementIF

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

Specified by:

getURI in interface MappingElementIF

Returns:

URI of the element

setElementProperty

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

Description copied from interface: MappingElementIF

Set the property.

Specified by:

setElementProperty in interface MappingElementIF

Parameters:

descriptor - property name

value -

Returns:

false on error

Throws:

M2MException

RemoteException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

delete

public void delete()
            throws M2MException,
RemoteException

Description copied from interface: MappingElementIF

Delete the mapping element.

Specified by:

delete in interface MappingElementIF

Throws:

M2MException

RemoteException

cloneIndexed

public MappingElementIF cloneIndexed(int virtualIndex)

Description copied from interface: MappingElementIF

Creates from the original Element an cloned indexed element

Specified by:

cloneIndexed in interface MappingElementIF

Parameters:

virtualIndex -

Returns:

a copy of the mapping element with an index

getBulkInfo

public List<MetaBulkInfo> getBulkInfo(MappingElementList list)

Specified by:

getBulkInfo in interface MappingElementIF

getBulkInfoSpecialist

public List<MetaBulkInfo> getBulkInfoSpecialist(MappingElementList list)

Specified by:

getBulkInfoSpecialist in interface MappingElementIF

compareTo

public int compareTo(MappingElementRepresentant o)

Specified by:

compareTo in interface Comparable<MappingElementRepresentant>