|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Property'. A property is a structural feature of a classifier that characterizes instances of the classifier. 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 class to a value or set of values of the type of the attribute. A property related by memberEnd or its specializations 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 represents a set of instances that are owned by a containing classifier instance. A property has the capability of being a deployment target in a deployment relationship. This enables modeling the deployment to hierarchical nodes that have properties functioning as internal parts. Property represents a declared state of one or more instances in terms of a named relationship to a value or values. When a property is an attribute of a classifier, the value or values are related to the instance of the classifier by being held in slots of the instance. When a property is an association end, the value or values are related to the instance or instances at the other end(s) of the association. The range of valid values represented by the property can be controlled by setting the property's type. 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:
Class
Datatype
Is Derived
Is Derived Union
Default
Aggregation
Is Composite
Redefined Property
Owning Association
Default Value
Opposite
Subsetted Property
Association
Qualifier
Association End
UMLPackage.getProperty()
Field Summary |
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
SEPARATOR |
Method Summary | |
ValueSpecification |
createDefaultValue(String name,
Type type,
EClass eClass)
Creates a new ValueSpecification , with the specified 'Name', and 'Type', and sets the 'Default Value' containment reference |
Property |
createQualifier(String name,
Type type)
Creates a new Property , with the specified 'Name', and 'Type', and appends it to the 'Qualifier' containment reference list |
Property |
createQualifier(String name,
Type type,
EClass eClass)
Creates a new Property , with the specified 'Name', and 'Type', and appends it to the 'Qualifier' containment reference list |
AggregationKind |
getAggregation()
Returns the value of the 'Aggregation' attribute. |
Association |
getAssociation()
Returns the value of the 'Association' reference. |
Property |
getAssociationEnd()
Returns the value of the 'Association End' container reference. |
Class |
getClass_()
Returns the value of the 'Class' reference |
DataType |
getDatatype()
Returns the value of the 'Datatype' container reference. |
String |
getDefault()
Returns the value of the 'Default' attribute |
ValueSpecification |
getDefaultValue()
Returns the value of the 'Default Value' containment reference |
Property |
getOpposite()
Returns the value of the 'Opposite' reference |
Property |
getOtherEnd()
Retrieves the other end of the (binary) association in which this property is a member end |
Association |
getOwningAssociation()
Returns the value of the 'Owning Association' container reference. |
Property |
getQualifier(String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list |
Property |
getQualifier(String name,
Type type,
boolean ignoreCase,
EClass eClass,
boolean createOnDemand)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list |
EList |
getQualifiers()
Returns the value of the 'Qualifier' containment reference list. |
EList |
getRedefinedProperties()
Returns the value of the 'Redefined Property' reference list. |
Property |
getRedefinedProperty(String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Redefined Property' reference list |
Property |
getRedefinedProperty(String name,
Type type,
boolean ignoreCase,
EClass eClass)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Redefined Property' reference list |
EList |
getSubsettedProperties()
Returns the value of the 'Subsetted Property' reference list. |
Property |
getSubsettedProperty(String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Subsetted Property' reference list |
Property |
getSubsettedProperty(String name,
Type type,
boolean ignoreCase,
EClass eClass)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Subsetted Property' reference list |
boolean |
isAttribute(Property p)
The query isAttribute() is true if the Property is defined as an attribute of some classifier. |
boolean |
isComposite()
Returns the value of the 'Is Composite' attribute. |
boolean |
isDerived()
Returns the value of the 'Is Derived' attribute. |
boolean |
isDerivedUnion()
Returns the value of the 'Is Derived Union' attribute. |
boolean |
isNavigable()
The query isNavigable() indicates whether it is possible to navigate across the property. |
boolean |
isSetDefault()
Returns whether the value of the ' Default ' attribute is set |
void |
setAggregation(AggregationKind value)
Sets the value of the ' Aggregation ' attribute |
void |
setAssociation(Association value)
Sets the value of the ' Association ' reference |
void |
setAssociationEnd(Property value)
Sets the value of the ' Association End ' container reference |
void |
setBooleanDefaultValue(boolean value)
Sets the default value for this property to the specified Boolean value |
void |
setDatatype(DataType value)
Sets the value of the ' Datatype ' container reference |
void |
setDefault(String value)
Sets the value of the ' Default ' attribute |
void |
setDefaultValue(ValueSpecification value)
Sets the value of the ' Default Value ' containment reference |
void |
setIntegerDefaultValue(int value)
Sets the default value for this property to the specified integer value |
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 |
setIsDerivedUnion(boolean value)
Sets the value of the ' Is Derived Union ' attribute |
void |
setIsNavigable(boolean isNavigable)
Sets the navigability of this property as indicated |
void |
setNullDefaultValue()
Sets the default value for this property to the null value |
void |
setOpposite(Property value)
Sets the value of the ' Opposite ' reference |
void |
setOwningAssociation(Association value)
Sets the value of the ' Owning Association ' container reference |
void |
setStringDefaultValue(String value)
Sets the default value for this property to the specified string value |
void |
setUnlimitedNaturalDefaultValue(int value)
Sets the default value for this property to the specified unlimited natural value |
EList |
subsettingContext()
The query subsettingContext() gives the context for subsetting a property. |
void |
unsetDefault()
Unsets the value of the ' Default ' attribute |
boolean |
validateBindingToAttribute(DiagnosticChain diagnostics,
Map context)
A binding of a property template parameter representing an attribute must be to an attribute. |
boolean |
validateDeploymentTarget(DiagnosticChain diagnostics,
Map context)
A Property can be a DeploymentTarget if it is a kind of Node and functions as a part in the internal structure of an encompassing Node. |
boolean |
validateDerivedUnionIsDerived(DiagnosticChain diagnostics,
Map context)
A derived union is derived. |
boolean |
validateDerivedUnionIsReadOnly(DiagnosticChain diagnostics,
Map context)
A derived union is read only. |
boolean |
validateMultiplicityOfComposite(DiagnosticChain diagnostics,
Map context)
A multiplicity of a composite aggregation must not have an upper bound greater than 1. |
boolean |
validateNavigableReadonly(DiagnosticChain diagnostics,
Map context)
Only a navigable property can be marked as readOnly. |
boolean |
validateRedefinedPropertyInherited(DiagnosticChain diagnostics,
Map context)
A redefined property must be inherited from a more general classifier containing the redefining property. |
boolean |
validateSubsettedPropertyNames(DiagnosticChain diagnostics,
Map context)
A property may not subset a property with the same name. |
boolean |
validateSubsettingContextConforms(DiagnosticChain diagnostics,
Map context)
Subsetting may only occur when the context of the subsetting property conforms to the context of the subsetted property. |
boolean |
validateSubsettingRules(DiagnosticChain diagnostics,
Map context)
A subsetting property may strengthen the type of the subsetted property, and its upper bound may be less. |
Methods inherited from interface org.eclipse.uml2.uml.StructuralFeature |
isReadOnly, setIsReadOnly |
Methods inherited from interface org.eclipse.uml2.uml.Feature |
getFeaturingClassifier, getFeaturingClassifier, getFeaturingClassifiers, isStatic, setIsStatic |
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement |
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid |
Methods inherited from interface org.eclipse.uml2.uml.NamedElement |
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership |
Methods inherited from interface org.eclipse.emf.ecore.EModelElement |
getEAnnotation, getEAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, 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.uml2.uml.TypedElement |
getType, setType |
Methods inherited from interface org.eclipse.uml2.uml.MultiplicityElement |
compatibleWith, createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesCardinality, includesMultiplicity, is, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setLowerValue, setUpper, setUpperValue, upperBound, validateLowerGe0, validateUpperGeLower, validateUpperGt0, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects |
Methods inherited from interface org.eclipse.uml2.uml.ConnectableElement |
getEnds |
Methods inherited from interface org.eclipse.uml2.uml.ParameterableElement |
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.uml.DeploymentTarget |
createDeployment, getDeployedElement, getDeployedElement, getDeployedElements, getDeployment, getDeployment, getDeployments |
Methods inherited from interface org.eclipse.uml2.uml.TemplateableElement |
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature |
Method Detail |
public DataType getDatatype()
Owned Attribute
'.
The DataType that owns this Property.
Property.setDatatype(DataType)
,
UMLPackage.getProperty_Datatype()
,
DataType.getOwnedAttributes()
public void setDatatype(DataType value)
Datatype
' container reference.
value
- the new value of the 'Datatype' container reference.Property.getDatatype()
public boolean isDerived()
"false"
.
If isDerived is true, the value of the attribute is derived from information elsewhere.
Specifies whether the Property is derived, i.e., whether its value or values can be computed from other information.
Property.setIsDerived(boolean)
,
UMLPackage.getProperty_IsDerived()
public void setIsDerived(boolean value)
Is Derived
' attribute.
value
- the new value of the 'Is Derived' attribute.Property.isDerived()
public boolean isDerivedUnion()
"false"
.
Specifies whether the property is derived as the union of all of the properties that are constrained to subset it.
Property.setIsDerivedUnion(boolean)
,
UMLPackage.getProperty_IsDerivedUnion()
public void setIsDerivedUnion(boolean value)
Is Derived Union
' attribute.
value
- the new value of the 'Is Derived Union' attribute.Property.isDerivedUnion()
public String getDefault()
Property.isSetDefault()
,
Property.unsetDefault()
,
Property.setDefault(String)
,
UMLPackage.getProperty_Default()
public void setDefault(String value)
Default
' attribute.
value
- the new value of the 'Default' attribute.Property.isSetDefault()
,
Property.unsetDefault()
,
Property.getDefault()
public void unsetDefault()
Default
' attribute.
Property.isSetDefault()
,
Property.getDefault()
,
Property.setDefault(String)
public boolean isSetDefault()
Default
' attribute is set.
Property.unsetDefault()
,
Property.getDefault()
,
Property.setDefault(String)
public AggregationKind getAggregation()
"none"
.
The literals are from the enumeration AggregationKind
.
Specifies the kind of aggregation that applies to the Property.
AggregationKind
,
Property.setAggregation(AggregationKind)
,
UMLPackage.getProperty_Aggregation()
public void setAggregation(AggregationKind value)
Aggregation
' attribute.
value
- the new value of the 'Aggregation' attribute.AggregationKind
,
Property.getAggregation()
public boolean isComposite()
"false"
.
If isComposite is true, the object containing the attribute is a container for the object or value contained in the attribute.
This is a derived value, indicating whether the aggregation of the Property is composite or not.
Property.setIsComposite(boolean)
,
UMLPackage.getProperty_IsComposite()
public void setIsComposite(boolean value)
Is Composite
' attribute.
value
- the new value of the 'Is Composite' attribute.Property.isComposite()
public Class getClass_()
UMLPackage.getProperty_Class()
public EList getRedefinedProperties()
Property
.
References the properties that are redefined by this property.
UMLPackage.getProperty_RedefinedProperty()
public Property getRedefinedProperty(String name, Type type)
Property
with the specified 'Name', and 'Type' from the 'Redefined Property' reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.
Property
with the specified 'Name', and 'Type', or null
.Property.getRedefinedProperties()
public Property getRedefinedProperty(String name, Type type, boolean ignoreCase, EClass eClass)
Property
with the specified 'Name', and 'Type' from the 'Redefined Property' reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the Property
to retrieve, or null
.
Property
with the specified 'Name', and 'Type', or null
.Property.getRedefinedProperties()
public Association getOwningAssociation()
Owned End
'.
References the owning association of this property, if any.
Property.setOwningAssociation(Association)
,
UMLPackage.getProperty_OwningAssociation()
,
Association.getOwnedEnds()
public void setOwningAssociation(Association value)
Owning Association
' container reference.
value
- the new value of the 'Owning Association' container reference.Property.getOwningAssociation()
public Association getAssociation()
Member End
'.
References the association of which this property is a member, if any.
Property.setAssociation(Association)
,
UMLPackage.getProperty_Association()
,
Association.getMemberEnds()
public void setAssociation(Association value)
Association
' reference.
value
- the new value of the 'Association' reference.Property.getAssociation()
public ValueSpecification getDefaultValue()
Property.setDefaultValue(ValueSpecification)
,
UMLPackage.getProperty_DefaultValue()
public void setDefaultValue(ValueSpecification value)
Default Value
' containment reference.
value
- the new value of the 'Default Value' containment reference.Property.getDefaultValue()
public ValueSpecification createDefaultValue(String name, Type type, EClass eClass)
ValueSpecification
, with the specified 'Name', and 'Type', and sets the 'Default Value' containment reference.
name
- The 'Name' for the new ValueSpecification
, or null
.type
- The 'Type' for the new ValueSpecification
, or null
.eClass
- The Ecore class of the ValueSpecification
to create.
ValueSpecification
.Property.getDefaultValue()
public Property getOpposite()
Property.setOpposite(Property)
,
UMLPackage.getProperty_Opposite()
public void setOpposite(Property value)
Opposite
' reference.
value
- the new value of the 'Opposite' reference.Property.getOpposite()
public EList getSubsettedProperties()
Property
.
References the properties of which this property is constrained to be a subset.
UMLPackage.getProperty_SubsettedProperty()
public Property getSubsettedProperty(String name, Type type)
Property
with the specified 'Name', and 'Type' from the 'Subsetted Property' reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.
Property
with the specified 'Name', and 'Type', or null
.Property.getSubsettedProperties()
public Property getSubsettedProperty(String name, Type type, boolean ignoreCase, EClass eClass)
Property
with the specified 'Name', and 'Type' from the 'Subsetted Property' reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the Property
to retrieve, or null
.
Property
with the specified 'Name', and 'Type', or null
.Property.getSubsettedProperties()
public EList getQualifiers()
Property
.
It is bidirectional and its opposite is 'Association End
'.
An optional list of ordered qualifier attributes for the end. If the list is empty, then the Association is not qualified.
UMLPackage.getProperty_Qualifier()
,
Property.getAssociationEnd()
public Property createQualifier(String name, Type type, EClass eClass)
Property
, with the specified 'Name', and 'Type', and appends it to the 'Qualifier' containment reference list.
name
- The 'Name' for the new Property
, or null
.type
- The 'Type' for the new Property
, or null
.eClass
- The Ecore class of the Property
to create.
Property
.Property.getQualifiers()
public Property createQualifier(String name, Type type)
Property
, with the specified 'Name', and 'Type', and appends it to the 'Qualifier' containment reference list.
name
- The 'Name' for the new Property
, or null
.type
- The 'Type' for the new Property
, or null
.
Property
.Property.getQualifiers()
public Property getQualifier(String name, Type type)
Property
with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.
Property
with the specified 'Name', and 'Type', or null
.Property.getQualifiers()
public Property getQualifier(String name, Type type, boolean ignoreCase, EClass eClass, boolean createOnDemand)
Property
with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list.
name
- The 'Name' of the Property
to retrieve, or null
.type
- The 'Type' of the Property
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.eClass
- The Ecore class of the Property
to retrieve, or null
.createOnDemand
- Whether to create a Property
on demand if not found.
Property
with the specified 'Name', and 'Type', or null
.Property.getQualifiers()
public Property getAssociationEnd()
Qualifier
'.
Designates the optional association end that owns a qualifier attribute.
Property.setAssociationEnd(Property)
,
UMLPackage.getProperty_AssociationEnd()
,
Property.getQualifiers()
public void setAssociationEnd(Property value)
Association End
' container reference.
value
- the new value of the 'Association End' container reference.Property.getAssociationEnd()
public boolean validateMultiplicityOfComposite(DiagnosticChain diagnostics, Map context)
public boolean validateSubsettingContextConforms(DiagnosticChain diagnostics, Map context)
public boolean validateRedefinedPropertyInherited(DiagnosticChain diagnostics, Map context)
public boolean validateSubsettingRules(DiagnosticChain diagnostics, Map context)
public boolean validateNavigableReadonly(DiagnosticChain diagnostics, Map context)
public boolean validateDerivedUnionIsDerived(DiagnosticChain diagnostics, Map context)
public boolean validateDerivedUnionIsReadOnly(DiagnosticChain diagnostics, Map context)
public boolean validateSubsettedPropertyNames(DiagnosticChain diagnostics, Map context)
public boolean validateDeploymentTarget(DiagnosticChain diagnostics, Map context)
public boolean validateBindingToAttribute(DiagnosticChain diagnostics, Map context)
public void setIsNavigable(boolean isNavigable)
public Property getOtherEnd()
public void setBooleanDefaultValue(boolean value)
public void setIntegerDefaultValue(int value)
public void setStringDefaultValue(String value)
public void setUnlimitedNaturalDefaultValue(int value)
public void setNullDefaultValue()
public boolean isAttribute(Property p)
public EList subsettingContext()
public boolean isNavigable()
|
Copyright 2003, 2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |