org.eclipse.uml2
Interface DataType

All Superinterfaces:
Classifier, Element, EModelElement, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, TemplateableElement, Type
All Known Subinterfaces:
Enumeration, PrimitiveType

public interface DataType
extends Classifier

A representation of the model object 'Data Type'. DataType defines a kind of classifier in which operations are all pure functions (i.e., they can return data values but they cannot change data values, because they have no identity). For example, an �add� operation on a number with another number as an argument yields a third number as a result; the target and argument are unchanged. A DataType may also contain attributes to support the modeling of structured data types.

The following features are supported:

See Also:
UML2Package.getDataType()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Property createOwnedAttribute()
          Creates a Property and appends it to the 'Owned Attribute' containment reference list
 Property createOwnedAttribute(EClass eClass)
          Creates a Property and appends it to the 'Owned Attribute' containment reference list
 Property createOwnedAttribute(java.lang.String name, Type type, int lowerBound, int upperBound)
          Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this data type.
 Operation createOwnedOperation()
          Creates a Operation and appends it to the 'Owned Operation' containment reference list
 Operation createOwnedOperation(EClass eClass)
          Deprecated. Use #createOwnedOperation() instead.
 Operation createOwnedOperation(java.lang.String name, Type returnType, java.lang.String[] parameterNames, Type[] parameterTypes)
          Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this data type.
 Property getOwnedAttribute(java.lang.String name)
          Retrieves the Property with the specified 'Name' from the 'Owned Attribute' containment reference list
 EList getOwnedAttributes()
          Returns the value of the 'Owned Attribute' containment reference list.
 Operation getOwnedOperation(java.lang.String name)
          Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list
 EList getOwnedOperations()
          Returns the value of the 'Owned Operation' containment reference list.
 
Methods inherited from interface org.eclipse.uml2.Classifier
allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createGeneralization, createOccurrence, createOccurrence, createOwnedUseCase, createOwnedUseCase, createSubstitution, createSubstitution, general, getAttribute, getAttributes, getFeature, getFeatures, getGeneral, getGeneralizations, getGenerals, getInheritedMember, getInheritedMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, inheritedMember, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType
 
Methods inherited from interface org.eclipse.uml2.Namespace
createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable
 
Methods inherited from interface org.eclipse.uml2.NamedElement
allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature
 
Methods inherited from interface org.eclipse.uml2.Element
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf
 
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.Type
conformsTo, createAssociation, getPackage
 
Methods inherited from interface org.eclipse.uml2.PackageableElement
getPackageableElement_visibility, setPackageableElement_visibility
 
Methods inherited from interface org.eclipse.uml2.ParameterableElement
getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.uml2.RedefinableElement
getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 

Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getOwnedAttributes

public EList getOwnedAttributes()
Returns the value of the 'Owned Attribute' containment reference list. The list contents are of type Property. It is bidirectional and its opposite is 'Datatype'.

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

The Attributes owned by the DataType. Subsets Classifier::attribute and Element:: ownedMember.

Returns:
the value of the 'Owned Attribute' containment reference list.
See Also:
UML2Package.getDataType_OwnedAttribute(), Property.getDatatype()

getOwnedAttribute

public Property getOwnedAttribute(java.lang.String name)
Retrieves the Property with the specified 'Name' from the 'Owned Attribute' containment reference list.

Parameters:
name - The 'Name' of the Property to retrieve.
Returns:
The Property with the specified 'Name', or null.
See Also:
getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute(EClass eClass)
Creates a Property and appends it to the 'Owned Attribute' containment reference list.

Parameters:
eClass - The Ecore class of the Property to create.
Returns:
The new Property.
See Also:
getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute()
Creates a Property and appends it to the 'Owned Attribute' containment reference list.

Returns:
The new Property.
See Also:
getOwnedAttributes()

getOwnedOperations

public EList getOwnedOperations()
Returns the value of the 'Owned Operation' containment reference list. The list contents are of type Operation. It is bidirectional and its opposite is 'Datatype'.

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

The Operations owned by the DataType. Subsets Classifier::feature and Element:: ownedMember.

Returns:
the value of the 'Owned Operation' containment reference list.
See Also:
UML2Package.getDataType_OwnedOperation(), Operation.getDatatype()

getOwnedOperation

public Operation getOwnedOperation(java.lang.String name)
Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list.

Parameters:
name - The 'Name' of the Operation to retrieve.
Returns:
The Operation with the specified 'Name', or null.
See Also:
getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation(EClass eClass)
Deprecated. Use #createOwnedOperation() instead.

Creates a Operation and appends it to the 'Owned Operation' containment reference list.

Parameters:
eClass - The Ecore class of the Operation to create.
Returns:
The new Operation.
See Also:
getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation()
Creates a Operation and appends it to the 'Owned Operation' containment reference list.

Returns:
The new Operation.
See Also:
getOwnedOperations()

createOwnedAttribute

public Property createOwnedAttribute(java.lang.String name,
                                     Type type,
                                     int lowerBound,
                                     int upperBound)
Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this data type.

Parameters:
name - The name for the owned attribute.
type - The type for the owned attribute.
lowerBound - The lower bound for the owned attribute.
upperBound - The upper bound for the owned attribute.
Returns:
The new property.
Throws:
java.lang.IllegalArgumentException - If either of the bounds is invalid.

createOwnedOperation

public Operation createOwnedOperation(java.lang.String name,
                                      Type returnType,
                                      java.lang.String[] parameterNames,
                                      Type[] parameterTypes)
Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this data type.

Parameters:
name - The name for the owned operation.
returnType - The return type for the owned operation, or null.
parameterNames - The names of the owned operation's parameters, or null.
parameterTypes - The types of the owned operation's parameters, or null.
Returns:
The new operation.
Throws:
java.lang.IllegalArgumentException - If the number of parameter names does not match the number of parameter types.

Copyright 2003, 2005 IBM Corporation and others.
All Rights Reserved.