Documentation Language: Swift

AQL

Essentials

Getting Started with AQL
Understanding AQL

Execution

C AQLExecutionContext
- Initializers
  - M init(executionEngine: ECoreExecutionEngine)
- Instance Properties
  - P var debug: Bool
  - P let executionEngine: ECoreExecutionEngine
- Instance Methods

Expressions

Pr AQLExpression
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLNavigationExpression
- Initializers
  - M init(source: any AQLExpression, property: String, isNullSafe: Bool)
- Instance Properties
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLCollectionExpression
- Initializers
  - M init(source: any AQLExpression, operation: Operation, iterator: String?, body: (any AQLExpression)?)
- Instance Properties
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
- Enumerations
  - E AQLCollectionExpression.Operation
    - Enumeration Cases
      - E case any
      - E case collect
      - E case exists
      - E case first
      - E case forAll
      - E case indexOf
      - E case isEmpty
      - E case last
      - E case notEmpty
      - E case reject
      - E case select
      - E case size
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)
S AQLLiteralExpression
- Initializers
  - M init(value: (any EcoreValue)?)
- Instance Properties
  - P let value: (any EcoreValue)?
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLVariableExpression
- Initializers
  - M init(name: String)
- Instance Properties
  - P let name: String
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLLetExpression
- Initializers
  - M init(bindings: [(String, any AQLExpression)], body: any AQLExpression)
- Instance Properties
  - P let bindings: [(String, any AQLExpression)]
  - P let body: any AQLExpression
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?

Structures

S AQLBinaryExpression
- Initializers
  - M init(left: any AQLExpression, op: Operator, right: any AQLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
- Enumerations
  - E AQLBinaryExpression.Operator
    - Enumeration Cases
      - E case add
      - E case and
      - E case divide
      - E case equals
      - E case greaterOrEqual
      - E case greaterThan
      - E case implies
      - E case lessOrEqual
      - E case lessThan
      - E case mod
      - E case multiply
      - E case notEquals
      - E case or
      - E case subtract
      - E case xor
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)
S AQLCallExpression
- Initializers
  - M init(source: (any AQLExpression)?, methodName: String, arguments: [any AQLExpression])
- Instance Properties
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLConditionalExpression
- Initializers
  - M init(condition: any AQLExpression, thenExpression: any AQLExpression, elseExpression: any AQLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLStringInterpolationExpression
- Structures
  - S AQLStringInterpolationExpression.Part
    - Initializers
      - M init(literal: String, expression: (any AQLExpression)?)
- Initializers
  - M init(parts: [Part])
- Instance Properties
  - P let parts: [Part]
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
S AQLUnaryExpression
- Initializers
  - M init(op: Operator, operand: any AQLExpression)
- Instance Properties
  - P let op: Operator
  - P let operand: any AQLExpression
- Instance Methods
  - M func evaluate(in: AQLExecutionContext) async throws -> (any EcoreValue)?
- Enumerations
  - E AQLUnaryExpression.Operator
    - Enumeration Cases
      - E case negate
      - E case not
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)

Enumerations

E AQLExecutionError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties

/

AQL / AQLCollectionExpression

Property

iterator

Optional iterator variable name for operations that need it.

let iterator: String?

Discussion

Used by: select, reject, collect, any, forAll, exists

swift-docc-static by René Hexel