# Uses of Class org.deidentifier.arx.aggregates.AggregateFunction (ARX GUI Documentation)

## Uses of Class
org.deidentifier.arx.aggregates.AggregateFunction

- Packages that use AggregateFunction
  Package | Description
  --- | ---
  org.deidentifier.arx.aggregates | This package provides methods for aggregating data.
  org.deidentifier.arx.gui.view.impl.wizard |

- - ### Uses of AggregateFunction in org.deidentifier.arx.aggregates

    Subclasses of AggregateFunction in org.deidentifier.arx.aggregates
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `AggregateFunction.AggregateFunctionWithParameter<T>` An aggregate function that has a parameter.
    `static class` | `AggregateFunction.GenericArithmeticMean<T>` An aggregate function that returns the arithmetic mean, if it may be computed, "NULL" otherwise.
    `static class` | `AggregateFunction.GenericArithmeticMeanOfBounds<T>` An aggregate function that returns the arithmetic mean of min & max, if it may be computed, "NULL" otherwise.
    `static class` | `AggregateFunction.GenericBounds<T>` An aggregate function that returns an interval consisting of the first and the last element following the predefined order .
    `static class` | `AggregateFunction.GenericCommonPrefix<T>` An aggregate function that returns a common prefix.
    `static class` | `AggregateFunction.GenericConstant<T>` An aggregate function that returns a constant value.
    `static class` | `AggregateFunction.GenericGeometricMean<T>` An aggregate function that returns the geometric mean, if it may be computed, "NULL" otherwise.
    `static class` | `AggregateFunction.GenericGeometricMeanOfBounds<T>` An aggregate function that returns the geometric mean of min & max, if it may be computed, "NULL" otherwise.
    `static class` | `AggregateFunction.GenericInterval<T>` An aggregate function that returns an interval [min, max] .
    `static class` | `AggregateFunction.GenericSet<T>` An aggregate function that returns a set of all data values.
    `static class` | `AggregateFunction.GenericSetOfPrefixes<T>` An aggregate function that returns a set of the prefixes of the data values.

    Fields in org.deidentifier.arx.aggregates declared as AggregateFunction
    Modifier and Type | Field and Description
    --- | ---
    `protected AggregateFunction<T>` | HierarchyBuilderGroupingBased.`function` The default aggregate function, might be null.

    Methods in org.deidentifier.arx.aggregates that return AggregateFunction
    Modifier and Type | Method and Description
    --- | ---
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createArithmeticMeanFunction()` An aggregate function that returns a the arithmetic mean, if it can be computed, NULL otherwise.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createArithmeticMeanOfBoundsFunction()` An aggregate function that returns a the arithmetic mean of min & max, if it can be computed, NULL otherwise.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createBoundsFunction()` An aggregate function that returns an interval consisting of the first and the last element following the predefined order.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createConstantFunction(java.lang.String value)` An aggregate function that returns a constant value.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createGeometricMeanFunction()` An aggregate function that returns a the geometric mean, if it can be computed, NULL otherwise.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createGeometricMeanOfBoundsFunction()` An aggregate function that returns a the geometric mean of min & max, if it can be computed, NULL otherwise.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createIntervalFunction()` An aggregate function that returns an interval [min, max].
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createIntervalFunction(boolean lowerIncluded, boolean upperIncluded)` An aggregate function that returns an interval [min, max].
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createPrefixFunction()` An aggregate function that returns a common prefix.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createPrefixFunction(java.lang.Character redaction)` An aggregate function that returns a common prefix.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createSetFunction()` An aggregate function that returns a set of all data values .
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createSetOfPrefixesFunction()` An aggregate function that returns a set of the prefixes of the data values.
    `AggregateFunction<T>` | AggregateFunction.AggregateFunctionBuilder.`createSetOfPrefixesFunction(int length)` An aggregate function that returns a set of the prefixes of the data values.
    `AggregateFunction<T>` | HierarchyBuilderGroupingBased.`getDefaultFunction()` Returns the default aggregate function.
    `AggregateFunction<T>` | HierarchyBuilderIntervalBased.Interval.`getFunction()`
    `AggregateFunction<U>` | HierarchyBuilderGroupingBased.Group.`getFunction()`

    Methods in org.deidentifier.arx.aggregates with parameters of type AggregateFunction
    Modifier and Type | Method and Description
    --- | ---
    `HierarchyBuilderGroupingBased.Level<U>` | HierarchyBuilderGroupingBased.Level.`addGroup(int size, AggregateFunction<U> function)` Adds the given group with the given aggregate function.
    `HierarchyBuilderIntervalBased<T>` | HierarchyBuilderIntervalBased.`addInterval(T min, T max, AggregateFunction<T> function)` Adds an interval.
    `protected HierarchyBuilderOrderBased.CloseElements` | HierarchyBuilderOrderBased.CloseElements.`merge(java.util.List<HierarchyBuilderOrderBased.CloseElements<T>> list, AggregateFunction<T> function)` Method
    `void` | HierarchyBuilderGroupingBased.`setAggregateFunction(AggregateFunction<T> function)` Sets the default aggregate function to be used by all fanouts.

    Constructors in org.deidentifier.arx.aggregates with parameters of type AggregateFunction
    Constructor and Description
    `HierarchyBuilderOrderBased.CloseElements(java.lang.String[] values, AggregateFunction<T> function)` Creates a new instance

  - ### Uses of AggregateFunction in org.deidentifier.arx.gui.view.impl.wizard

    Fields in org.deidentifier.arx.gui.view.impl.wizard declared as AggregateFunction
    Modifier and Type | Field and Description
    --- | ---
    `AggregateFunction<U>` | HierarchyWizardModelGrouping.HierarchyWizardGroupingGroup.`function` Var.
    `AggregateFunction<U>` | HierarchyWizardModelGrouping.HierarchyWizardGroupingInterval.`function` TODO

    Methods in org.deidentifier.arx.gui.view.impl.wizard that return AggregateFunction
    Modifier and Type | Method and Description
    --- | ---
    `AggregateFunction<T>` | HierarchyWizardEditorFunction.`getDefaultFunction()` Returns the default function.
    `AggregateFunction<T>` | HierarchyWizardModelGrouping.`getDefaultFunction()` Returns the default aggregate function.

    Methods in org.deidentifier.arx.gui.view.impl.wizard with parameters of type AggregateFunction
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | HierarchyWizardEditorFunction.`isDefaultFunction(AggregateFunction<T> function)` Returns whether this is the default function.
    `void` | HierarchyWizardModelGrouping.`setDefaultFunction(AggregateFunction<T> function)` Sets the default aggregate function.
    `void` | HierarchyWizardEditorFunction.`setFunction(AggregateFunction<T> function)` Sets the function to display.
    `void` | HierarchyWizardEditorFunction.IHierarchyFunctionEditorParent.`setFunction(AggregateFunction<T> function)` Sets the function
    `void` | HierarchyWizardEditorInterval.`setFunction(AggregateFunction<T> function)`
    `void` | HierarchyWizardEditor.`setFunction(AggregateFunction<T> function)`
    `void` | HierarchyWizardEditorGroup.`setFunction(AggregateFunction<T> function)`

    Constructors in org.deidentifier.arx.gui.view.impl.wizard with parameters of type AggregateFunction
    Constructor and Description
    `HierarchyWizardModelGrouping.HierarchyWizardGroupingGroup(int size, AggregateFunction<U> function)`
    `HierarchyWizardModelGrouping.HierarchyWizardGroupingInterval(U min, U max, AggregateFunction<U> function)`