com.belladati.sdk.dataset.data

Class DataTable

java.lang.Object

com.belladati.sdk.dataset.data.DataTable

public class DataTable
extends Object

A table holding data ready for import. Ensures that each row sticks to the column structure defined in the constructor.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
static DataTable	createBasicInstance(List<String> columns) Creates a new instance with the given column setup.
static DataTable	createBasicInstance(String firstColumn, String... otherColumns) Creates a new instance with the given column setup.
static DataTable	createDetailedInstance(DataColumn firstColumn, DataColumn... otherColumns) Creates a new instance with the given column setup.
static DataTable	createDetailedInstance(List<DataColumn> columns) Creates a new instance with the given column setup.
DataRow	createRow() Creates a new, empty row in the table.
DataTable	createRow(String... values) Creates a new row in the table containing the given values.
List<DataColumn>	getColumns() Returns all columns in this table.
OverwritePolicy	getOverwritePolicy() Returns the current overwrite policy of this table.
List<DataRow>	getRows() Returns all rows currently in this table.
DataTable	setOverwritePolicy(OverwritePolicy overwritePolicy) Sets the overwrite policy to use with this table.
com.fasterxml.jackson.databind.JsonNode	toJson() Returns this table in JSON representation.

Methods inherited from class java.lang.Object

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

Method Detail

createBasicInstance

public static DataTable createBasicInstance(String firstColumn,
                            String... otherColumns)

Creates a new instance with the given column setup. At least one column must be specified in the table. Rows are allowed to be empty.

Columns should be unique, but the table doesn't enforce this.

Parameters:

firstColumn - first column

otherColumns - additional, optional columns

createBasicInstance

public static DataTable createBasicInstance(List<String> columns)
                                     throws NoColumnsException

Creates a new instance with the given column setup. At least one column must be specified in the table. Rows are allowed to be empty.

Columns should be unique, but the table doesn't enforce this.

Parameters:

columns - columns for the table

Throws:

NoColumnsException - if the list is empty

createDetailedInstance

public static DataTable createDetailedInstance(DataColumn firstColumn,
                               DataColumn... otherColumns)

Creates a new instance with the given column setup. At least one column must be specified in the table. Rows are allowed to be empty.

Columns should be unique, but the table doesn't enforce this.

Parameters:

firstColumn - first column

otherColumns - additional, optional columns

createDetailedInstance

public static DataTable createDetailedInstance(List<DataColumn> columns)
                                        throws NoColumnsException

Creates a new instance with the given column setup. At least one column must be specified in the table. Rows are allowed to be empty.

Columns should be unique, but the table doesn't enforce this.

Parameters:

columns - columns for the table

Throws:

NoColumnsException - if the list is empty

createRow

public DataTable createRow(String... values)
                    throws TooManyColumnsException

Creates a new row in the table containing the given values.

Parameters:

values - the column values to set

Returns:

this table, to allow chaining

Throws:

TooManyColumnsException - if more values are given than columns are available

createRow

public DataRow createRow()

Creates a new, empty row in the table.

Returns:

the newly created row

getRows

public List<DataRow> getRows()

Returns all rows currently in this table.

Returns:

all rows currently in this table

getColumns

public List<DataColumn> getColumns()

Returns all columns in this table.

Returns:

all columns in this table

setOverwritePolicy

public DataTable setOverwritePolicy(OverwritePolicy overwritePolicy)
                             throws UnknownColumnException

Sets the overwrite policy to use with this table. If none is set, OverwritePolicy.deleteNone() is used.

Parameters:

overwritePolicy - the overwrite policy to use

Returns:

this table, to allow chaining

Throws:

UnknownColumnException - if any of the columns used in the policy doesn't exist in the table

getOverwritePolicy

public OverwritePolicy getOverwritePolicy()

Returns the current overwrite policy of this table.

Returns:

the current overwrite policy of this table

toJson

public com.fasterxml.jackson.databind.JsonNode toJson()

Returns this table in JSON representation.

Returns:

this table in JSON representation