com.socrata.api

Class Soda2Base

java.lang.Object

com.socrata.api.Soda2Base

Direct Known Subclasses:

Soda2Consumer

public class Soda2Base
extends Object

A base class that wraps some common SODA 2 behaviours around an HttpLowLevel object.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SODA_BASE_PATH
static String	SODA_QUERY

Constructor Summary

Constructors

Constructor and Description
Soda2Base(HttpLowLevel httpLowLevel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T> com.sun.jersey.api.client.ClientResponse	doAdd(String resourceId, T object) Adds a single row to a dataset.
<T> com.sun.jersey.api.client.ClientResponse	doAddObjects(String resourceId, Collection<T> objects) Adds a collection of rows to a dataset.
com.sun.jersey.api.client.ClientResponse	doAddStream(String resourceId, javax.ws.rs.core.MediaType mediaType, InputStream stream) Adds a collection of rows to a dataset, but does so by simply streaming a datastream to the SODA2 server.
com.sun.jersey.api.client.ClientResponse	doDelete(String resourceId, String uniqueId) Deletes a single row from a dataset.
<T> com.sun.jersey.api.client.ClientResponse	doReplaceObjects(String resourceId, Collection<T> objects)
com.sun.jersey.api.client.ClientResponse	doReplaceStream(String resourceId, javax.ws.rs.core.MediaType mediaType, InputStream stream)
com.sun.jersey.api.client.ClientResponse	doTruncate(String resourceId) Truncates a dataset by removing all the rows in it.
com.sun.jersey.api.client.ClientResponse	doUpdate(String resourceId, Object uniqueId, Object object) Update an object.
com.sun.jersey.api.client.ClientResponse	getById(String resourceId, javax.ws.rs.core.MediaType mediaType, String uniqueId) Load a single object based on it's unique ID.
HttpLowLevel	getHttpLowLevel() The HttpLowLevel used for communicating with the service.
com.sun.jersey.api.client.ClientResponse	query(String resourceId, javax.ws.rs.core.MediaType mediaType, SoqlQuery query) Runs a query against a SODA2 resource.
com.sun.jersey.api.client.ClientResponse	query(String resourceId, javax.ws.rs.core.MediaType mediaType, String query) Runs a query against a SODA2 resource.

Methods inherited from class java.lang.Object

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

Field Detail

SODA_BASE_PATH

public static final String SODA_BASE_PATH

See Also:

Constant Field Values

SODA_QUERY

public static final String SODA_QUERY

See Also:

Constant Field Values

Constructor Detail

Soda2Base

public Soda2Base(HttpLowLevel httpLowLevel)

Constructor.

Parameters:

httpLowLevel - the HttpLowLevel this uses to contact the server

Method Detail

query

public com.sun.jersey.api.client.ClientResponse query(String resourceId,
                                             javax.ws.rs.core.MediaType mediaType,
                                             SoqlQuery query)
                                               throws LongRunningQueryException,
                                                      SodaError

Runs a query against a SODA2 resource.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

query - The query to be executed against the resource.

Returns:

a response containing the response stream, if the request is successful

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

query

public com.sun.jersey.api.client.ClientResponse query(String resourceId,
                                             javax.ws.rs.core.MediaType mediaType,
                                             String query)
                                               throws LongRunningQueryException,
                                                      SodaError

Runs a query against a SODA2 resource.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

query - The query string to be executed against the resource. This should NOT be URL encoded.

Returns:

The results from the operation

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

getById

public com.sun.jersey.api.client.ClientResponse getById(String resourceId,
                                               javax.ws.rs.core.MediaType mediaType,
                                               String uniqueId)
                                                 throws LongRunningQueryException,
                                                        SodaError

Load a single object based on it's unique ID. This id can either be based on a dataset specific unique column, or the system ID created for each row.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

uniqueId - Id based on a dataset specific unique column, or the system ID created for each row.

Returns:

a response containing the response stream, if the request is successful.

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doTruncate

public com.sun.jersey.api.client.ClientResponse doTruncate(String resourceId)
                                                    throws LongRunningQueryException,
                                                           SodaError

Truncates a dataset by removing all the rows in it.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doDelete

public com.sun.jersey.api.client.ClientResponse doDelete(String resourceId,
                                                String uniqueId)
                                                  throws LongRunningQueryException,
                                                         SodaError

Deletes a single row from a dataset.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

uniqueId - Id based on a dataset specific unique column, or the system ID created for each row.

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doAdd

public <T> com.sun.jersey.api.client.ClientResponse doAdd(String resourceId,
                                                 T object)
                                               throws LongRunningQueryException,
                                                      SodaError

Adds a single row to a dataset.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

object - The object that should be serialized to JSON and added to the dataset. Jackson is used for serialization and deserialization.

Returns:

The results from the operation

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doAddObjects

public <T> com.sun.jersey.api.client.ClientResponse doAddObjects(String resourceId,
                                                        Collection<T> objects)
                                                      throws LongRunningQueryException,
                                                             SodaError

Adds a collection of rows to a dataset.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

objects - The objects that should be serialized to JSON and added to the dataset. Jackson is used for serialization and deserialization.

Returns:

The results from the operation

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doAddStream

public com.sun.jersey.api.client.ClientResponse doAddStream(String resourceId,
                                                   javax.ws.rs.core.MediaType mediaType,
                                                   InputStream stream)
                                                     throws LongRunningQueryException,
                                                            SodaError

Adds a collection of rows to a dataset, but does so by simply streaming a datastream to the SODA2 server. Whether the stream is JSON or CSV is set by the mediaType

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

mediaType - The media type for the stream (normally JSON or CSV)

stream - The objects to add, already serialized in a stream.

Returns:

The results from the operation

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doUpdate

public com.sun.jersey.api.client.ClientResponse doUpdate(String resourceId,
                                                Object uniqueId,
                                                Object object)
                                                  throws LongRunningQueryException,
                                                         SodaError

Update an object.

Parameters:

resourceId - The id of the resource to query. This can either be the resource endpoint name set in the metadata, or the unique ID given to the resource.

uniqueId - Id based on a dataset specific unique column, or the system ID created for each row.

object - The object that should be serialized to JSON and added to the dataset. Jackson is used for serialization and deserialization.

Returns:

The results from the operation

Throws:

LongRunningQueryException - thrown if this query is long running and a 202 is returned. In this case, the caller likely wants to call follow202.

SodaError - thrown if there is an error. Investigate the structure for more information.

doReplaceObjects

public <T> com.sun.jersey.api.client.ClientResponse doReplaceObjects(String resourceId,
                                                            Collection<T> objects)
                                                          throws LongRunningQueryException,
                                                                 SodaError

Throws:

LongRunningQueryException

SodaError

doReplaceStream

public com.sun.jersey.api.client.ClientResponse doReplaceStream(String resourceId,
                                                       javax.ws.rs.core.MediaType mediaType,
                                                       InputStream stream)
                                                         throws LongRunningQueryException,
                                                                SodaError

Throws:

LongRunningQueryException

SodaError

getHttpLowLevel

public final HttpLowLevel getHttpLowLevel()

The HttpLowLevel used for communicating with the service.

Returns:

HttpLowLevel used for communicating with the service.