com.socrata.model.importer

Class Dataset

java.lang.Object

com.socrata.model.importer.DatasetInfo

com.socrata.model.importer.Dataset

public class Dataset
extends DatasetInfo

The schema portions of a dataset. Anything changed in this class as opposed to it's parent class (DatasetInfo) should use a working copy.

Field Summary

Fields

Modifier and Type	Field and Description
static com.sun.jersey.api.client.GenericType<List<Dataset>>	LIST_TYPE

Fields inherited from class com.socrata.model.importer.DatasetInfo

DATASET_TYPE, EXTERNAL_TYPE, FILE_TYPE, PUBLISHED, UNPUBLISHED

Constructor Summary

Constructors

Constructor and Description
Dataset()

Method Summary

Methods

Modifier and Type	Method and Description
List<Column>	getColumns() Gets the list of columns in this dataset.
List<String>	getFlags() Flags describing different characteristics about the dataset.
Integer	getRowIdentifierColumnId() Gets the ID of the row identifier column (like a primary key)
Column	lookupRowIdentifierColumn() returns the column for the row identifier column, based on the id.
void	setColumns(List<Column> columns) Sets the list of columns in this dataset.
void	setFlags(List<String> flags) Sets the flags describing this dataset.
void	setRowIdentifierColumnId(Integer rowIdentifierColumnId) Sets the row identier column ID for the (like a primary key).
void	setupRowIdentifierColumn(Column column) Sets a column to be a row identifier for this dataset.
void	setupRowIdentifierColumnByName(String columnName) Looks up a column by it's name and uses that to setup the row identifier column.

Methods inherited from class com.socrata.model.importer.DatasetInfo

copy, getAttribution, getAttributionLink, getCategory, getDescription, getExternalId, getGrants, getId, getLicense, getLicenseId, getMetadata, getName, getPrivateMetadata, getPublicationStage, getResourceName, getRights, getRowsUpdatedAt, getTags, getViewType, setAttribution, setAttributionLink, setCategory, setDescription, setExternalId, setGrants, setId, setLicense, setLicenseId, setMetadata, setName, setPrivateMetadata, setPublicationStage, setResourceName, setRights, setRowsUpdatedAt, setTags, setupLicense, setViewType

Methods inherited from class java.lang.Object

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

Field Detail

LIST_TYPE

public static final com.sun.jersey.api.client.GenericType<List<Dataset>> LIST_TYPE

Constructor Detail

Dataset

public Dataset()

Method Detail

getColumns

public List<Column> getColumns()

Gets the list of columns in this dataset.

Returns:

the list of columns in this dataset.

setColumns

public void setColumns(List<Column> columns)

Sets the list of columns in this dataset.

Parameters:

columns - the list of columns in this dataset.

getFlags

public List<String> getFlags()

Flags describing different characteristics about the dataset. These are mainly used by the system and shouldn't really be changed.

Returns:

list of the flags describing this dataset

setFlags

public void setFlags(List<String> flags)

Sets the flags describing this dataset. These are mainly used by the system and should not really be persisted back to the server.

Parameters:

flags - the flags describing this dataset.

setupRowIdentifierColumnByName

public void setupRowIdentifierColumnByName(String columnName)

Looks up a column by it's name and uses that to setup the row identifier column.

Parameters:

columnName - name of the column

setupRowIdentifierColumn

public void setupRowIdentifierColumn(Column column)

Sets a column to be a row identifier for this dataset. You can think of this as being the same as a primary key.

Parameters:

column - the column to use as the row identifier. This MUST have the field set. If null, this will clear out the row identifier so the dataset will use the system built-in primary key.

getRowIdentifierColumnId

public Integer getRowIdentifierColumnId()

Gets the ID of the row identifier column (like a primary key)

Returns:

the ID of the row identifier column (like a primary key)

lookupRowIdentifierColumn

public Column lookupRowIdentifierColumn()

returns the column for the row identifier column, based on the id.

Returns:

the column for the row identifier column, based on the id.

setRowIdentifierColumnId

public void setRowIdentifierColumnId(Integer rowIdentifierColumnId)

Sets the row identier column ID for the (like a primary key). It is important to note that when changing this to update the server, you will need to set the row identifier field in the metadata field as well. Or you can call setRowIdentifierColumn to do this for you.

Parameters:

rowIdentifierColumnId - the id of the row identifier column (like a primary key)