|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Property
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(java.lang.String name,
Type type,
org.eclipse.emf.ecore.EClass eClass)
Creates a new ValueSpecification , with the specified 'Name', and 'Type', and sets the 'Default Value' containment reference |
Property |
createQualifier(java.lang.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(java.lang.String name,
Type type,
org.eclipse.emf.ecore.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. |
java.lang.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(java.lang.String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list |
Property |
getQualifier(java.lang.String name,
Type type,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass,
boolean createOnDemand)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Qualifier' containment reference list |
org.eclipse.emf.common.util.EList<Property> |
getQualifiers()
Returns the value of the 'Qualifier' containment reference list. |
org.eclipse.emf.common.util.EList<Property> |
getRedefinedProperties()
Returns the value of the 'Redefined Property' reference list. |
Property |
getRedefinedProperty(java.lang.String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Redefined Property' reference list |
Property |
getRedefinedProperty(java.lang.String name,
Type type,
boolean ignoreCase,
org.eclipse.emf.ecore.EClass eClass)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Redefined Property' reference list |
org.eclipse.emf.common.util.EList<Property> |
getSubsettedProperties()
Returns the value of the 'Subsetted Property' reference list. |
Property |
getSubsettedProperty(java.lang.String name,
Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Subsetted Property' reference list |
Property |
getSubsettedProperty(java.lang.String name,
Type type,
boolean ignoreCase,
org.eclipse.emf.ecore.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(java.lang.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(java.lang.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. |
org.eclipse.emf.common.util.EList<Type> |
subsettingContext()
The query subsettingContext() gives the context for subsetting a property. |
void |
unsetDefault()
Unsets the value of the ' Default ' attribute |
boolean |
validateBindingToAttribute(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A binding of a property template parameter representing an attribute must be to an attribute. |
boolean |
validateDeploymentTarget(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> 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(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A derived union is derived. |
boolean |
validateDerivedUnionIsReadOnly(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A derived union is read only. |
boolean |
validateMultiplicityOfComposite(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A multiplicity of a composite aggregation must not have an upper bound greater than 1. |
boolean |
validateNavigableReadonly(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Only a navigable property can be marked as readOnly. |
boolean |
validateRedefinedPropertyInherited(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A redefined property must be inherited from a more general classifier containing the redefining property. |
boolean |
validateSubsettedPropertyNames(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A property may not subset a property with the same name. |
boolean |
validateSubsettingContextConforms(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Subsetting may only occur when the context of the subsetting property conforms to the context of the subsetted property. |
boolean |
validateSubsettingRules(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> 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, createUsage, 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, 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.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, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects |
Methods inherited from interface org.eclipse.uml2.uml.ConnectableElement |
---|
getEnds |
Methods inherited from interface org.eclipse.uml2.uml.TypedElement |
---|
getType, setType |
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 |
Method Detail |
---|
DataType getDatatype()
Owned Attribute
'.
This feature subsets the following features:
The DataType that owns this Property.
setDatatype(DataType)
,
UMLPackage.getProperty_Datatype()
,
DataType.getOwnedAttributes()
void setDatatype(DataType value)
Datatype
' container reference.
value
- the new value of the 'Datatype' container reference.getDatatype()
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.
setIsDerived(boolean)
,
UMLPackage.getProperty_IsDerived()
void setIsDerived(boolean value)
Is Derived
' attribute.
value
- the new value of the 'Is Derived' attribute.isDerived()
boolean isDerivedUnion()
"false"
.
Specifies whether the property is derived as the union of all of the properties that are constrained to subset it.
setIsDerivedUnion(boolean)
,
UMLPackage.getProperty_IsDerivedUnion()
void setIsDerivedUnion(boolean value)
Is Derived Union
' attribute.
value
- the new value of the 'Is Derived Union' attribute.isDerivedUnion()
java.lang.String getDefault()
isSetDefault()
,
unsetDefault()
,
setDefault(String)
,
UMLPackage.getProperty_Default()
void setDefault(java.lang.String value)
Default
' attribute.
value
- the new value of the 'Default' attribute.isSetDefault()
,
unsetDefault()
,
getDefault()
void unsetDefault()
Default
' attribute.
isSetDefault()
,
getDefault()
,
setDefault(String)
boolean isSetDefault()
Default
' attribute is set.
unsetDefault()
,
getDefault()
,
setDefault(String)
AggregationKind getAggregation()
"none"
.
The literals are from the enumeration AggregationKind
.
Specifies the kind of aggregation that applies to the Property.
AggregationKind
,
setAggregation(AggregationKind)
,
UMLPackage.getProperty_Aggregation()
void setAggregation(AggregationKind value)
Aggregation
' attribute.
value
- the new value of the 'Aggregation' attribute.AggregationKind
,
getAggregation()
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.
setIsComposite(boolean)
,
UMLPackage.getProperty_IsComposite()
void setIsComposite(boolean value)
Is Composite
' attribute.
value
- the new value of the 'Is Composite' attribute.isComposite()
Class getClass_()
This feature subsets the following features:
References the Class that owns the Property.
UMLPackage.getProperty_Class()
org.eclipse.emf.common.util.EList<Property> getRedefinedProperties()
Property
.
This feature subsets the following features:
References the properties that are redefined by this property.
UMLPackage.getProperty_RedefinedProperty()
Property getRedefinedProperty(java.lang.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
.getRedefinedProperties()
Property getRedefinedProperty(java.lang.String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.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
.getRedefinedProperties()
Association getOwningAssociation()
Owned End
'.
This feature subsets the following features:
References the owning association of this property, if any.
setOwningAssociation(Association)
,
UMLPackage.getProperty_OwningAssociation()
,
Association.getOwnedEnds()
void setOwningAssociation(Association value)
Owning Association
' container reference.
value
- the new value of the 'Owning Association' container reference.getOwningAssociation()
Association getAssociation()
Member End
'.
References the association of which this property is a member, if any.
setAssociation(Association)
,
UMLPackage.getProperty_Association()
,
Association.getMemberEnds()
void setAssociation(Association value)
Association
' reference.
value
- the new value of the 'Association' reference.getAssociation()
ValueSpecification getDefaultValue()
This feature subsets the following features:
A ValueSpecification that is evaluated to give a default value for the Property when an object of the owning Classifier is instantiated.
setDefaultValue(ValueSpecification)
,
UMLPackage.getProperty_DefaultValue()
void setDefaultValue(ValueSpecification value)
Default Value
' containment reference.
value
- the new value of the 'Default Value' containment reference.getDefaultValue()
ValueSpecification createDefaultValue(java.lang.String name, Type type, org.eclipse.emf.ecore.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
.getDefaultValue()
Property getOpposite()
setOpposite(Property)
,
UMLPackage.getProperty_Opposite()
void setOpposite(Property value)
Opposite
' reference.
value
- the new value of the 'Opposite' reference.getOpposite()
org.eclipse.emf.common.util.EList<Property> getSubsettedProperties()
Property
.
References the properties of which this property is constrained to be a subset.
UMLPackage.getProperty_SubsettedProperty()
Property getSubsettedProperty(java.lang.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
.getSubsettedProperties()
Property getSubsettedProperty(java.lang.String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.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
.getSubsettedProperties()
org.eclipse.emf.common.util.EList<Property> getQualifiers()
Property
.
It is bidirectional and its opposite is 'Association End
'.
This feature subsets the following features:
An optional list of ordered qualifier attributes for the end. If the list is empty, then the Association is not qualified.
UMLPackage.getProperty_Qualifier()
,
getAssociationEnd()
Property createQualifier(java.lang.String name, Type type, org.eclipse.emf.ecore.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
.getQualifiers()
Property createQualifier(java.lang.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
.getQualifiers()
Property getQualifier(java.lang.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
.getQualifiers()
Property getQualifier(java.lang.String name, Type type, boolean ignoreCase, org.eclipse.emf.ecore.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
.getQualifiers()
Property getAssociationEnd()
Qualifier
'.
This feature subsets the following features:
Owner
'
setAssociationEnd(Property)
,
UMLPackage.getProperty_AssociationEnd()
,
getQualifiers()
void setAssociationEnd(Property value)
Association End
' container reference.
value
- the new value of the 'Association End' container reference.getAssociationEnd()
boolean validateMultiplicityOfComposite(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateSubsettingContextConforms(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateRedefinedPropertyInherited(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateSubsettingRules(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateNavigableReadonly(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateDerivedUnionIsDerived(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateDerivedUnionIsReadOnly(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateSubsettedPropertyNames(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateDeploymentTarget(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateBindingToAttribute(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
void setIsNavigable(boolean isNavigable)
isNavigable
- The new navigability.
Property getOtherEnd()
void setBooleanDefaultValue(boolean value)
value
- The new default value.
void setIntegerDefaultValue(int value)
value
- The new default value.
void setStringDefaultValue(java.lang.String value)
value
- The new default value.
void setUnlimitedNaturalDefaultValue(int value)
value
- The new default value.
void setNullDefaultValue()
boolean isAttribute(Property p)
org.eclipse.emf.common.util.EList<Type> subsettingContext()
boolean isNavigable()
|
Copyright 2003, 2007 IBM Corporation and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |