Property (MDT-OCL Documentation)

All Superinterfaces:

Element, org.eclipse.emf.ecore.EObject, Feature, Nameable, NamedElement, org.eclipse.emf.common.notify.Notifier, TypedElement, Visitable

All Known Implementing Classes:

AbstractExecutorProperty, EcoreExecutorProperty, ExecutorProperty, ExecutorPropertyWithImplementation, PropertyImpl, TuplePartImpl
```
public interface Property
extends Feature
```
A representation of the model object 'Property'. A Property is a StructuralFeature. A Property related by ownedAttribute to a Classifier (other than an association) represents an attribute and might also represent an association end. It relates an instance of the Classifier to a value or set of values of the type of the attribute. A Property related by memberEnd to an Association represents an end of the Association. The type of the Property is the type of the end of the Association. A Property has the capability of being a DeploymentTarget in a Deployment relationship. This enables modeling the deployment to hierarchical nodes that have Properties functioning as internal parts. Property specializes ParameterableElement to specify that a Property can be exposed as a formal template parameter, and provided as an actual parameter in a binding of a template.
The following features are supported:
See Also:

PivotPackage.getProperty()

Generated

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociationClass`	`getAssociationClass()` Returns the value of the 'Association Class' reference.
`java.lang.Object`	`getDefaultValue()` Returns the value of the 'Default Value' attribute.
`java.lang.String`	`getDefaultValueString()` Returns the value of the 'Default Value String' attribute.
`CompleteInheritance`	`getInheritance(StandardLibrary standardLibrary)` Return the Inheritance dispatch table for the owning type, or null for an orphan property owned by an Annotation.
`java.util.List<Property>`	`getKeys()` Returns the value of the 'Keys' reference list.
`Property`	`getOpposite()` Returns the value of the 'Opposite' reference.
`LanguageExpression`	`getOwnedExpression()` Returns the value of the 'Owned Expression' containment reference.
`Class`	`getOwningClass()` Returns the value of the 'Owning Class' container reference.
`PropertyId`	`getPropertyId()`
`java.util.List<Property>`	`getRedefinedProperties()` Returns the value of the 'Redefined Properties' reference list.
`Property`	`getReferredProperty()` Returns the value of the 'Referred Property' reference.
`java.util.List<Property>`	`getSubsettedProperty()` Returns the value of the 'Subsetted Property' reference list.
`void`	`initValue(java.lang.Object object, java.lang.Object ecoreValue)` Initialize the value of this property within objectValue to propertyValue.
`boolean`	`isAttribute(Property p)`
`boolean`	`isIsComposite()` Returns the value of the 'Is Composite' attribute.
`boolean`	`isIsDerived()` Returns the value of the 'Is Derived' attribute.
`boolean`	`isIsID()` Returns the value of the 'Is ID' attribute.
`boolean`	`isIsImplicit()` Returns the value of the 'Is Implicit' attribute.
`boolean`	`isIsReadOnly()` Returns the value of the 'Is Read Only' attribute.
`boolean`	`isIsResolveProxies()` Returns the value of the 'Is Resolve Proxies' attribute.
`boolean`	`isIsTransient()` Returns the value of the 'Is Transient' attribute.
`boolean`	`isIsUnsettable()` Returns the value of the 'Is Unsettable' attribute.
`boolean`	`isIsVolatile()` Returns the value of the 'Is Volatile' attribute.
`void`	`setAssociationClass(AssociationClass value)` Sets the value of the '`Association Class`' reference.
`void`	`setDefaultValue(java.lang.Object value)` Sets the value of the '`Default Value`' attribute.
`void`	`setDefaultValueString(java.lang.String value)` Sets the value of the '`Default Value String`' attribute.
`void`	`setIsComposite(boolean value)` Sets the value of the '`Is Composite`' attribute.
`void`	`setIsDerived(boolean value)` Sets the value of the '`Is Derived`' attribute.
`void`	`setIsID(boolean value)` Sets the value of the '`Is ID`' attribute.
`void`	`setIsImplicit(boolean value)` Sets the value of the '`Is Implicit`' attribute.
`void`	`setIsReadOnly(boolean value)` Sets the value of the '`Is Read Only`' attribute.
`void`	`setIsResolveProxies(boolean value)` Sets the value of the '`Is Resolve Proxies`' attribute.
`void`	`setIsTransient(boolean value)` Sets the value of the '`Is Transient`' attribute.
`void`	`setIsUnsettable(boolean value)` Sets the value of the '`Is Unsettable`' attribute.
`void`	`setIsVolatile(boolean value)` Sets the value of the '`Is Volatile`' attribute.
`void`	`setOpposite(Property value)` Sets the value of the '`Opposite`' reference.
`void`	`setOwnedExpression(LanguageExpression value)` Sets the value of the '`Owned Expression`' containment reference.
`void`	`setOwningClass(Class value)` Sets the value of the '`Owning Class`' container reference.
`void`	`setReferredProperty(Property value)` Sets the value of the '`Referred Property`' reference.
`boolean`	`validateCompatibleDefaultExpression(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)`

Methods inherited from interface org.eclipse.ocl.pivot.Feature
getImplementation, getImplementationClass, isIsStatic, setImplementation, setImplementationClass, setIsStatic, validateNameIsNotNull, validateTypeIsNotInvalid, validateTypeIsNotNull

Methods inherited from interface org.eclipse.ocl.pivot.TypedElement
CompatibleBody, getType, getTypeId, isIsMany, isIsRequired, setIsRequired, setType

Methods inherited from interface org.eclipse.ocl.pivot.NamedElement
getName, setName

Methods inherited from interface org.eclipse.ocl.pivot.Element
accept, allOwnedElements, getAnnotatingComments, getESObject, getETarget, getOwnedAnnotations, getOwnedComments, getOwnedExtensions, getValue

Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.ocl.pivot.util.Visitable
eClass

- Method Detail
  - getAssociationClass
```
AssociationClass getAssociationClass()
```
    Returns the value of the 'Association Class' reference. It is bidirectional and its opposite is 'Unowned Attributes'.
    If the meaning of the 'Association Class' reference isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Association Class' reference.
    
    See Also:
    
    setAssociationClass(AssociationClass), PivotPackage.getProperty_AssociationClass(), AssociationClass.getUnownedAttributes()
    
    Generated
  - setAssociationClass
```
void setAssociationClass(AssociationClass value)
```
    Sets the value of the 'Association Class' reference.
    
    Parameters:
    
    value - the new value of the 'Association Class' reference.
    
    See Also:
    
    getAssociationClass()
    
    Generated
  - setIsReadOnly
```
void setIsReadOnly(boolean value)
```
    Sets the value of the 'Is Read Only' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Read Only' attribute.
    
    See Also:
    
    isIsReadOnly()
    
    Generated
  - isIsResolveProxies
```
boolean isIsResolveProxies()
```
    Returns the value of the 'Is Resolve Proxies' attribute. The default value is "true".
    If the meaning of the 'Is Resolve Proxies' attribute isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Is Resolve Proxies' attribute.
    
    See Also:
    
    setIsResolveProxies(boolean), PivotPackage.getProperty_IsResolveProxies()
    
    Generated
  - setIsComposite
```
void setIsComposite(boolean value)
```
    Sets the value of the 'Is Composite' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Composite' attribute.
    
    See Also:
    
    isIsComposite()
    
    Generated
  - isIsDerived
```
boolean isIsDerived()
```
    Returns the value of the 'Is Derived' attribute. The default value is "false". Specifies whether the Property is derived, i.e., whether its value or values can be computed from other information.
    
    Returns:
    
    the value of the 'Is Derived' attribute.
    
    See Also:
    
    setIsDerived(boolean), PivotPackage.getProperty_IsDerived()
    
    Generated
  - setIsDerived
```
void setIsDerived(boolean value)
```
    Sets the value of the 'Is Derived' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Derived' attribute.
    
    See Also:
    
    isIsDerived()
    
    Generated
  - isIsID
```
boolean isIsID()
```
    Returns the value of the 'Is ID' attribute. The default value is "false".
    If the meaning of the 'Is ID' attribute isn't clear, there really should be more of a description here...
    True indicates this property can be used to uniquely identify an instance of the containing Class.
    
    Returns:
    
    the value of the 'Is ID' attribute.
    
    See Also:
    
    setIsID(boolean), PivotPackage.getProperty_IsID()
    
    Generated
  - getOpposite
```
Property getOpposite()
```
    Returns the value of the 'Opposite' reference. In the case where the Property is one end of a binary association this gives the other end.
    
    Returns:
    
    the value of the 'Opposite' reference.
    
    See Also:
    
    setOpposite(Property), PivotPackage.getProperty_Opposite()
    
    Generated
  - setOpposite
```
void setOpposite(Property value)
```
    Sets the value of the 'Opposite' reference.
    
    Parameters:
    
    value - the new value of the 'Opposite' reference.
    
    See Also:
    
    getOpposite()
    
    Generated
  - getOwnedExpression
```
LanguageExpression getOwnedExpression()
```
    Returns the value of the 'Owned Expression' containment reference.
    If the meaning of the 'Owned Expression' containment reference isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Owned Expression' containment reference.
    
    See Also:
    
    setOwnedExpression(LanguageExpression), PivotPackage.getProperty_OwnedExpression()
    
    Generated
  - setOwnedExpression
```
void setOwnedExpression(LanguageExpression value)
```
    Sets the value of the 'Owned Expression' containment reference.
    
    Parameters:
    
    value - the new value of the 'Owned Expression' containment reference.
    
    See Also:
    
    getOwnedExpression()
    
    Generated
  - setIsImplicit
```
void setIsImplicit(boolean value)
```
    Sets the value of the 'Is Implicit' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Implicit' attribute.
    
    See Also:
    
    isIsImplicit()
    
    Generated
  - isIsReadOnly
```
boolean isIsReadOnly()
```
    Returns the value of the 'Is Read Only' attribute. The default value is "false". If isReadOnly is true, the StructuralFeature may not be written to after initialization.
    
    Returns:
    
    the value of the 'Is Read Only' attribute.
    
    See Also:
    
    setIsReadOnly(boolean), PivotPackage.getProperty_IsReadOnly()
    
    Generated
  - getDefaultValue
```
java.lang.Object getDefaultValue()
```
    Returns the value of the 'Default Value' attribute.
    
    Returns:
    
    the value of the 'Default Value' attribute.
    
    See Also:
    
    setDefaultValue(Object), PivotPackage.getProperty_DefaultValue()
    
    Generated
  - setDefaultValue
```
void setDefaultValue(java.lang.Object value)
```
    Sets the value of the 'Default Value' attribute.
    
    Parameters:
    
    value - the new value of the 'Default Value' attribute.
    
    See Also:
    
    getDefaultValue()
    
    Generated
  - getDefaultValueString
```
java.lang.String getDefaultValueString()
```
    Returns the value of the 'Default Value String' attribute.
    
    Returns:
    
    the value of the 'Default Value String' attribute.
    
    See Also:
    
    setDefaultValueString(String), PivotPackage.getProperty_DefaultValueString()
    
    Generated
  - setDefaultValueString
```
void setDefaultValueString(java.lang.String value)
```
    Sets the value of the 'Default Value String' attribute.
    
    Parameters:
    
    value - the new value of the 'Default Value String' attribute.
    
    See Also:
    
    getDefaultValueString()
    
    Generated
  - isIsComposite
```
boolean isIsComposite()
```
    Returns the value of the 'Is Composite' attribute. The default value is "false".
    
    Returns:
    
    the value of the 'Is Composite' attribute.
    
    See Also:
    
    setIsComposite(boolean), PivotPackage.getProperty_IsComposite()
    
    Generated
  - setIsID
```
void setIsID(boolean value)
```
    Sets the value of the 'Is ID' attribute.
    
    Parameters:
    
    value - the new value of the 'Is ID' attribute.
    
    See Also:
    
    isIsID()
    
    Generated
  - isIsImplicit
```
boolean isIsImplicit()
```
    Returns the value of the 'Is Implicit' attribute. The default value is "false".
    If the meaning of the 'Is Implicit' attribute isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Is Implicit' attribute.
    
    See Also:
    
    setIsImplicit(boolean), PivotPackage.getProperty_IsImplicit()
    
    Generated
  - getKeys
```
@NonNull
java.util.List<Property> getKeys()
```
    Returns the value of the 'Keys' reference list. The list contents are of type Property.
    If the meaning of the 'Keys' reference list isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Keys' reference list.
    
    See Also:
    
    PivotPackage.getProperty_Keys()
    
    Generated
  - setIsResolveProxies
```
void setIsResolveProxies(boolean value)
```
    Sets the value of the 'Is Resolve Proxies' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Resolve Proxies' attribute.
    
    See Also:
    
    isIsResolveProxies()
    
    Generated
  - isIsTransient
```
boolean isIsTransient()
```
    Returns the value of the 'Is Transient' attribute. The default value is "false".
    If the meaning of the 'Is Transient' attribute isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Is Transient' attribute.
    
    See Also:
    
    setIsTransient(boolean), PivotPackage.getProperty_IsTransient()
    
    Generated
  - setIsTransient
```
void setIsTransient(boolean value)
```
    Sets the value of the 'Is Transient' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Transient' attribute.
    
    See Also:
    
    isIsTransient()
    
    Generated
  - isIsUnsettable
```
boolean isIsUnsettable()
```
    Returns the value of the 'Is Unsettable' attribute. The default value is "false".
    If the meaning of the 'Is Unsettable' attribute isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Is Unsettable' attribute.
    
    See Also:
    
    setIsUnsettable(boolean), PivotPackage.getProperty_IsUnsettable()
    
    Generated
  - setIsUnsettable
```
void setIsUnsettable(boolean value)
```
    Sets the value of the 'Is Unsettable' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Unsettable' attribute.
    
    See Also:
    
    isIsUnsettable()
    
    Generated
  - isIsVolatile
```
boolean isIsVolatile()
```
    Returns the value of the 'Is Volatile' attribute. The default value is "false".
    If the meaning of the 'Is Volatile' attribute isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Is Volatile' attribute.
    
    See Also:
    
    setIsVolatile(boolean), PivotPackage.getProperty_IsVolatile()
    
    Generated
  - setIsVolatile
```
void setIsVolatile(boolean value)
```
    Sets the value of the 'Is Volatile' attribute.
    
    Parameters:
    
    value - the new value of the 'Is Volatile' attribute.
    
    See Also:
    
    isIsVolatile()
    
    Generated
  - getSubsettedProperty
```
java.util.List<Property> getSubsettedProperty()
```
    Returns the value of the 'Subsetted Property' reference list. The list contents are of type Property.
    If the meaning of the 'Subsetted Property' reference list isn't clear, there really should be more of a description here...
    The properties of which this Property is constrained to be a subset, if any.
    
    Returns:
    
    the value of the 'Subsetted Property' reference list.
    
    See Also:
    
    PivotPackage.getProperty_SubsettedProperty()
    
    Generated
  - getReferredProperty
```
Property getReferredProperty()
```
    Returns the value of the 'Referred Property' reference.
    If the meaning of the 'Referred Property' reference isn't clear, there really should be more of a description here...
    
    Returns:
    
    the value of the 'Referred Property' reference.
    
    See Also:
    
    setReferredProperty(Property), PivotPackage.getProperty_ReferredProperty()
    
    Generated
  - setReferredProperty
```
void setReferredProperty(Property value)
```
    Sets the value of the 'Referred Property' reference.
    
    Parameters:
    
    value - the new value of the 'Referred Property' reference.
    
    See Also:
    
    getReferredProperty()
    
    Generated
  - isAttribute
```
boolean isAttribute(Property p)
```
    Generated
  - validateCompatibleDefaultExpression
```
boolean validateCompatibleDefaultExpression(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                            java.util.Map<java.lang.Object,java.lang.Object> context)
```
    Generated
  - getOwningClass
```
Class getOwningClass()
```
    Returns the value of the 'Owning Class' container reference. It is bidirectional and its opposite is 'Owned Properties'. The Class that owns this Property, if any.
    
    Specified by:
    
    getOwningClass in interface Feature
    
    Returns:
    
    the value of the 'Owning Class' container reference.
    
    See Also:
    
    setOwningClass(org.eclipse.ocl.pivot.Class), PivotPackage.getProperty_OwningClass(), Class.getOwnedProperties()
    
    Generated
  - setOwningClass
```
void setOwningClass(Class value)
```
    Sets the value of the 'Owning Class' container reference.
    
    Parameters:
    
    value - the new value of the 'Owning Class' container reference.
    
    See Also:
    
    getOwningClass()
    
    Generated
  - getRedefinedProperties
```
@NonNull
java.util.List<Property> getRedefinedProperties()
```
    Returns the value of the 'Redefined Properties' reference list. The list contents are of type Property.
    If the meaning of the 'Redefined Properties' reference list isn't clear, there really should be more of a description here...
    The properties that are redefined by this property, if any.
    
    Returns:
    
    the value of the 'Redefined Properties' reference list.
    
    See Also:
    
    PivotPackage.getProperty_RedefinedProperties()
    
    Generated
  - getPropertyId
```
@NonNull
PropertyId getPropertyId()
```
  - getInheritance
```
@Nullable
CompleteInheritance getInheritance(@NonNull
                                              StandardLibrary standardLibrary)
```
    Return the Inheritance dispatch table for the owning type, or null for an orphan property owned by an Annotation.
  - initValue
```
void initValue(@NonNull
               java.lang.Object object,
               @Nullable
               java.lang.Object ecoreValue)
```
    Initialize the value of this property within objectValue to propertyValue.
    This method is not thread-safe and should only be invoked to complete construction of objectvalue before making it visible to other threads.

Interface Property

Method Summary

Methods inherited from interface org.eclipse.ocl.pivot.Feature

Methods inherited from interface org.eclipse.ocl.pivot.TypedElement

Methods inherited from interface org.eclipse.ocl.pivot.NamedElement

Methods inherited from interface org.eclipse.ocl.pivot.Element

Methods inherited from interface org.eclipse.emf.ecore.EObject

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

Methods inherited from interface org.eclipse.ocl.pivot.util.Visitable

Method Detail

getAssociationClass

setAssociationClass

setIsReadOnly

isIsResolveProxies

setIsComposite

isIsDerived

setIsDerived

isIsID

getOpposite

setOpposite

getOwnedExpression

setOwnedExpression

setIsImplicit

isIsReadOnly

getDefaultValue

setDefaultValue

getDefaultValueString

setDefaultValueString

isIsComposite

setIsID

isIsImplicit

getKeys

setIsResolveProxies

isIsTransient

setIsTransient

isIsUnsettable

setIsUnsettable

isIsVolatile

setIsVolatile

getSubsettedProperty

getReferredProperty

setReferredProperty

isAttribute

validateCompatibleDefaultExpression

getOwningClass

setOwningClass

getRedefinedProperties

getPropertyId

getInheritance

initValue