com.belladati.sdk.dataset

Interface DataSet

All Superinterfaces:

IdElement, Localizable, Resource

public interface DataSet
extends Resource, Localizable

A BellaDati data set definition.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
DataTable	createDataTable() Returns an empty data table matching this data set's structure.
List<Attribute>	getAttributes() Returns a list of all attributes used in this data set.
CachedList<DataSource>	getDataSources() Returns the list of data sources for this data set.
String	getDescription() Returns the description of this data set.
List<Indicator>	getIndicators() Returns a list of all indicators used in this data set.
Date	getLastChange() Returns the last change date of this data set.
String	getOwnerName() Returns the name of the data set owner.
List<ReportInfo>	getReports() Returns a list of all reports for this data set.
DataSet	uploadData(DataTable data) Uploads the given data into this data set.

Methods inherited from interface com.belladati.sdk.util.Resource

getId, getName

Methods inherited from interface com.belladati.sdk.util.Localizable

getName, hasLocalization

Method Detail

getDescription

String getDescription()

Returns the description of this data set.

Returns:

the description of this data set

getOwnerName

String getOwnerName()

Returns the name of the data set owner.

Returns:

the name of the data set owner

getLastChange

Date getLastChange()

Returns the last change date of this data set.

Returns:

the last change date of this data set, or null if it was never changed

getAttributes

List<Attribute> getAttributes()

Returns a list of all attributes used in this data set.

Returns:

a list of all attributes used in this data set

getIndicators

List<Indicator> getIndicators()

Returns a list of all indicators used in this data set.

Returns:

a list of all indicators used in this data set

getReports

List<ReportInfo> getReports()

Returns a list of all reports for this data set.

Returns:

a list of all reports for this data set

createDataTable

DataTable createDataTable()
                          throws NoColumnsException

Returns an empty data table matching this data set's structure. Populate this table in order to import data for the data set.

Returns:

an empty data table matching this data set's structure

Throws:

NoColumnsException - if the data set doesn't have any columns

uploadData

DataSet uploadData(DataTable data)
                   throws UnknownServerColumnException

Uploads the given data into this data set. This method doesn't perform any validation of the data; the caller should ensure it matches the data set's structure.

To ensure the structure is correct, generate the table calling createDataTable() on the same data set.

Parameters:

data - the data to upload

Returns:

this data set

Throws:

UnknownServerColumnException - if the data table contains a column that doesn't exist in the data set

getDataSources

CachedList<DataSource> getDataSources()

Returns the list of data sources for this data set. This is a cached list, call CachedCollection.loadFirstTime() to populate it initially.

Returns:

the list of data sources for this data set