com.socrata.api

Class SodaWorkflow

java.lang.Object

com.socrata.api.SodaWorkflow

Direct Known Subclasses:

SodaDdl

public class SodaWorkflow
extends Object

Implements the methods important to using the Soda workflow. At a high level, these are the APIs around publishing and determining if processes like geocoding are still going on. To find out more about the publishing cycle, look at http://dev.socrata.com/publishers/workflow However, for frequent updates or large datasets, it is often better to us the Soda2Producer API if you can, because publishing operations are expensive.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	API_BASE_PATH
protected static String	GEO_BASE_PATH
protected URI	geocodingUri
protected HttpLowLevel	httpLowLevel
protected org.codehaus.jackson.map.ObjectMapper	mapper
protected static long	TICKET_CHECK
protected static String	VIEWS_BASE_PATH
protected URI	viewUri

Constructor Summary

Constructors

Constructor and Description
SodaWorkflow(HttpLowLevel httpLowLevel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DatasetInfo	createWorkingCopy(String datasetId) Creates a working copy for the specified dataset ID.
GeocodingResults	findPendingGeocodingResults(String datasetId) Checks to see if the current dataset has any pending Geocoding results.
HttpLowLevel	getHttpLowLevel() Gets the underlying connection.
void	makePrivate(String datasetId) Makes a dataset private, so it can only be viewed by users that it has been shared with, or people who are admins on the site.
void	makePublic(String datasetId) Makes a dataset public.
static SodaWorkflow	newWorkflow(String url, String userName, String password, String token) Create a new SodaWorkflow object, using the supplied credentials for authentication.
DatasetInfo	publish(String datasetId) Publishes a dataset.
void	waitForPendingGeocoding(String datasetId) Waits for pending geocodes to be finished.

Methods inherited from class java.lang.Object

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

Field Detail

API_BASE_PATH

protected static final String API_BASE_PATH

See Also:

Constant Field Values

GEO_BASE_PATH

protected static final String GEO_BASE_PATH

See Also:

Constant Field Values

TICKET_CHECK

protected static final long TICKET_CHECK

See Also:

Constant Field Values

VIEWS_BASE_PATH

protected static final String VIEWS_BASE_PATH

See Also:

Constant Field Values

geocodingUri

protected final URI geocodingUri

httpLowLevel

protected final HttpLowLevel httpLowLevel

mapper

protected final org.codehaus.jackson.map.ObjectMapper mapper

viewUri

protected final URI viewUri

Constructor Detail

SodaWorkflow

public SodaWorkflow(HttpLowLevel httpLowLevel)

Constructor.

Parameters:

httpLowLevel - the HttpLowLevel this uses to contact the server

Method Detail

newWorkflow

public static final SodaWorkflow newWorkflow(String url,
                       String userName,
                       String password,
                       String token)

Create a new SodaWorkflow 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 SodaWorkflow

getHttpLowLevel

public HttpLowLevel getHttpLowLevel()

Gets the underlying connection.

Returns:

the underlying connection

publish

public DatasetInfo publish(String datasetId)
                    throws SodaError,
                           InterruptedException

Publishes a dataset.

Parameters:

datasetId - id of the dataset to publish.

Returns:

the view of the published dataset.

Throws:

SodaError

InterruptedException

LongRunningQueryException

createWorkingCopy

public DatasetInfo createWorkingCopy(String datasetId)
                              throws SodaError,
                                     InterruptedException

Creates a working copy for the specified dataset ID. This copy can have any schema changes made to it, as well as replace/append operations. The resulting dataset will not be available to other users until it is published.

Parameters:

datasetId - the id of the dataset.

Returns:

reference to the new working copy of this dataset

Throws:

SodaError

InterruptedException

makePublic

public void makePublic(String datasetId)
                throws SodaError,
                       InterruptedException

Makes a dataset public. After calling this on a dataset, it will be visible to any user, meaning any use will have teh "viewer" role for this dataset.

Parameters:

datasetId - id of the dataset to make public.

Throws:

SodaError

InterruptedException

makePrivate

public void makePrivate(String datasetId)
                 throws SodaError,
                        InterruptedException

Makes a dataset private, so it can only be viewed by users that it has been shared with, or people who are admins on the site.

Parameters:

datasetId - id of the dataset

Throws:

SodaError

InterruptedException

waitForPendingGeocoding

public void waitForPendingGeocoding(String datasetId)
                             throws InterruptedException,
                                    SodaError

Waits for pending geocodes to be finished. A publish won't work until all active geocoding requests are handled.

Parameters:

datasetId - id of the dataset to check for outstanding geocodes.

Throws:

InterruptedException

SodaError

findPendingGeocodingResults

public GeocodingResults findPendingGeocodingResults(String datasetId)
                                             throws SodaError,
                                                    InterruptedException

Checks to see if the current dataset has any pending Geocoding results.

Parameters:

datasetId - id of the dataset

Returns:

The Geocoding results for this dataset.

Throws:

SodaError

InterruptedException