Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ocl.examples.pivot
Interface Property

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

A representation of the model object 'Property'.

See Also:
PivotPackage.getProperty()
Extends:
org.eclipse.ocl.examples.domain.elements.DomainProperty A property is a typed element that represents an attribute of a class. 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:

Generated

Method Summary
 AssociationClass getAssociationClass()
          Returns the value of the 'Association Class' reference.
 Class getClass_()
          Returns the value of the 'Class' reference.
 java.lang.String getDefault()
          Returns the value of the 'Default' attribute.
 OpaqueExpression getDefaultExpression()
          Returns the value of the 'Default Expression' containment reference.
 java.util.List<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.
 PropertyId getPropertyId()
           
 java.util.List<Property> getRedefinedProperty()
          Returns the value of the 'Redefined Property' 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.
 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 setAssociationClass(AssociationClass value)
          Sets the value of the 'Association Class' reference.
 void setDefault(java.lang.String value)
          Sets the value of the 'Default' attribute.
 void setDefaultExpression(OpaqueExpression value)
          Sets the value of the 'Default Expression' containment reference.
 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.
 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.examples.pivot.Feature
getImplementation, getImplementationClass, setImplementation, setImplementationClass
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.TypedMultiplicityElement
CompatibleBody, isMany, makeParameter
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.TypedElement
getType, isRequired, setIsRequired, setType
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.NamedElement
getName, isStatic, setIsStatic, setName
 
Methods inherited from interface org.eclipse.ocl.examples.pivot.Element
allOwnedElements, getETarget, getExtension, getOwnedAnnotation, getOwnedComment, 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.examples.pivot.util.Visitable
accept, eClass
 
Methods inherited from interface org.eclipse.ocl.examples.domain.elements.DomainTypedElement
getTypeId
 
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, initValue
 
Methods inherited from interface org.eclipse.ocl.examples.domain.elements.DomainFeature
getImplementation, isStatic
 

Method Detail

getAssociationClass

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

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.getUnownedAttribute()
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

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

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

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

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

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

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

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

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

getDefaultExpression

OpaqueExpression getDefaultExpression()
Returns the value of the 'Default Expression' containment reference.

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

Specified by:
getDefaultExpression in interface DomainProperty
Returns:
the value of the 'Default Expression' containment reference.
See Also:
setDefaultExpression(OpaqueExpression), PivotPackage.getProperty_DefaultExpression()
Generated

setDefaultExpression

void setDefaultExpression(OpaqueExpression value)
Sets the value of the 'Default Expression' containment reference.

Parameters:
value - the new value of the 'Default Expression' containment reference.
See Also:
getDefaultExpression()
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

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

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

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

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

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

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

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

getRedefinedProperty

java.util.List<Property> getRedefinedProperty()
Returns the value of the 'Redefined Property' reference list. The list contents are of type Property.

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

Returns:
the value of the 'Redefined Property' reference list.
See Also:
PivotPackage.getProperty_RedefinedProperty()
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...

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

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...

Specified by:
getOwningType in interface DomainFeature
Returns:
the value of the 'Owning Type' container reference.
See Also:
setOwningType(Type), PivotPackage.getProperty_OwningType(), Type.getOwnedAttribute()
Generated

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

validateCompatibleDefaultExpression

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

Generated

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

getPropertyId

@NonNull
PropertyId getPropertyId()
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD