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

Interface PropertyDescriptorIF

All Superinterfaces:

Serializable

All Known Subinterfaces:

PropertyDescriptorMultiDataIF

All Known Implementing Classes:

PropertyAnchor, PropertyCollect, PropertyCompare, PropertyComposite, PropertyContains, PropertyContext, PropertyDescriptorImpl, PropertyEquals, PropertyError, PropertyExists, PropertyFile, PropertyFilterName, PropertyFilterType, PropertyFix, PropertyFunction, PropertyFunctionDefinition, PropertyFunctionParameter, PropertyGeneric, PropertyHash, PropertyInformationPurpose, PropertyInnovatorElementProxyState, PropertyInnovatorEnumLiteralProperty, PropertyInnovatorFlowText, PropertyInnovatorIsStereotypePropertyDefault, PropertyInnovatorLabel, PropertyInnovatorObject, PropertyInnovatorObjects, PropertyInnovatorPath, PropertyInnovatorPathDepth, PropertyInnovatorProperty, PropertyInnovatorStereotype, PropertyInnovatorStereotypeProperty, PropertyInnovatorStringElementReplace, PropertyInnovatorText, PropertyIsElementMapped, PropertyIsElementPropertyChanged, PropertyIsTargetElementMapped, PropertyJavaBeansObject, PropertyJavaBeansObjects, PropertyJavaBeansProperty, PropertyJavaBeansPropertyMeta, PropertyJavaFunction, PropertyLeft, PropertyListAggregate, PropertyListBase, PropertyListContains, PropertyListFirstNonEmpty, PropertyListIndexOf, PropertyListIntersect, PropertyListIsEmpty, PropertyListNotEmpty, PropertyListOf, PropertyListOrderBy, PropertyListRange, PropertyListReverse, PropertyListSize, PropertyListSubtract, PropertyListUnion, PropertyLogicAnd, PropertyLogicBase, PropertyLogicNot, PropertyLogicNotAnd, PropertyLogicNotOr, PropertyLogicOr, PropertyLogicValue, PropertyLogicXOr, PropertyMappedElement, PropertyNull, PropertyNumberAvg, PropertyNumberBase, PropertyNumberDiff, PropertyNumberDiv, PropertyNumberMax, PropertyNumberMin, PropertyNumberMod, PropertyNumberMul, PropertyNumberSum, PropertyObject, PropertyObjects, PropertyOneOf, PropertyOption, PropertyOptionEvaluation, PropertyOptionStringMap, PropertyOriginalElement, PropertyPair, PropertyProperty, PropertyReject, PropertyRelationModel, PropertyRight, PropertySelect, PropertyStereotypeProperty, PropertyStore, PropertyStringBase, PropertyStringConcat, PropertyStringContains, PropertyStringFirstNonEmpty, PropertyStringFormat, PropertyStringIndexOf, PropertyStringIsEmpty, PropertyStringLength, PropertyStringLower, PropertyStringMap, PropertyStringMatches, PropertyStringMessage, PropertyStringRegexp, PropertyStringRepeat, PropertyStringReplace, PropertyStringReverse, PropertyStringStore, PropertyStringSubstring, PropertyStringTrim, PropertyStringUpper, PropertySwitch, PropertySwitchBoolean, PropertyTerms

public interface PropertyDescriptorIF
extends Serializable

Property Descriptor Interface used for reading and setting of various elements properties ( name, label, text etc. )

Version:

10.1.1

Author:

nagl

Method Summary

Modifier and Type	Method	Description
void	addSubDescriptor(PropertyDescriptorIF iSub)	Add a subordinated property descriptor to this property descriptor.
void	addSubDescriptor(PropertyDescriptorList iSub)	Add a subordinated property descriptor to this property descriptor.
MappingElementList	filter(MappingElementList filterElements, PropertyValue value, ExpressionContext inputList)	Mass Filters Elements by PropertyValue.
String	getDescription()	Get a long NLS description of the effect and the behavior of the property descriptor.
ParameterProposalList	getKnownNames(MappingElementIF iElement)	Get list of known property names.
MetaModel	getMetaModel()	Get meta model where the property descriptor is used in.
PropertyTypeIF	getPropertyType()	Get property type.
ResultAndParameterType	getResult()	Get the result type of this property descriptor.
PropertyDescriptorList	getSubDescriptors()	Get all sub descriptors.
PropertyValue	getValue(MappingElementIF element)
PropertyValue	getValue(MappingElementIF element, ExpressionContext ec)	Read value from item.
String	getValueAsString(MappingElementIF element, ExpressionContext el)	Read value as String from item
PropertyValue	getValues(MappingElementList elements)	Read values from items.
boolean	isLogged()	Is it necessary that modifications done with the descriptor are logged?
OperationResult	setValue(MappingElementIF el, PropertyValue iValue)	Set value for item.

Method Details

getValue

PropertyValue getValue(MappingElementIF element,
 ExpressionContext ec)
                throws M2MException,
RemoteException

Read value from item.

Parameters:

element - TODO

ec - context containing the model element and the source and the target and the anchors

Returns:

items value

Throws:

SevereException - non critical error

AbortException - critical error

RemoteException

M2MException

RemoteException

getValue

PropertyValue getValue(MappingElementIF element)
                throws M2MException,
RemoteException

Throws:

M2MException

RemoteException

getValues

PropertyValue getValues(MappingElementList elements)
                 throws M2MException,
RemoteException

Read values from items.

Parameters:

elements - the elements from which the value should be read.

Returns:

a list of all values

Throws:

SevereException - non critical error

AbortException - critical error

RemoteException

M2MException

RemoteException

getValueAsString

String getValueAsString(MappingElementIF element,
 ExpressionContext el)
                 throws M2MException,
RemoteException

Read value as String from item

Parameters:

element - TODO

el - context containing the model element and the source and the target and the anchors

Returns:

items as string value

Throws:

M2MException

RemoteException

setValue

OperationResult setValue(MappingElementIF el,
 PropertyValue iValue)
                  throws M2MException,
RemoteException

Set value for item.

Parameters:

el - item where to set the property (maybe null, meaning to set the value of the descriptor itself)

iValue - to be set

Returns:

false result, if error; true result, if identically changed; else setted value

Throws:

M2MException - exception while setting

RemoteException

getMetaModel

MetaModel getMetaModel()
                throws M2MException

Get meta model where the property descriptor is used in.

Returns:

Meta model of property descriptor

Throws:

M2MException

getPropertyType

PropertyTypeIF getPropertyType()

Get property type.

Returns:

the type of the property

filter

MappingElementList filter(MappingElementList filterElements,
 PropertyValue value,
 ExpressionContext inputList)
                   throws M2MException,
RemoteException

Mass Filters Elements by PropertyValue. Filter the elements from the input list which have the given value as descriptor value.

Parameters:

filterElements - TODO

value - given value

inputList - list of model elements to check

Returns:

Elements having the given value.

Throws:

RemoteException

M2MException

getKnownNames

ParameterProposalList getKnownNames(MappingElementIF iElement)
                             throws M2MException,
RemoteException

Get list of known property names. Even with a known name, a property descriptor may fail for getting or setting a value!

Parameters:

iElement - Mapping element to be treated, maybe null.

Returns:

List of known property names.

Throws:

AbortException

RemoteException

M2MException

RemoteException

addSubDescriptor

void addSubDescriptor(PropertyDescriptorIF iSub)
               throws AbortException,
RemoteException

Add a subordinated property descriptor to this property descriptor.

Parameters:

iSub - Property descriptor which has to be evaluated for evaluating this descriptor

Throws:

AbortException - critical error

RemoteException

RemoteException

addSubDescriptor

void addSubDescriptor(PropertyDescriptorList iSub)
               throws M2MException,
RemoteException

Add a subordinated property descriptor to this property descriptor.

Parameters:

iSub - Property descriptor which has to be evaluated for evaluating this descriptor

Throws:

AbortException - critical error

M2MException

RemoteException

RemoteException

getResult

ResultAndParameterType getResult()

Get the result type of this property descriptor. The result type is determined by the property type.

Returns:

result type

getSubDescriptors

PropertyDescriptorList getSubDescriptors()

Get all sub descriptors.

Returns:

sub descriptors

getDescription

String getDescription()

Get a long NLS description of the effect and the behavior of the property descriptor.

Returns:

long NLS string with description for user

isLogged

boolean isLogged()

Is it necessary that modifications done with the descriptor are logged?

Returns:

true, if it is necessary.