Aggregation Struct Reference


                    
                    
                    FieldType

Field types to count.

Declaration

Swift

public enum FieldType: String


                    
                    
                    FunctionType

Functions used aggregation.

Declaration

Swift

public enum FunctionType: String


                    
                    
                    field

Name of a target field.

Declaration

Swift

public let field: String


                    
                    
                    fieldType

Field type.

Declaration

Swift

public let fieldType: FieldType


                    
                    
                    function

Function type.

Declaration

Swift

public let function: FunctionType


                    
                    
                    makeAggregation(_:field:fieldType:)

Make aggregation.

Throws

‘ThingIFError.invalidArgument` if function and fieldType matches following cases:

Function type is Aggregation.FunctionType.max and field type not is Aggregation.FieldType.integer or Aggregation.FieldType.decimal
Function type is Aggregation.FunctionType.min and field type not is Aggregation.FieldType.integer or Aggregation.FieldType.decimal
Function type is Aggregation.FunctionType.sum and field type not is Aggregation.FieldType.integer or Aggregation.FieldType.decimal
Function type is Aggregation.FunctionType.mean and field type not is Aggregation.FieldType.integer or Aggregation.FieldType.decimal

Declaration

Swift

public static func makeAggregation(
      _ function: FunctionType,
      field: String,
      fieldType: FieldType) throws -> Aggregation

Return Value

An instance of Aggregation.


                    
                    
                    makeCountAggregation(_:fieldType:)

Make aggregation.

Declaration

Swift

public static func makeCountAggregation(
      _ field: String,
      fieldType: FieldType) -> Aggregation

Return Value

An instance of Aggregation for count function.


                    
                    
                    makeMeanAggregation(_:fieldType:)

Make mean aggregation.

Throws

‘ThingIFError.invalidArgument.

If field type not is

Aggregation.FieldType.integer

or

Aggregation.FieldType.decimal`

Declaration

Swift

public static func makeMeanAggregation(
      _ field: String,
      fieldType: FieldType) throws -> Aggregation

Return Value

An instance of Aggregation for mean.


                    
                    
                    makeMaxAggregation(_:fieldType:)

Make max aggregation.

Throws

‘ThingIFError.invalidArgument.

If field type not is

Aggregation.FieldType.integer

or

Aggregation.FieldType.decimal`

Declaration

Swift

public static func makeMaxAggregation(
      _ field: String,
      fieldType: FieldType) throws -> Aggregation

Return Value

An instance of Aggregation for max.


                    
                    
                    makeMinAggregation(_:fieldType:)

Make min aggregation.

Throws

‘ThingIFError.invalidArgument.

If field type not is

Aggregation.FieldType.integer

or

Aggregation.FieldType.decimal`

Declaration

Swift

public static func makeMinAggregation(
      _ field: String,
      fieldType: FieldType) throws -> Aggregation

Return Value

An instance of Aggregation for min.


                    
                    
                    makeSumAggregation(_:fieldType:)

Make sum aggregation.

Throws

‘ThingIFError.invalidArgument.

If field type not is

Aggregation.FieldType.integer

or

Aggregation.FieldType.decimal`

Declaration

Swift

public static func makeSumAggregation(
      _ field: String,
      fieldType: FieldType) throws -> Aggregation

Return Value

An instance of Aggregation for sum.