Java API
Table of Contents
Select-Fassade
Select Functions for Property
| Function | Return type | Description |
|---|---|---|
| rangeOrNull | Class | Returns a Property’s range. |
| →ownerOrNull | Class | Returns a Property’s domain. |
| isComposition | boolean | Check if a Property is an Composition. |
| isDecoratingRelation | boolean | Check if a Property is a DecoratingRelation. |
| isSubRelation | boolean | Checks if a Relation extends another Relation. |
| isComposition | boolean | Checks if a Relation is a Composition. |
| superRelations | Set of Relation | Returns the Relations a Relation extends. |
| subRelations | Set of Relations | Returns the that extend a Relation given Relation. |
| rootProperty | Relation | Returns the first Properties of the Set of Properties a Property extends, including itself. |
| rootRelation | Relation | Returns the first Relations of the Set of Relations a Relation extends, including itself. |
| possibleDecoratingTypes | Map ? | ? |
Select Functions for Statement
| Function | Return type | Description |
|---|---|---|
| existsStatement | boolean | ? |
| findNext | Property Set | Returns the successor Statement of a given Statement. |
| nameOf | Attribute Set | Returns the composed simpleName in the form (Subject, Predicate, Object). |
| statementPath | List of Statement | ? |
| decoratedNode | Resource | Returns the Resource that is decorated via this decorating Statement. |
Select Functions for Class
| Function | Return type | Description |
|---|---|---|
| instances | Set of Resource | Returns the direct or indirect instances of a Class. |
| directInstances | Set of Resource | Returns the direct instances of a Class. |
| instancesWithPackage | Set of Resource | Returns the direct or indirect instances of a Class in all Packages. |
| instancesWithMainPackage | Set of Resource | Returns the direct or indirect instances of a Class with their main Package. |
| isTypeOfFilter | Filter on Resource | Returns a Filter which includes Resources of a given Class. |
| resourceBySimpleNameOrNull | Resource with Package | Returns the Instance having a given simple Name. |
| resourcesBySimpleName | Set of Resource with Package | Returns the Instances having a given simple Name. |
| resourceByFullNameOrNull | Resource with Package | Returns the Instance having a given simple Name. |
| resourcesByFullName | Set of Resource with Package | Returns the Instances having a given simple Name. |
| allowedPropertiesOfType | Set of Property | Returns the (inherited or defined) Properties of a Class. |
| allowedPropertiesOfTypeForRead | Set of Property | Returns the (inherited or defined) Properties of a Class,including the overridden Properties. |
| allowedAttributesOfType | Set of Attribute | Returns the (inherited or defined) Attributes of a Class. |
| allowedAttributesOfTypeForRead | Set of Attribute | Returns the (inherited or defined) Attributes of a Class, including the overridden Attributes. |
| allowedRelationsOfType | Set of Attribute | Returns the (inherited or defined) Relations of a Class. |
| allowedRelationsOfTypeForRead | Set of Attribute | Returns the (inherited or defined) Relations of a Class, including overridden Relations. |
| isAbstractClass | boolean | Checks if a Class is abstract. |
| isFinalClass | boolean | Checks if a Class is final. |
| isSubclass | Set of Type | Checks if a Class extends another Class. |
| subclasses | Set of Resource with Package | Returns the Sub-Classes of a given Class. |
| superclasses | Set of Resource with Package | Returns the Super-Classes of a given Class. |
| matchingInstances | Set of Type | ? |
| isMatchingObjectFilter | Filter on Resource | ? |
| matchingSuperTypes | Set of Type | ? |
| matchingSubTypes | Set of Type | ? |
| isMatchingSuperType | boolean | ? |
| rangeToType | Set of Type | ? |
Select Functions for Resource
| Function | Return type | Description |
|---|---|---|
| exists | boolean | ? |
| packages | Relation Set | ? |
| mainPackage | Relation Set | ? |
| asPackagedResource | Resource with Package | Decorate a Resource by its main Package. |
| asPackagedResource | Set of Resource with Package | Decorate a Set of Resources by their main Packages. ? |
| namespace | string | Returns the name of the Packages and owning Resources, concatenated with dot. |
| simpleName | string | Returns the Name of a Resource defined by the NameAspect, or else the GUID. |
| hasName | boolean | Checks if a Resource has a Name, that is it has a NameAspect defined. |
| hasModifiableName | boolean | ERROR |
| fullName | boolean | Returns the Name, predeeded by Package Names and Name of the owner Resources. |
| isOwned | boolean | Checks if a Resource is directly or indirectly owned by another Resource, or it is the same Resource. |
| isRootResource | boolean | Checks if a Resource is not owned by any other Resource. |
| isAllowedPredicate | boolean | ? |
| rootResource | Resource | Returns the owner Resource that directly resides in a Package. |
| rootStatements | Statement | ? |
| directlyOwnedResources | Set of Resource | ? |
| ownStatementOrNull | Statement | Returns the Statement stating that a given Resource is owned by another Resource. |
| decoratedNode | Resource | Returns the Resource being decorated by this Decorator. |
| shallowType | Type | Returns the direct Type of a Resource. |
| isTypeOf | boolean | Check if a Resource is instance of a given Class. |
| toMeRelationsForType | Relation | ? |
| toMeTypes | Set of Type | ? |
| isMatching | boolean | ? |
| matchingTypes | Set of Type | ? |
| allowedProperties | Property Set | Returns the (inherited or defined) Properties of a Resource’s Class. |
| allowedPropertiesForRead | Property Set | Returns the (inherited or defined) Properties of a Resource’s Class,including overridden Properties. |
| allowedAttributes | Attribute Set | Returns the (inherited or defined) Attributes of a Resource’s Class. |
| allowedAttributesForRead | Attribute Set | Returns the (inherited or defined) Attributes of a Resource’s Class, including overridden Attributes. |
| allowedRelations | Relation Set Returns the (inherited or defined) Relations of a Resource’s Class. | |
| allowedRelationsForRead | Relation Set | Returns the (inherited or defined) Relations of a Resource’s Class, including overridden Relations. |
| allowedToMeRelations | Relation Set | Returns the Relations having a Resource’s Class as range. |
Select Functions for Extendable
| Function | Return type | Description |
|---|---|---|
| isAbstractExtendable | boolean | Checks if an Extendable is abstract. |
| isFinalExtendable | boolean | Checks if an Extendable is final. |
| extensions | Set of Extendable | Returns the extending Resources. |
| extendedResource | Set of Extendable | Returns the extended Resources. |
| isExtension | boolean | Check if a Resource extends another Resource. |
Select Functions for (Resource, Property)
| Function | Return type | Description |
|---|---|---|
| attributeStatementOrNull | Statement | ? |
| allowedPropertiesForRead | Property Set | Returns the (inherited or defined) Properties of a Resource’s Class, including overridden Properties. |
| allowedAttributes | Attribute Set | Returns the (inherited or defined) Attributes of a Resource’s Class. |
| allowedAttributesForRead | Attribute Set | Returns the (inherited or defined) Attributes of a Resource’s Class, including overridden Attributes. |
| allowedRelations | Relation Set | Returns the (inherited or defined) Relations of a Resource’s Class. |
| allowedRelationsForRead | Relation Set | Returns the (inherited or defined) Relations of a Resource’s Class, including overridden Relations. |
| allowedToMeRelations | Relation Set | Returns the Relations having a Resource’s Class as range. |
| objectsForAttribute | List of Any | Returns the Objects as result of the Evaluation of a given Attribute on a given Resource |
| objectForAttribute | List of Any | Returns the first Objects as result of the Evaluation of a given Attribute on a given Resource, or else a default. |
| objectForAttributeOrNull | List of Any | Returns the first Objects as result of the Evaluation of a given Attribute on a given Resource. |
| statementForAttributeOrNull | List of Statements | Returns the first Statement on a given Resource for a given Attribute. |
| objectForPropertyOrNull | List of Objects | Returns the first Objects as result of the Evaluation of a given Property on a given Resource. |
| objectMaxCard | int | Returns the maximum allowed count of Statement of a given Relation for a Resource in the Relation’s range. |
| objectMinCard | int | Returns the minimum allowed count of Statement of a given Relation for a Resource in the Relation’s range. |
| attributeMinCard | int | Returns the minimum allowed count of Statement of a given Attribute for a Resource in the Attribute’s domain. |
| attributeMaxCard | int | Returns the minimum allowed count of Statement of a given Attribute for a Resource in the Attribute’s domain. |
| subjectMinCard | int | Returns the minimum allowed count of Statement of a given Relation for a Resource in the Property’s domain. |
| subjectMaxCard | int | Returns the minimum allowed count of Statement of a given Relation for a Resource in the Property’s domain. |
| objectForAttributeOrNull | List of Literal | Returns the first Objects as result of the Evaluation of a given Attribute on a given Resource. |
| valueForAttributeOrNull | string | Returns the string value of the first Object as result of the Evaluation of a given Attribute on a given Resource. |
| valueForBooleanAttribute | boolean | Returns the string value of the first Object as result of the Evaluation of a given Attribute on a given Resource, or a default value. |
| objectForRelationOrNull | List of Resource | Returns the first Objects as result of the Evaluation of a given Relation on a given Resource. |
| objectsForRelation | List of Resource | Returns the Objects as result of the Evaluation of a given Relation on a given Resource. |
| objectsForRelationOfType | List of Resource | Returns the Objects as result of the Evaluation of a given Relation on a given Resource, having a given Type. |
| ownerOrNull | Resource | Returns a Resource’s owner Resource. |
| relationStatementOrNull | Statement | ? |
| statementOrNull | Statement | Returns the Statement with given Subject, Predicate and Object. |
| statement | Set of Statement | Returns the Statements with given Subject. |
| statementsForAttribute | Set of Statement | Returns the Statements with Subject and Predicate given by Resource and Attribute. |
| statementsForRelation | Set of Statement | Returns the Statements with Subject and Predicate given by Resource and Relation. |
| statementForRelationOrNull | Set of Statement | Returns the first Statement with Subject and Predicate given by Resource and Relation. |
| subjectForRelationOrNull | Set of Object | Returns the first Subject with Statement and Predicate given by Resource and Relation. |
| subjectsForRelation | Set of Statement | Returns the Subjects with Object and Predicate given by Resource and Relation. |
| toMeStatementForRelationOrNull | Set of Statement | Returns the first Statement with Object and Predicate given by Resource and Relation. |
| toMeStatementsForAttribute | Set of Statement | Returns the Statements with Object and Predicate given by Resource and Attribute. |
| toMeStatementsForRelation | Set of Statement | Returns the Statements with Object and Predicate given by Resource and Relation. |
| toMeStatements | Set of Statement | Returns the first Statement with given Object. |
| treeSelectObjects | Set of Object | Calculates the closure for given Resource and Relation. ?? |
| topoSelectObjects | Set of Object | ? |
| treeSelectSubjects | Set of Object | ? |
| decoratableNodes | Set of Resource | ? |
Select Functions for Package
| Function | Return type | Description |
|---|---|---|
| allReferencedPackages | Package | ? |
| allStatements | Set of Statement | Returns all the Statements in a Package. |
| allRequiredScopes | Set of Statement | ? |
| allAvailableRequiredScopes | Set of Resource Scope | ? |
| resourceByNameOrNull | Resource | Returns the Resource in the Package having a given simple Name. |
Select Functions for Resource Scope
| Function | Return type | Description |
|---|---|---|
| getScope | Resource Scope | Returns the Scope. |
| isRequired | Set of Resource Scope | ? |
| allResourcesInScope | Unordered Set of Resource | Returns all Resources reachable from a given Resource Scope. |
| allReferencedResourcesInScope | Unordered Set of Resource | ? |
| classByName | Java class | Loads a Java class of given name. |
| classByNameOrNull | Java class | Loads a Java class of given name. |
| packagesInScope | Set of Package | ? |
| unreferencedResource | Set of Resource with Package | ? |
| types | Set of Class | Returns the direct and indirect Types of a Resource. |
Additional Select Functions
| Function | Return type | Description |
|---|---|---|
| getScope | Resource Scope | Returns the Scope. |
| getRequiredScopes | Set of Resource Scope | ? |
| allRequiredScopes | Set of Resource Scope | ? |
| allAvailableRequiredScopes | Set of Resource Scope | ? |
| isRequired | Set of Resource Scope | ? |
| allResources | Unordered Set of Resource | Returns all Resources in Scope. |
| allResourcesInPackage | Unordered Set of Resource | Unordered Set of Resource |
| allResourcesInPackage2 | Unordered Set of Resource with Package | Returns all Resources in a Package. |
| allResourcesInPackages2 | Unordered Set of Resource with Package | Returns all Resources in a List of Packages. |
| allRootResourcesInPackage | Unordered Set of Resource | Returns all Resources residing directly in a Package. |
| allStatements | Set of Statement Returns all Statements. | |
| resourceBySimpleNameOrNull | Resource with Package | Returns the Resource having a given simple Name. |
| resourcesBySimpleName | Set of Resource with Package | Returns the Resource having a given simple Name. |
| resourceByFullNameOrNull | Resource with Package | Returns the Resource having a given full Name. |
| resourcesByFullName | Set of Resource with Package | Returns the Resource having a given full Name. |
| packagesByName | Set of Package | Returns the Packages having a given Name. |
| subPackagesByName | Set of Package | Returns the Packages having a given Name, including the Sub-Packages. |
| packagesByExpressions | Iterable of Package | ? |
| allPackages | Iterable of Package | ? |