de.unknownreality.dataframe.group

Class DataGrouping

java.lang.Object

de.unknownreality.dataframe.group.DataGrouping

All Implemented Interfaces:

Iterable<DataGroup>

public class DataGrouping
extends Object
implements Iterable<DataGroup>

Created by Alex on 10.03.2016.

Constructor Summary

Constructors

Constructor and Description
DataGrouping(Collection<DataGroup> groups, String... groupColumns) Creates a data grouping based on a collections of data groups and the corresponding group columns

Method Summary

Modifier and Type	Method and Description
DataGrouping	concat(DataGrouping other) Concatenates two data groupings.
DataGrouping	filter(FilterPredicate predicate) Filters data groups that are not valid according to an input predicate.
DataGrouping	find(FilterPredicate predicate) Returns a new data grouping based on filtered data groups from this data grouping.
DataGrouping	find(String colName, Comparable value) Returns a new data grouping with all data groups from this grouping where a specified group value equals an input value.
DataGroup	findByGroupValues(Comparable... values) Finds and returns a data group based on its group values
DataGroup	findFirst(FilterPredicate predicate) Returns the first found data group from this data grouping matching an input predicate.
DataGroup	findFirst(String colName, Comparable value) Returns the first found data group from this grouping where a specified group value equals an input value.
String[]	getGroupColumns() Columns used for this grouping
Iterator<DataGroup>	iterator() Returns an iterator over the data groups in this grouping.
int	size() Returns the number of data groups in this grouping
DataGrouping	sort(Comparator<DataGroup> comp) Sorts the data groups using a custom comparator.
DataGrouping	sort(SortColumn... columns) Sorts the data groups in this data grouping using one or more SortColumn.
DataGrouping	sort(String name) Sorts the data groups using a specified group value
DataGrouping	sort(String name, SortColumn.Direction dir) Sorts the data groups using a specified group value and a sort direction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DataGrouping

public DataGrouping(Collection<DataGroup> groups,
                    String... groupColumns)

Creates a data grouping based on a collections of data groups and the corresponding group columns

Parameters:

groups - data groups

groupColumns - group columns

Method Detail

concat

public DataGrouping concat(DataGrouping other)

Concatenates two data groupings. The data groups from the other data grouping are appended to this data grouping

Parameters:

other - other data grouping

Returns:

self for method chaining

findByGroupValues

public DataGroup findByGroupValues(Comparable... values)

Finds and returns a data group based on its group values

Parameters:

values - input group values

Returns:

found data group. or null if no group was found

getGroupColumns

public String[] getGroupColumns()

Columns used for this grouping

Returns:

group columns

size

public int size()

Returns the number of data groups in this grouping

Returns:

number of data groups

filter

public DataGrouping filter(FilterPredicate predicate)

Filters data groups that are not valid according to an input predicate.
Data groups are filtered by their group values.
The predicated treats group values like data rows.
If a data group is filtered if it is not valid according to the predicate.
The filtered data groups are removed from this data grouping.

if(!predicate.valid(dataGroup)) -> remove(dataGroup)

Parameters:

predicate - filter predicate

Returns:

self for method chaining

find

public DataGrouping find(FilterPredicate predicate)

Returns a new data grouping based on filtered data groups from this data grouping.
Data groups that are valid according to the input predicate remain in the new data grouping.

if(predicate.valid(dataGroup)) -> add(dataGroup)

Parameters:

predicate - filter predicate

Returns:

new data grouping including the found data groups

See Also:

filter(FilterPredicate)

find

public DataGrouping find(String colName,
                         Comparable value)

Returns a new data grouping with all data groups from this grouping where a specified group value equals an input value.

Parameters:

colName - group value column name

value - input value

Returns:

new data grouping including the found data groups

findFirst

public DataGroup findFirst(String colName,
                           Comparable value)

Returns the first found data group from this grouping where a specified group value equals an input value.

Parameters:

colName - group value column name

value - input value

Returns:

first found data group

findFirst

public DataGroup findFirst(FilterPredicate predicate)

Returns the first found data group from this data grouping matching an input predicate.

Parameters:

predicate - input predicate

Returns:

first found data group

See Also:

find(FilterPredicate)

sort

public DataGrouping sort(SortColumn... columns)

Sorts the data groups in this data grouping using one or more SortColumn. Sort column specify the group values used for sorting

Parameters:

columns - sort columns

Returns:

self for method chaining

See Also:

SortColumn

sort

public DataGrouping sort(String name)

Sorts the data groups using a specified group value

Parameters:

name - group value name used for sorting

Returns:

self for method chaining

See Also:

sort(SortColumn...)

sort

public DataGrouping sort(String name,
                         SortColumn.Direction dir)

Sorts the data groups using a specified group value and a sort direction

Parameters:

name - group value name used for sorting

dir - sort direction (asc|desc)

Returns:

self for method chaining

See Also:

sort(SortColumn...)

sort

public DataGrouping sort(Comparator<DataGroup> comp)

Sorts the data groups using a custom comparator.

Parameters:

comp - comparator used to sort data groups

Returns:

self for method chaining

iterator

public Iterator<DataGroup> iterator()

Returns an iterator over the data groups in this grouping.

Iterator.remove() is not supported

Specified by:

iterator in interface Iterable<DataGroup>

Returns:

data groups iterator