com.github.martincooper.datatable

Class DataView

java.lang.Object

com.github.martincooper.datatable.DataView

All Implemented Interfaces:

IBaseTable, IQuickSort, Iterable<DataRow>

public class DataView
extends Object
implements IBaseTable

DataView. Provides a view over a DataTable to store filtered data sets. Created by Martin Cooper on 19/07/2017.

Method Summary

Modifier and Type	Method and Description
static io.vavr.control.Try<DataView>	build(DataTable table, Iterable<DataRow> rows) Builds an instance of a DataView.
IDataColumn	column(Integer colIdx) Accessor to a specific column by index.
IDataColumn	column(String colName) Accessor to a specific column by name.
DataColumnCollection	columns()
Iterator<DataRow>	iterator() Returns an iterator over elements of type DataRow.
String	name()
io.vavr.control.Try<DataView>	quickSort(Integer columnIndex) Table QuickSort by single column index.
io.vavr.control.Try<DataView>	quickSort(Integer columnIndex, SortOrder sortOrder) Table QuickSort by single column index and a sort order.
io.vavr.control.Try<DataView>	quickSort(Iterable<SortItem> sortItems) Table QuickSort by multiple sort items.
io.vavr.control.Try<DataView>	quickSort(SortItem sortItem) Table QuickSort by single sort item.
io.vavr.control.Try<DataView>	quickSort(String columnName) Table QuickSort by single column name.
io.vavr.control.Try<DataView>	quickSort(String columnName, SortOrder sortOrder) Table QuickSort by single column name and a sort order.
DataRow	row(Integer rowIdx) Accessor to a specific row by index.
Integer	rowCount() Returns the rowCount / row count of the table.
DataRowCollection	rows()
DataTable	toDataTable() Return a new DataTable based on this table (clone).
DataView	toDataView() Return a new Data View based on this table

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

Method Detail

iterator

public Iterator<DataRow> iterator()

Returns an iterator over elements of type DataRow.

Specified by:

iterator in interface Iterable<DataRow>

Returns:

an Iterator.

name

public String name()

Specified by:

name in interface IBaseTable

Returns:

Returns the table name.

columns

public DataColumnCollection columns()

Specified by:

columns in interface IBaseTable

Returns:

Returns the columns collection.

rows

public DataRowCollection rows()

Specified by:

rows in interface IBaseTable

Returns:

Returns the row collection.

row

public DataRow row(Integer rowIdx)

Accessor to a specific row by index.

Specified by:

row in interface IBaseTable

Parameters:

rowIdx - The index of the row to return.

Returns:

Returns a single row.

column

public IDataColumn column(Integer colIdx)

Accessor to a specific column by index.

Parameters:

colIdx - The index of the column to return.

Returns:

Returns a single column.

column

public IDataColumn column(String colName)

Accessor to a specific column by name.

Parameters:

colName - The name of the column to return.

Returns:

Returns a single column.

rowCount

public Integer rowCount()

Returns the rowCount / row count of the table.

Specified by:

rowCount in interface IBaseTable

Returns:

The row count of the table.

toDataTable

public DataTable toDataTable()

Return a new DataTable based on this table (clone).

Specified by:

toDataTable in interface IBaseTable

Returns:

Returns a new DataTable based on the columns and data in this view.

toDataView

public DataView toDataView()

Return a new Data View based on this table

Specified by:

toDataView in interface IBaseTable

Returns:

A new Data View based on this table.

quickSort

public io.vavr.control.Try<DataView> quickSort(String columnName)

Table QuickSort by single column name.

Specified by:

quickSort in interface IQuickSort

Parameters:

columnName - The column name to sort.

Returns:

Returns the results as a sorted Data View.

quickSort

public io.vavr.control.Try<DataView> quickSort(String columnName,
                                               SortOrder sortOrder)

Table QuickSort by single column name and a sort order.

Specified by:

quickSort in interface IQuickSort

Parameters:

columnName - The column name to sort.

sortOrder - The sort order.

Returns:

Returns the results as a sorted Data View.

quickSort

public io.vavr.control.Try<DataView> quickSort(Integer columnIndex)

Table QuickSort by single column index.

Specified by:

quickSort in interface IQuickSort

Parameters:

columnIndex - The column index to sort.

Returns:

Returns the results as a sorted Data View.

quickSort

public io.vavr.control.Try<DataView> quickSort(Integer columnIndex,
                                               SortOrder sortOrder)

Table QuickSort by single column index and a sort order.

Specified by:

quickSort in interface IQuickSort

Parameters:

columnIndex - The column index to sort.

sortOrder - The sort order.

Returns:

Returns the results as a sorted Data View.

quickSort

public io.vavr.control.Try<DataView> quickSort(SortItem sortItem)

Table QuickSort by single sort item.

Specified by:

quickSort in interface IQuickSort

Parameters:

sortItem - The sort item.

Returns:

Returns the results as a sorted Data View.

quickSort

public io.vavr.control.Try<DataView> quickSort(Iterable<SortItem> sortItems)

Table QuickSort by multiple sort items.

Specified by:

quickSort in interface IQuickSort

Parameters:

sortItems - The sort items.

Returns:

Returns the results as a sorted Data View.

build

public static io.vavr.control.Try<DataView> build(DataTable table,
                                                  Iterable<DataRow> rows)

Builds an instance of a DataView. DataRows are validated before creation, returning a Failure on error.

Parameters:

table - The underlying table.

rows - The Data Rows.

Returns:

Returns a DataView wrapped in a Try.