org.eclipse.ocl.examples.pivot
Interface Property

All Superinterfaces:
DomainElement, DomainNamedElement, DomainProperty, DomainTypedElement, Element, org.eclipse.emf.ecore.EObject, Feature, MultiplicityElement, Nameable, NamedElement, org.eclipse.emf.common.notify.Notifier, ParameterableElement, PivotObject, TypedElement, TypedMultiplicityElement, Visitable
All Known Implementing Classes:
PropertyImpl

public interface Property
extends Feature, ParameterableElement, DomainProperty

A representation of the model object 'Property'.

See Also:
PivotPackage.getProperty()
Generated
Model

Method Summary
 AssociationClass getAssociation()
          Returns the value of the 'Association' reference.
 Class getClass_()
          Returns the value of the 'Class' reference.
 java.lang.String getDefault()
          Returns the value of the 'Default' attribute.
 org.eclipse.emf.common.util.EList<Property> getKeys()
          Returns the value of the 'Keys' reference list.
 Property getOpposite()
          Returns the value of the 'Opposite' reference.
 Type getOwningType()
          Returns the value of the 'Owning Type' container reference.
 boolean isAttribute(Property p)
           
 boolean isComposite()
          Returns the value of the 'Is Composite' attribute.
 boolean isDerived()
          Returns the value of the 'Is Derived' attribute.
 boolean isID()
          Returns the value of the 'Is ID' attribute.
 boolean isImplicit()
          Returns the value of the 'Implicit' attribute.
 boolean isReadOnly()
          Returns the value of the 'Is Read Only' attribute.
 boolean isResolveProxies()
          Returns the value of the 'Is Resolve Proxies' attribute.
 boolean isTransient()
          Returns the value of the 'Is Transient' attribute.
 boolean isUnsettable()
          Returns the value of the 'Is Unsettable' attribute.
 boolean isVolatile()
          Returns the value of the 'Is Volatile' attribute.
 void setAssociation(AssociationClass value)
          Sets the value of the 'Association' reference.
 void setDefault(java.lang.String value)
          Sets the value of the 'Default' attribute.
 void setImplicit(boolean value)
          Sets the value of the 'Implicit' 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 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 setOwningType(Type value)
          Sets the value of the 'Owning Type' container reference.
 boolean validateCompatibleInitialiser(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
           
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.Feature
getImplementation, getImplementationClass, setImplementation, setImplementationClass
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.TypedMultiplicityElement
CompatibleBody, makeParameter
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.TypedElement
getType, setType
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.NamedElement
createOwnedAnnotation, createOwnedRule, getName, getOwnedAnnotation, getOwnedRule, isStatic, setIsStatic, setName
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.Element
allOwnedElements, createOwnedComment, getETarget, getOwnedComment, validateNotOwnSelf
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.util.Visitable
accept, eClass
 
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.examples.domain.elements.DomainNamedElement
getName
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.MultiplicityElement
getLower, getUpper, includesCardinality, includesMultiplicity, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setUpper, upperBound
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.ParameterableElement
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.ocl.examples.domain.elements.DomainProperty
getInheritance, setValue
 

Method Detail

isReadOnly

boolean isReadOnly()
Returns the value of the 'Is Read Only' attribute. The default value is "false". If isReadOnly is true, the attribute may not be written to after initialization.

Returns:
the value of the 'Is Read Only' attribute.
See Also:
setIsReadOnly(boolean), PivotPackage.getProperty_IsReadOnly()
Generated
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isReadOnly'"

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:
isReadOnly()
Generated

getDefault

java.lang.String getDefault()
Returns the value of the 'Default' attribute. A string that is evaluated to give a default value for the attribute when an object of the owning class is instantiated.

Returns:
the value of the 'Default' attribute.
See Also:
setDefault(String), PivotPackage.getProperty_Default()
Generated
Model
dataType="org.eclipse.ocl.examples.pivot.String" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!default'"

setDefault

void setDefault(java.lang.String value)
Sets the value of the 'Default' attribute.

Parameters:
value - the new value of the 'Default' attribute.
See Also:
getDefault()
Generated

isComposite

boolean isComposite()
Returns the value of the 'Is Composite' attribute. The default value is "false". If isComposite is true, the object containing the attribute is a container for the object or value contained in the attribute.

Returns:
the value of the 'Is Composite' attribute.
See Also:
setIsComposite(boolean), PivotPackage.getProperty_IsComposite()
Generated
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isComposite'"

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:
isComposite()
Generated

isDerived

boolean isDerived()
Returns the value of the 'Is Derived' attribute. The default value is "false". If isDerived is true, the value of the attribute is derived from information elsewhere.

Returns:
the value of the 'Is Derived' attribute.
See Also:
setIsDerived(boolean), PivotPackage.getProperty_IsDerived()
Generated
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isDerived'"

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:
isDerived()
Generated

getOpposite

Property getOpposite()
Returns the value of the 'Opposite' reference. Two attributes attr1 and attr2 of two objects o1 and o2 (which may be the same object) may be paired with each other so that o1.attr1 refers to o2 if and only if o2.attr2 refers to o1. In such a case attr1 is the opposite of attr2 and attr2 is the opposite of attr1.

Specified by:
getOpposite in interface DomainProperty
Returns:
the value of the 'Opposite' reference.
See Also:
setOpposite(Property), PivotPackage.getProperty_Opposite()
Generated
Model
ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!opposite'"

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

getAssociation

AssociationClass getAssociation()
Returns the value of the 'Association' reference. It is bidirectional and its opposite is 'Unowned Attribute'.

If the meaning of the 'Association' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Association' reference.
See Also:
setAssociation(AssociationClass), PivotPackage.getProperty_Association(), AssociationClass.getUnownedAttribute()
Generated
Model
opposite="unownedAttribute" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!association'"

setAssociation

void setAssociation(AssociationClass value)
Sets the value of the 'Association' reference.

Parameters:
value - the new value of the 'Association' reference.
See Also:
getAssociation()
Generated

isImplicit

boolean isImplicit()
Returns the value of the 'Implicit' attribute. The default value is "false".

If the meaning of the 'Implicit' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Implicit' attribute.
See Also:
setImplicit(boolean), PivotPackage.getProperty_Implicit()
Generated
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!implicit'"

setImplicit

void setImplicit(boolean value)
Sets the value of the 'Implicit' attribute.

Parameters:
value - the new value of the 'Implicit' attribute.
See Also:
isImplicit()
Generated

isID

boolean isID()
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...

Returns:
the value of the 'Is ID' attribute.
See Also:
setIsID(boolean), PivotPackage.getProperty_IsID()
Generated
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isID'"

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:
isID()
Generated

getKeys

org.eclipse.emf.common.util.EList<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
Model
ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!keys'"

isResolveProxies

boolean isResolveProxies()
Returns the value of the 'Is Resolve Proxies' attribute. The default value is "true".

If the meaning of the '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
Model
default="true" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isResolveProxies'"

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:
isResolveProxies()
Generated

isTransient

boolean isTransient()
Returns the value of the 'Is Transient' attribute. The default value is "false".

If the meaning of the '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
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isTransient'"

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:
isTransient()
Generated

isUnsettable

boolean isUnsettable()
Returns the value of the 'Is Unsettable' attribute. The default value is "false".

If the meaning of the '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
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isUnsettable'"

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:
isUnsettable()
Generated

isVolatile

boolean isVolatile()
Returns the value of the 'Is Volatile' attribute. The default value is "false".

If the meaning of the '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
Model
default="false" dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!isVolatile'"

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:
isVolatile()
Generated

getOwningType

Type getOwningType()
Returns the value of the 'Owning Type' container reference. It is bidirectional and its opposite is 'Owned Attribute'.

If the meaning of the 'Owning Type' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Owning Type' container reference.
See Also:
setOwningType(Type), PivotPackage.getProperty_OwningType(), Type.getOwnedAttribute()
Generated
Model
opposite="ownedAttribute" transient="false" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!owningType'"

setOwningType

void setOwningType(Type value)
Sets the value of the 'Owning Type' container reference.

Parameters:
value - the new value of the 'Owning Type' container reference.
See Also:
getOwningType()
Generated

isAttribute

boolean isAttribute(Property p)

Generated
Model
dataType="org.eclipse.ocl.examples.pivot.Boolean" required="true" ordered="false" pRequired="true" pOrdered="false" annotation="http://www.eclipse.org/emf/2002/GenModel body='/*\nlet container : OclElement = oclContainer()\nin\n container.oclIsKindOf(Type) and\n container.oclAsType(Type)\n .ownedAttribute->includes(self)\n\052/\ntry {\n\tfinal <%org.eclipse.ocl.examples.domain.evaluation.DomainEvaluator%> evaluator = new <%org.eclipse.ocl.examples.library.ecore.EcoreExecutorManager%>(this, null, <%org.eclipse.ocl.examples.pivot.PivotTables%>.LIBRARY);\n\tfinal <%org.eclipse.ocl.examples.domain.values.ValueFactory%> valueFactory = evaluator.getValueFactory();\n\tfinal <%org.eclipse.ocl.examples.domain.values.Value%> self = valueFactory.valueOf(this);\n\tfinal <%org.eclipse.ocl.examples.library.executor.ExecutorType%> T_Boolean = <%org.eclipse.ocl.examples.library.oclstdlib.OCLstdlibTables%>.Types._Boolean;\n\t\n\tfinal <%org.eclipse.ocl.examples.domain.elements.DomainType%> returnType = T_Boolean;\n\tfinal <%org.eclipse.ocl.examples.domain.values.Value%> result = <%org.eclipse.ocl.examples.pivot.bodies.PropertyBodies%>._isAttribute_body_.INSTANCE.evaluate(evaluator, returnType, self, valueFactory.valueOf(p));\n\treturn (Boolean) result.asEcoreObject();\n} catch (<%org.eclipse.ocl.examples.domain.evaluation.InvalidValueException%> e) {\n\tthrow new <%org.eclipse.emf.common.util.WrappedException%>(\"Failed to evaluate org.eclipse.ocl.examples.pivot.bodies.PropertyBodies\", e);\n}\n'"

validateCompatibleInitialiser

boolean validateCompatibleInitialiser(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                      java.util.Map<java.lang.Object,java.lang.Object> context)

Generated
Model
annotation="http://www.eclipse.org/emf/2002/GenModel body='/*\nisDerived implies\nlet\n derivedConstraint : Constraint = ownedRule->any(stereotype = \'derivation\')\nin\n let\n initialConstraint : Constraint = ownedRule->any(stereotype = \'initial\')\n in\n let\n derivedSpecification : ValueSpecification = if derivedConstraint <> null\n then derivedConstraint.specification\n else null\n endif\n in\n let\n initialSpecification : ValueSpecification = if initialConstraint <> null\n then initialConstraint.specification\n else null\n endif\n in\n let\n initialiser : ValueSpecification = if derivedSpecification <> null\n then derivedSpecification\n else initialSpecification\n endif\n in initialiser <> null and\n initialiser.oclIsKindOf(ExpressionInOCL) implies\n CompatibleBody(initialiser)\n\052/\ntry {\n\tfinal <%org.eclipse.ocl.examples.domain.evaluation.DomainEvaluator%> evaluator = new <%org.eclipse.ocl.examples.library.ecore.EcoreExecutorManager%>(this, null, <%org.eclipse.ocl.examples.pivot.PivotTables%>.LIBRARY);\n\tfinal <%org.eclipse.ocl.examples.domain.values.ValueFactory%> valueFactory = evaluator.getValueFactory();\n\tfinal <%org.eclipse.ocl.examples.domain.values.Value%> self = valueFactory.valueOf(this);\n\tfinal <%org.eclipse.ocl.examples.library.executor.ExecutorType%> T_Boolean = <%org.eclipse.ocl.examples.library.oclstdlib.OCLstdlibTables%>.Types._Boolean;\n\t\n\tfinal <%org.eclipse.ocl.examples.domain.elements.DomainType%> returnType = T_Boolean;\n\tfinal <%org.eclipse.ocl.examples.domain.values.Value%> result = <%org.eclipse.ocl.examples.pivot.bodies.PropertyBodies%>._invariant_CompatibleInitialiser.INSTANCE.evaluate(evaluator, returnType, self);\n\tfinal boolean resultIsNull = result.isNull();\n\tif (!resultIsNull && result.asBoolean()) {\t// true => true, false/null => dropthrough, invalid => exception\n\t\treturn true;\n\t}\n\tif (diagnostics != null) {\n\t\tint severity = resultIsNull ? <%org.eclipse.emf.common.util.Diagnostic%>.ERROR : <%org.eclipse.emf.common.util.Diagnostic%>.WARNING;\n\t\tString message = <%org.eclipse.osgi.util.NLS%>.bind(<%org.eclipse.ocl.examples.domain.messages.EvaluatorMessages%>.ValidationConstraintIsNotSatisfied_ERROR_, new Object[]{\"Property\", \"CompatibleInitialiser\", <%org.eclipse.emf.ecore.util.EObjectValidator%>.getObjectLabel(this, context)});\n\t diagnostics.add(new <%org.eclipse.emf.common.util.BasicDiagnostic%>(severity, <%org.eclipse.ocl.examples.pivot.util.PivotValidator%>.DIAGNOSTIC_SOURCE, <%org.eclipse.ocl.examples.pivot.util.PivotValidator%>.PROPERTY__COMPATIBLE_INITIALISER, message, new Object [] { this }));\n\t}\n\treturn false;\n} catch (<%org.eclipse.ocl.examples.domain.evaluation.InvalidValueException%> e) {\n\tString message = <%org.eclipse.osgi.util.NLS%>.bind(<%org.eclipse.ocl.examples.domain.messages.EvaluatorMessages%>.ValidationEvaluationFailed_ERROR_, new Object[]{\"Property\", \"CompatibleInitialiser\", <%org.eclipse.emf.ecore.util.EObjectValidator%>.getObjectLabel(this, context)});\n\tthrow new <%org.eclipse.emf.common.util.WrappedException%>(message, e);\n}\n'"

getClass_

Class getClass_()
Returns the value of the 'Class' reference. The class that owns the property, and of which the property is an attribute.

Returns:
the value of the 'Class' reference.
See Also:
PivotPackage.getProperty_Class()
Generated
Model
transient="true" changeable="false" volatile="true" ordered="false" annotation="http://www.eclipse.org/emf/2002/GenModel get='throw new UnsupportedOperationException(); // FIXME Unimplemented http://www.eclipse.org/ocl/3.1.0/Pivot!Property!class'"