QueryOperator

open class QueryOperator : ObjectBase

Represents a OData query operator. Query operators are typically used within DataQuery.filter. QueryOperatorCall can be constructed using static calls on QueryOperator or, more conveniently, by chained calls on QueryValue.

Example using proxy classes (with QueryOperator static calls)

open func queryOperatorExample() throws -> Void {
    let service = self.service
    let query = DataQuery()
        .filter(QueryOperator.greaterEqual(QueryOperator.multiply(OrderDetail.quantity,
            OrderDetail.unitPrice),
            DecimalValue.of(DecimalFunction.fromInt(1000))))
    let details = try service.fetchOrderDetails(matching: query)
    self.showDetails(details)
}

Example using proxy classes (with QueryValue chained calls)

open func queryValueOperatorExample() throws -> Void {
    let service = self.service
    let query = DataQuery()
        .filter(OrderDetail.quantity.multiply(OrderDetail.unitPrice)
            .greaterEqual(BigDecimal(1000)))
    // Alternate syntax using overloaded operators:
    // let query = DataQuery().filter(OrderDetail.quantity * OrderDetail.unitPrice >= 1000)
    let details = try service.fetchOrderDetails(matching: query)
    self.showDetails(details)
}

operatorMap
A map of predefined query operators.
Declaration
Swift

public static let operatorMap: QueryOperatorMap
init()
Default initializer.
Declaration
Swift

override public init()


                      
                      
                      add(_:_:)

Declaration

Swift

open class func add(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘add’ arithmetic operator.


                      
                      
                      all(_:lambda:match:)

Example using proxy classes

open func allOperatorExample() throws -> Void {
    let service = self.service
    let p = DataPath.lambda("p")
    let query = DataQuery()
        .filter(Category.products.all(p,
            QueryOperator.greaterThan(p.path(Product.unitPrice), DecimalValue.of(BigDecimal(1)))))
    let categories = try service.fetchCategories(matching: query)
    assert(categories.count != 0)
}

Example using dynamic API

open func allOperatorExample() throws -> Void {
    let service = self.service
    let categoriesEntitySet = service.entitySet(withName: "Categories")
    let categoryEntityType = categoriesEntitySet.entityType
    let productsProperty = categoryEntityType.property(withName: "Products")
    let productsEntitySet = service.entitySet(withName: "Products")
    let productEntityType = productsEntitySet.entityType
    let unitPriceProperty = productEntityType.property(withName: "UnitPrice")
    let p = DataPath.lambda("p")
    let query = DataQuery().from(categoriesEntitySet)
        .filter(productsProperty.all(p,
            QueryOperator.greaterThan(p.path(unitPriceProperty), DecimalValue.of(BigDecimal(1)))))
    let categories = try service.executeQuery(query).entityList()
    assert(categories.length != 0)
}

Declaration

Swift

open class func all(_ value: DataValue, lambda: DataPath, match: QueryFilter) -> QueryFilter

Parameters

`value`	Collection value.
`lambda`	Lambda variable.
`match`	Query filter.

Return Value

a deferred call of the OData ‘all’ lambda operator.


                      
                      
                      and(_:_:)

Declaration

Swift

open class func and(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘and’ logical operator.


                      
                      
                      any(_:lambda:match:)

Example using proxy classes

open func anyOperatorExample() throws -> Void {
    let service = self.service
    let p = DataPath.lambda("p")
    let query = DataQuery()
        .filter(Category.products.any(p,
            QueryOperator.greaterThan(p.path(Product.unitPrice), DecimalValue.of(BigDecimal(20)))))
    let categories = try service.fetchCategories(matching: query)
    assert(categories.count != 0)
}

Example using dynamic API

open func anyOperatorExample() throws -> Void {
    let service = self.service
    let categoriesEntitySet = service.entitySet(withName: "Categories")
    let categoryEntityType = categoriesEntitySet.entityType
    let productsProperty = categoryEntityType.property(withName: "Products")
    let productsEntitySet = service.entitySet(withName: "Products")
    let productEntityType = productsEntitySet.entityType
    let unitPriceProperty = productEntityType.property(withName: "UnitPrice")
    let p = DataPath.lambda("p")
    let query = DataQuery().from(categoriesEntitySet)
        .filter(productsProperty.any(p,
            QueryOperator.greaterThan(p.path(unitPriceProperty), DecimalValue.of(BigDecimal(20)))))
    let categories = try service.executeQuery(query).entityList()
    assert(categories.length != 0)
}

Declaration

Swift

open class func any(_ value: DataValue, lambda: DataPath, match: QueryFilter) -> QueryFilter

Parameters

`value`	Collection value.
`lambda`	Lambda variable.
`match`	Query filter.

Return Value

a deferred call of the OData ‘any’ lambda operator.


                      
                      
                      arity

Operator arity (number of arguments).

Declaration

Swift

@inline(__always)
public final var arity: Int { get }


                      
                      
                      code

Operator code.

Declaration

Swift

@inline(__always)
public final var code: Int { get }


                      
                      
                      divide(_:_:)

Declaration

Swift

open class func divide(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘div’ arithmetic operator.


                      
                      
                      divideBy(_:_:)

Declaration

Swift

open class func divideBy(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘divBy’ arithmetic operator.


                      
                      
                      equal(_:_:)

Declaration

Swift

open class func equal(_ left: DataValue?, _ right: DataValue?) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘eq’ logical operator.


                      
                      
                      forCode(_:)

Lookup a query operator by code.

Declaration

Swift

open class func forCode(_ code: Int) -> QueryOperator

Parameters


                                  code

Operator code.

Return Value

Query operator.


                      
                      
                      forName(_:)

Lookup a query operator by code.

Throws

DataQueryException if name is not the name of a known query operator.

Declaration

Swift

open class func forName(_ name: String) throws -> QueryOperator

Parameters


                                  name

Operator name.

Return Value

Query operator.


                      
                      
                      greaterEqual(_:_:)

Declaration

Swift

open class func greaterEqual(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘ge’ logical operator.


                      
                      
                      greaterThan(_:_:)

Declaration

Swift

open class func greaterThan(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘gt’ logical operator.


                      
                      
                      hasFlags(_:_:)

Declaration

Swift

open class func hasFlags(_ value: DataValue, _ flags: EnumValue) -> QueryFilter

Parameters

`value`	Enum value to be tested to see if `flag` is set.
`flags`	Flag(s) to test for.

Return Value

a deferred call of the OData ‘has’ operator.


                      
                      
                      inList(_:_:)

Declaration

Swift

open class func inList(_ value: DataValue, _ list: DataValue) -> QueryFilter

Parameters

`value`	Item value to check for membership in list.
`list`	List to check membership within (e.g. a `StringList`).

Return Value

a deferred call of the OData ‘in’ operator.


                      
                      
                      isMember(_:_:)

Declaration

Swift

open class func isMember(_ value: DataValue, _ name: String) -> QueryFilter

Parameters

`value`	Enum value to be tested to see if it matches an enum member with symbolic name `name`. Should normally be an instance of `Property`.
`name`	Name of member to match.

Return Value

a deferred call of the custom ‘is’ operator.


                      
                      
                      isValue(_:_:)

Declaration

Swift

open class func isValue(_ value: DataValue, _ match: DataValue) -> QueryFilter

Parameters

`value`	Data value to be tested.
`match`	Value to be matched, using string-based matching.

Return Value

a deferred call of the custom ‘is’ operator.


                      
                      
                      lessEqual(_:_:)

Declaration

Swift

open class func lessEqual(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘le’ logical operator.


                      
                      
                      lessThan(_:_:)

Declaration

Swift

open class func lessThan(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘lt’ logical operator.

method
Operator method, e.g. target language method.
Declaration
Swift

@inline(__always) public final var method: String { get }


                      
                      
                      modulo(_:_:)

Declaration

Swift

open class func modulo(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘mod’ arithmetic operator.


                      
                      
                      multiply(_:_:)

Declaration

Swift

open class func multiply(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘mul’ arithmetic operator.


                      
                      
                      name

Operator name, e.g. OData name.

Declaration

Swift

@inline(__always)
public final var name: String { get }


                      
                      
                      negate(_:)

Declaration

Swift

open class func negate(_ value: DataValue) -> QueryValue

Parameters


                                  value

Numeric value.

Return Value

a deferred call of the OData ‘-’ arithmetic operator.


                      
                      
                      not(_:)

Declaration

Swift

open class func not(_ value: DataValue) -> QueryFilter

Parameters


                                  value

Logical value.

Return Value

a deferred call of the OData ‘not’ logical operator.


                      
                      
                      notEqual(_:_:)

Declaration

Swift

open class func notEqual(_ left: DataValue?, _ right: DataValue?) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘ne’ logical operator.


                      
                      
                      or(_:_:)

Declaration

Swift

open class func or(_ left: DataValue, _ right: DataValue) -> QueryFilter

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘or’ logical operator.


                      
                      
                      priority

Operator priority.

Declaration

Swift

@inline(__always)
public final var priority: Int { get }


                      
                      
                      subtract(_:_:)

Declaration

Swift

open class func subtract(_ left: DataValue, _ right: DataValue) -> QueryValue

Parameters

`left`	Left operand.
`right`	Right operand.

Return Value

a deferred call of the OData ‘sub’ arithmetic operator.

toString()
Declaration
Swift

override open func toString() -> String
Return Value

A string representation of this object.