org.eclipse.ocl.examples.domain.elements
Interface DomainStandardLibrary

All Known Implementing Classes:

AbstractStandardLibrary, ExecutableStandardLibrary, ExecutorStandardLibrary, MetaModelManager, PivotExecutorStandardLibrary, PivotStandardLibrary, TypeManager

public interface DomainStandardLibrary

A representation of the OCL Standard Library, which is the set of singleton instances of the OCL-defined metatypes, including the generic collection types (e.g., Set(T)).

Method Summary

boolean	conformsToCollectionType(DomainCollectionType firstCollectionType, DomainCollectionType secondCollectionType)
boolean	conformsToLambdaType(DomainLambdaType firstLambdaType, DomainLambdaType secondLambdaType)
boolean	conformsToTupleType(DomainTupleType firstTupleType, DomainTupleType secondTupleType)
java.lang.Iterable<? extends DomainPackage>	getAllPackages()
DomainType	getBagType() Obtains the generic instance of the BagType metatype, named Bag(T).
DomainCollectionType	getBagType(DomainType elementType, IntegerValue lower, IntegerValue upper) Return the instance of the Bag metatype whose elements are of elementType.
DomainType	getBooleanType() Obtains the instance of the PrimitiveType metatype, named Boolean.
DomainType	getCollectionType() Obtains the generic instance of the CollectionType metatype, named Collection(T).
DomainCollectionType	getCollectionType(DomainType containerType, DomainType elementType, IntegerValue lower, IntegerValue upper) Return the specialized collection type for the containerType for elementType.
DomainEnumeration	getEnumeration(org.eclipse.emf.common.util.Enumerator enumerator) Return the enumeration for a given enumerator.
DomainType	getEnumerationType() Obtains the single instance of the EnumerationType metatype, named Enumeration.
DomainInheritance	getInheritance(DomainType type) Return the Inheritance dispatch table for a given type.
DomainType	getIntegerType() Obtains the instance of the PrimitiveType metatype, named Integer.
DomainMetaclass	getMetaclass(DomainType classType) Return the instance of the Metaclass metatype whose class is classType.
DomainType	getMetaclassType() Obtains the single instance of the DomainMetaclass metatype, named Metaclass.
DomainType	getMetaType(DomainType type) Returns the meta-type of a given type.
DomainPackage	getNestedPackage(DomainPackage parentPackage, java.lang.String name)
DomainType	getNestedType(DomainPackage parentPackage, java.lang.String name)
DomainPackage	getNsURIPackage(java.lang.String nsURI)
DomainType	getOclAnyType() Obtains the single instance of the AnyType metatype, named OclAny.
DomainType	getOclComparableType() Obtains the single instance of the OclComparable metatype, named OclAny.
DomainType	getOclElementType() Obtains the single instance of the Class metatype, named OclElement.
DomainType	getOclInvalidType() Obtains the single instance of the InvalidType metatype, named OclInvalid.
DomainType	getOclMessageType() Obtains the generic instance of the MessageType metatype, named OclMessage.
DomainType	getOclSelfType() Obtains the single instance of the OclSelf pseudo-metatype, named OclSelf.
DomainType	getOclSummableType() Obtains the single instance of the OclSummable metatype, named OclAny.
DomainType	getOclTupleType() Obtains the single instance of the OclTupleType metatype, named OclVoid.
DomainType	getOclType(java.lang.String typeName)
DomainType	getOclVoidType() Obtains the single instance of the VoidType metatype, named OclVoid.
DomainElement	getOperationTemplateParameter(DomainOperation anOperation, int index)
DomainType	getOrderedCollectionType() Obtains the generic instance of the OrderedCollection metatype, named OrderedCollection(T).
DomainType	getOrderedSetType() Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).
DomainCollectionType	getOrderedSetType(DomainType elementType, IntegerValue lower, IntegerValue upper) Return the instance of the OrderedSet metatype whose elements are of elementType.
DomainType	getPrimitiveType(PrimitiveTypeId id)
DomainType	getRealType() Obtains the instance of the PrimitiveType metatype, named Real.
DomainPackage	getRootPackage(java.lang.String name)
DomainType	getSequenceType() Obtains the generic instance of the SequenceType metatype, named Sequence(T).
DomainCollectionType	getSequenceType(DomainType elementType, IntegerValue lower, IntegerValue upper) Return the instance of the Sequence metatype whose elements are of elementType.
DomainType	getSetType() Obtains the generic instance of the SetType metatype, named Set(T).
DomainCollectionType	getSetType(DomainType elementType, IntegerValue lower, IntegerValue upper) Return the instance of the Set metatype whose elements are of elementType.
DomainType	getStringType() Obtains the instance of the PrimitiveType metatype, named String.
DomainType	getUniqueCollectionType() Obtains the generic instance of the UniqueCollection metatype, named Set(T).
DomainType	getUnlimitedNaturalType() Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.
boolean	isEqualToCollectionType(DomainCollectionType firstCollectionType, DomainCollectionType secondCollectionType)
boolean	isEqualToTupleType(DomainTupleType firstTupleType, DomainTupleType secondTupleType)

Method Detail

conformsToCollectionType

boolean conformsToCollectionType(@NonNull
                                 DomainCollectionType firstCollectionType,
                                 @NonNull
                                 DomainCollectionType secondCollectionType)

conformsToLambdaType

boolean conformsToLambdaType(@NonNull
                             DomainLambdaType firstLambdaType,
                             @NonNull
                             DomainLambdaType secondLambdaType)

conformsToTupleType

boolean conformsToTupleType(@NonNull
                            DomainTupleType firstTupleType,
                            @NonNull
                            DomainTupleType secondTupleType)

getAllPackages

@NonNull
java.lang.Iterable<? extends DomainPackage> getAllPackages()

getBagType

@NonNull
DomainType getBagType()

Obtains the generic instance of the BagType metatype, named Bag(T).

Returns:

the Bag(T) type (an instance of BagType)

getBagType

@NonNull
DomainCollectionType getBagType(@NonNull
                                        DomainType elementType,
                                        @Nullable
                                        IntegerValue lower,
                                        @Nullable
                                        IntegerValue upper)

Return the instance of the Bag metatype whose elements are of elementType.

getBooleanType

@NonNull
DomainType getBooleanType()

Obtains the instance of the PrimitiveType metatype, named Boolean.

Returns:

the Boolean type (an instance of PrimitiveType)

getCollectionType

@NonNull
DomainType getCollectionType()

Obtains the generic instance of the CollectionType metatype, named Collection(T).

Returns:

the Collection(T) type (an instance of CollectionType)

getCollectionType

@NonNull
DomainCollectionType getCollectionType(@NonNull
                                               DomainType containerType,
                                               @NonNull
                                               DomainType elementType,
                                               @Nullable
                                               IntegerValue lower,
                                               @Nullable
                                               IntegerValue upper)

Return the specialized collection type for the containerType for elementType.

getEnumeration

DomainEnumeration getEnumeration(@NonNull
                                 org.eclipse.emf.common.util.Enumerator enumerator)

Return the enumeration for a given enumerator.

getEnumerationType

@NonNull
DomainType getEnumerationType()

Obtains the single instance of the EnumerationType metatype, named Enumeration.

Returns:

the Enumeration type (an instance of Enumeration)

getInheritance

@NonNull
DomainInheritance getInheritance(@NonNull
                                         DomainType type)

Return the Inheritance dispatch table for a given type.

getIntegerType

@NonNull
DomainType getIntegerType()

Obtains the instance of the PrimitiveType metatype, named Integer.

Returns:

the Integer type (an instance of PrimitiveType)

getMetaclass

@NonNull
DomainMetaclass getMetaclass(@NonNull
                                     DomainType classType)

Return the instance of the Metaclass metatype whose class is classType.

getMetaclassType

@NonNull
DomainType getMetaclassType()

Obtains the single instance of the DomainMetaclass metatype, named Metaclass.

Returns:

the Metaclass type (an instance of Metaclass)

getMetaType

DomainType getMetaType(@NonNull
                       DomainType type)

Returns the meta-type of a given type.

getNestedPackage

DomainPackage getNestedPackage(@NonNull
                               DomainPackage parentPackage,
                               @NonNull
                               java.lang.String name)

getNestedType

DomainType getNestedType(@NonNull
                         DomainPackage parentPackage,
                         @NonNull
                         java.lang.String name)

getNsURIPackage

DomainPackage getNsURIPackage(@NonNull
                              java.lang.String nsURI)

getOclAnyType

@NonNull
DomainType getOclAnyType()

Obtains the single instance of the AnyType metatype, named OclAny.

Returns:

the OclAny type (an instance of AnyType)

getOclComparableType

@NonNull
DomainType getOclComparableType()

Obtains the single instance of the OclComparable metatype, named OclAny.

Returns:

the OclAny type (an instance of Class)

getOclElementType

@NonNull
DomainType getOclElementType()

Obtains the single instance of the Class metatype, named OclElement.

Returns:

the OclElement type (an instance of Class)

getOclInvalidType

@NonNull
DomainType getOclInvalidType()

Obtains the single instance of the InvalidType metatype, named OclInvalid.

Returns:

the OclInvalid type (an instance of InvalidType)

getOclMessageType

DomainType getOclMessageType()

Obtains the generic instance of the MessageType metatype, named OclMessage.

Returns:

the OclMessage type (an instance of MessageType)

getOclSelfType

@NonNull
DomainType getOclSelfType()

Obtains the single instance of the OclSelf pseudo-metatype, named OclSelf.

Returns:

the OclSelf type (an instance of SelfType)

getOclSummableType

@NonNull
DomainType getOclSummableType()

Obtains the single instance of the OclSummable metatype, named OclAny.

Returns:

the OclAny type (an instance of Class)

getOclTupleType

@NonNull
DomainType getOclTupleType()

Obtains the single instance of the OclTupleType metatype, named OclVoid.

Returns:

the OclTuple type (an instance of Class)

getOclType

DomainType getOclType(@NonNull
                      java.lang.String typeName)

getOclVoidType

@NonNull
DomainType getOclVoidType()

Obtains the single instance of the VoidType metatype, named OclVoid.

Returns:

the OclVoid type (an instance of VoidType)

getOperationTemplateParameter

DomainElement getOperationTemplateParameter(@NonNull
                                            DomainOperation anOperation,
                                            int index)

getOrderedCollectionType

@NonNull
DomainType getOrderedCollectionType()

Obtains the generic instance of the OrderedCollection metatype, named OrderedCollection(T).

Returns:

the OrderedCollection(T) type (an instance of CollectionType)

getOrderedSetType

@NonNull
DomainType getOrderedSetType()

Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).

Returns:

the OrderedSet(T) type (an instance of OrderedSetType)

getOrderedSetType

@NonNull
DomainCollectionType getOrderedSetType(@NonNull
                                               DomainType elementType,
                                               @Nullable
                                               IntegerValue lower,
                                               @Nullable
                                               IntegerValue upper)

Return the instance of the OrderedSet metatype whose elements are of elementType.

getPrimitiveType

DomainType getPrimitiveType(@NonNull
                            PrimitiveTypeId id)

getRealType

@NonNull
DomainType getRealType()

Obtains the instance of the PrimitiveType metatype, named Real.

Returns:

the Real type (an instance of PrimitiveType)

getRootPackage

DomainPackage getRootPackage(@NonNull
                             java.lang.String name)

getSequenceType

@NonNull
DomainType getSequenceType()

Obtains the generic instance of the SequenceType metatype, named Sequence(T).

Returns:

the Sequence(T) type (an instance of SequenceType)

getSequenceType

@NonNull
DomainCollectionType getSequenceType(@NonNull
                                             DomainType elementType,
                                             @Nullable
                                             IntegerValue lower,
                                             @Nullable
                                             IntegerValue upper)

Return the instance of the Sequence metatype whose elements are of elementType.

getSetType

@NonNull
DomainType getSetType()

Obtains the generic instance of the SetType metatype, named Set(T).

Returns:

the Set(T) type (an instance of SetType)

getSetType

@NonNull
DomainCollectionType getSetType(@NonNull
                                        DomainType elementType,
                                        @Nullable
                                        IntegerValue lower,
                                        @Nullable
                                        IntegerValue upper)

Return the instance of the Set metatype whose elements are of elementType.

getStringType

@NonNull
DomainType getStringType()

Obtains the instance of the PrimitiveType metatype, named String.

Returns:

the String type (an instance of PrimitiveType)

getUniqueCollectionType

@NonNull
DomainType getUniqueCollectionType()

Obtains the generic instance of the UniqueCollection metatype, named Set(T).

Returns:

the Set(T) type (an instance of CollectionType)

getUnlimitedNaturalType

@NonNull
DomainType getUnlimitedNaturalType()

Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.

Returns:

the UnlimitedNatural type (an instance of PrimitiveType)

isEqualToCollectionType

boolean isEqualToCollectionType(@NonNull
                                DomainCollectionType firstCollectionType,
                                @NonNull
                                DomainCollectionType secondCollectionType)

isEqualToTupleType

boolean isEqualToTupleType(@NonNull
                           DomainTupleType firstTupleType,
                           @NonNull
                           DomainTupleType secondTupleType)