com.socrata.api

Class SodaDdl

java.lang.Object

com.socrata.api.SodaWorkflow

com.socrata.api.SodaDdl

Direct Known Subclasses:

SodaImporter

public class SodaDdl
extends SodaWorkflow

Provides APIs for altering the shape of a dataset, whether that be adding columns, removing columns, etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ASSET_BASE_PATH
protected static String	COLUMNS_PATH
protected static String	SEARCH_BASE_PATH

Fields inherited from class com.socrata.api.SodaWorkflow

API_BASE_PATH, GEO_BASE_PATH, geocodingUri, httpLowLevel, mapper, TICKET_CHECK, VIEWS_BASE_PATH, viewUri

Constructor Summary

Constructors

Constructor and Description
SodaDdl(HttpLowLevel httpLowLevel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AssetResponse	addAsset(File file) Adds an asset to the Socrata Service.
Column	addColumn(String datasetId, Column column) Adds a column to the dataset, and returns a definition of the dataset.
Column	alterColumn(String datasetId, Column column) Alters a column to the dataset, and returns a definition of the dataset.
DatasetInfo	createDataset(DatasetInfo dataset) Creates an empty dataset, based on the dataset passed in.
void	deleteDataset(String id) Deletes a dataset
InputStream	getAsset(String id) Get an asset given the ID.
DatasetInfo	loadDatasetInfo(String id) Loads a dataset or view based on it's ID
static SodaDdl	newDdl(String url, String userName, String password, String token) Create a new SodaDdl object, using the supplied credentials for authentication.
void	removeColumn(String datasetId, int columnId) Removes a column to the dataset, and returns a definition of the dataset.
SearchResults	searchViews(SearchClause... searchClauses) Searches for matching datasets based on certain criteria.
DatasetInfo	updateDatasetInfo(DatasetInfo datasetInfo) Updates a view.

Methods inherited from class com.socrata.api.SodaWorkflow

createWorkingCopy, findPendingGeocodingResults, getHttpLowLevel, makePrivate, makePublic, newWorkflow, publish, waitForPendingGeocoding

Methods inherited from class java.lang.Object

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

Field Detail

COLUMNS_PATH

protected static final String COLUMNS_PATH

See Also:

Constant Field Values

ASSET_BASE_PATH

protected static final String ASSET_BASE_PATH

See Also:

Constant Field Values

SEARCH_BASE_PATH

protected static final String SEARCH_BASE_PATH

See Also:

Constant Field Values

Constructor Detail

SodaDdl

public SodaDdl(HttpLowLevel httpLowLevel)

Constructor.

Parameters:

httpLowLevel - the HttpLowLevel this uses to contact the server

Method Detail

newDdl

public static final SodaDdl newDdl(String url,
             String userName,
             String password,
             String token)

Create a new SodaDdl object, using the supplied credentials for authentication.

Parameters:

url - the base URL for the SODA2 domain to access.

userName - user name to log in as

password - password to log in with

token - the App Token to use for authorization and usage tracking. If this is null, no value will be sent.

Returns:

fully configured SodaDdl

searchViews

public SearchResults searchViews(SearchClause... searchClauses)
                          throws SodaError,
                                 InterruptedException

Searches for matching datasets based on certain criteria. The criteria to search on are based on the SearchClauses classes. Multiple clauses will be treated as AND-ed together.

Parameters:

searchClauses - the clauses to search

Returns:

Throws:

SodaError

InterruptedException

createDataset

public DatasetInfo createDataset(DatasetInfo dataset)
                          throws SodaError,
                                 InterruptedException

Creates an empty dataset, based on the dataset passed in. The new dataset will be unpublished.

Parameters:

dataset - dataset to create the new dataset on. The ID should NOT be set.

Returns:

the created dataset, the ID will be set on this.

Throws:

SodaError

InterruptedException

loadDatasetInfo

public DatasetInfo loadDatasetInfo(String id)
                            throws SodaError,
                                   InterruptedException

Loads a dataset or view based on it's ID

Parameters:

id - the ID to load the view through.

Returns:

The View with the supplied ID.

Throws:

LongRunningQueryException

SodaError

InterruptedException

updateDatasetInfo

public DatasetInfo updateDatasetInfo(DatasetInfo datasetInfo)
                              throws SodaError,
                                     InterruptedException

Updates a view. Depending on the properties being updated, this MAY require the dataset to be a working copy.

Parameters:

datasetInfo - the dataset to update to. The ID MUST be set. If this is a Dataset object, the dataset should be a working copy.

Returns:

the dataset after the update.

Throws:

SodaError

InterruptedException

deleteDataset

public void deleteDataset(String id)
                   throws SodaError,
                          InterruptedException

Deletes a dataset

Parameters:

id - the ID of the dataset to delete

Throws:

SodaError

InterruptedException

addColumn

public Column addColumn(String datasetId,
               Column column)
                 throws SodaError,
                        InterruptedException

Adds a column to the dataset, and returns a definition of the dataset.

Parameters:

datasetId - id of the dataset to add the column to

column - column definition

Returns:

the added column

Throws:

SodaError

InterruptedException

removeColumn

public void removeColumn(String datasetId,
                int columnId)
                  throws LongRunningQueryException,
                         SodaError

Removes a column to the dataset, and returns a definition of the dataset.

Parameters:

datasetId - id of the dataset to add the column to

columnId - if of the column to delete

Throws:

SodaError

InterruptedException

LongRunningQueryException

alterColumn

public Column alterColumn(String datasetId,
                 Column column)
                   throws SodaError,
                          InterruptedException

Alters a column to the dataset, and returns a definition of the dataset.

Parameters:

datasetId - id of the dataset to change the column to

column - column definition

Returns:

the added column

Throws:

SodaError

InterruptedException

addAsset

public AssetResponse addAsset(File file)
                       throws SodaError,
                              InterruptedException

Adds an asset to the Socrata Service. An Asset is a file stored as a blob on the service.

Parameters:

file - file to upload

Returns:

the asset ID and name

Throws:

SodaError

InterruptedException

getAsset

public InputStream getAsset(String id)
                     throws SodaError,
                            InterruptedException

Get an asset given the ID.

Parameters:

id - id of the asset to load

Returns:

InputStream of the file saved as the asset

Throws:

SodaError

InterruptedException