Cosm
Class Cosm

java.lang.Object
  extended by Cosm.Cosm

public class Cosm
extends java.lang.Object

The Cosm class provides the methods for interfacing with the Cosm (www.cosm.com) webservice.

Version:
15 June 2012
Author:
Pieter Meulenhoff

Field Summary
static java.lang.String VERSION
           
 
Constructor Summary
Cosm(java.lang.String apikey)
          Constructor based on access with an Cosm API key
Cosm(java.lang.String username, java.lang.String password)
          Constructor based on access with a username and password
 
Method Summary
 Apikey createApikey(Apikey apikey)
           
 void createDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint datapoint)
           
 void createDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint[] datapoints)
           
 Datastream createDatastream(java.lang.Integer feedid, Datastream datastream)
           
 Feed createFeed(Feed feed)
           
 Group createGroup(Group group)
           
 Trigger createTrigger(Trigger trigger)
           
 void createUser(User user)
           
 void deleteApikey(java.lang.String apikey)
           
 void deleteDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String at)
           
 void deleteDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String start, java.lang.String end, java.lang.String duration)
           
 void deleteDatastream(java.lang.Integer feedid, java.lang.String datastreamid)
           
 void deleteFeed(java.lang.Integer feedid)
           
 void deleteGroup(java.lang.String groupid)
           
 void deleteTrigger(java.lang.Integer id)
           
 void deleteUser(java.lang.String login)
           
 Apikey getApikey(java.lang.String apikey)
           
 Apikey[] getApikeys()
           
 Datapoint getDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String at)
           
 Datapoint[] getDatapoints(java.lang.Integer feedid, java.lang.String datastreamid, java.lang.String start, java.lang.String end, java.lang.String duration, java.lang.Integer interval, java.lang.Boolean find_previous, Interval_type interval_type, int per_page, java.lang.String timezone)
           
 Datastream getDatastream(java.lang.Integer feedid, java.lang.String datastreamid)
           
 Datastream[] getDatastreams(java.lang.Integer feedid)
           
 Feed getFeed(int feedid)
          Retrieve a Feed object from Cosm retrieves a Feed object by its identifier.
 Feed getFeed(int feedid, java.lang.Boolean show_user)
          Get a feed object by its feed identifier
 Feed[] getFeeds()
           
 Feed[] getFeeds(java.lang.String query, Content content, java.lang.String tag, java.lang.String user, java.lang.String units, Status status, Order order, java.lang.Boolean show_user)
          returns a list of feed objects based on a number of optional query parameters.
 Group getGroup(java.lang.String groupid)
           
 Group[] getGroups()
           
 Trigger getTrigger(java.lang.Integer id)
           
 Trigger[] getTriggers()
           
 User getUser(java.lang.String login)
           
 User[] getUsers()
           
 Waypoint[] getWaypoints(java.lang.Integer feedid, java.lang.String start, java.lang.String end, java.lang.String duration, java.lang.Integer interval, java.lang.Boolean find_previous, Interval_type interval_type, java.lang.String timezone)
           
 void updateDatapoint(java.lang.Integer feedid, java.lang.String datastreamid, Datapoint datapoint)
           
 void updateDatastream(java.lang.Integer feedid, java.lang.String datastreamid, Datastream datastream)
           
 void updateFeed(Feed feed)
           
 void updateGroup(Group group)
           
 void updateTrigger(Trigger trigger)
           
 void updateUser(java.lang.String login, User user)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERSION

public static final java.lang.String VERSION
See Also:
Constant Field Values
Constructor Detail

Cosm

public Cosm(java.lang.String apikey)
Constructor based on access with an Cosm API key

Parameters:
apikey - Cosm API key

Cosm

public Cosm(java.lang.String username,
            java.lang.String password)
Constructor based on access with a username and password

Parameters:
username - Cosm username (or login)
password - Cosm password
Method Detail

getFeed

public Feed getFeed(int feedid)
             throws CosmException
Retrieve a Feed object from Cosm retrieves a Feed object by its identifier. If no feed was found or a problem occurs, a CosmException is thrown.

Parameters:
feedid - identifier of the Cosm feed
Returns:
Feed object
Throws:
CosmException

getFeed

public Feed getFeed(int feedid,
                    java.lang.Boolean show_user)
             throws CosmException
Get a feed object by its feed identifier

Parameters:
feedid - Id of the Cosm feed to retrieve
Returns:
Feed object which corresponds to the id provided as the parameter
Throws:
CosmException - If something goes wrong, or if the Feed was not found.

getFeeds

public Feed[] getFeeds(java.lang.String query,
                       Content content,
                       java.lang.String tag,
                       java.lang.String user,
                       java.lang.String units,
                       Status status,
                       Order order,
                       java.lang.Boolean show_user)
                throws CosmException
returns a list of feed objects based on a number of optional query parameters. If set to null, a parameter is ignored.

Parameters:
query - Full text String search parameter. Should return any feeds matching this string
content - parameter of type Content describing the type of results
tag - Returns feeds containing datastreams tagged with the search query
user - Returns feeds created by the user specified.
units - Returns feeds containing datastreams with units specified by the search query.
status - Parameter of type Status
order - Parameter of type Order. Used for ordering the results.
show_user - Include user login and user level for each feed. Boolean with possible values: true, false (default)
Returns:
Array of Feed objects
Throws:
CosmException

getFeeds

public Feed[] getFeeds()
                throws CosmException
Throws:
CosmException

deleteFeed

public void deleteFeed(java.lang.Integer feedid)
                throws CosmException
Throws:
CosmException

createFeed

public Feed createFeed(Feed feed)
                throws CosmException
Throws:
CosmException

updateFeed

public void updateFeed(Feed feed)
                throws CosmException
Throws:
CosmException

createGroup

public Group createGroup(Group group)
                  throws CosmException
Throws:
CosmException

getGroup

public Group getGroup(java.lang.String groupid)
               throws CosmException
Throws:
CosmException

getGroups

public Group[] getGroups()
                  throws CosmException
Throws:
CosmException

updateGroup

public void updateGroup(Group group)
                 throws CosmException
Throws:
CosmException

deleteGroup

public void deleteGroup(java.lang.String groupid)
                 throws CosmException
Throws:
CosmException

getDatastream

public Datastream getDatastream(java.lang.Integer feedid,
                                java.lang.String datastreamid)
                         throws CosmException
Throws:
CosmException

getDatastreams

public Datastream[] getDatastreams(java.lang.Integer feedid)
                            throws CosmException
Throws:
CosmException

createDatastream

public Datastream createDatastream(java.lang.Integer feedid,
                                   Datastream datastream)
                            throws CosmException
Throws:
CosmException

updateDatastream

public void updateDatastream(java.lang.Integer feedid,
                             java.lang.String datastreamid,
                             Datastream datastream)
                      throws CosmException
Throws:
CosmException

deleteDatastream

public void deleteDatastream(java.lang.Integer feedid,
                             java.lang.String datastreamid)
                      throws CosmException
Throws:
CosmException

createDatapoint

public void createDatapoint(java.lang.Integer feedid,
                            java.lang.String datastreamid,
                            Datapoint datapoint)
                     throws CosmException
Throws:
CosmException

createDatapoints

public void createDatapoints(java.lang.Integer feedid,
                             java.lang.String datastreamid,
                             Datapoint[] datapoints)
                      throws CosmException
Throws:
CosmException

updateDatapoint

public void updateDatapoint(java.lang.Integer feedid,
                            java.lang.String datastreamid,
                            Datapoint datapoint)
                     throws CosmException
Throws:
CosmException

getDatapoint

public Datapoint getDatapoint(java.lang.Integer feedid,
                              java.lang.String datastreamid,
                              java.lang.String at)
                       throws CosmException
Throws:
CosmException

deleteDatapoint

public void deleteDatapoint(java.lang.Integer feedid,
                            java.lang.String datastreamid,
                            java.lang.String at)
                     throws CosmException
Throws:
CosmException

deleteDatapoints

public void deleteDatapoints(java.lang.Integer feedid,
                             java.lang.String datastreamid,
                             java.lang.String start,
                             java.lang.String end,
                             java.lang.String duration)
                      throws CosmException
Throws:
CosmException

getWaypoints

public Waypoint[] getWaypoints(java.lang.Integer feedid,
                               java.lang.String start,
                               java.lang.String end,
                               java.lang.String duration,
                               java.lang.Integer interval,
                               java.lang.Boolean find_previous,
                               Interval_type interval_type,
                               java.lang.String timezone)
                        throws CosmException
Throws:
CosmException

getDatapoints

public Datapoint[] getDatapoints(java.lang.Integer feedid,
                                 java.lang.String datastreamid,
                                 java.lang.String start,
                                 java.lang.String end,
                                 java.lang.String duration,
                                 java.lang.Integer interval,
                                 java.lang.Boolean find_previous,
                                 Interval_type interval_type,
                                 int per_page,
                                 java.lang.String timezone)
                          throws CosmException
Throws:
CosmException

createApikey

public Apikey createApikey(Apikey apikey)
                    throws CosmException
Throws:
CosmException

getApikey

public Apikey getApikey(java.lang.String apikey)
                 throws CosmException
Throws:
CosmException

getApikeys

public Apikey[] getApikeys()
                    throws CosmException
Throws:
CosmException

deleteApikey

public void deleteApikey(java.lang.String apikey)
                  throws CosmException
Throws:
CosmException

getTrigger

public Trigger getTrigger(java.lang.Integer id)
                   throws CosmException
Throws:
CosmException

getTriggers

public Trigger[] getTriggers()
                      throws CosmException
Throws:
CosmException

deleteTrigger

public void deleteTrigger(java.lang.Integer id)
                   throws CosmException
Throws:
CosmException

createTrigger

public Trigger createTrigger(Trigger trigger)
                      throws CosmException
Throws:
CosmException

updateTrigger

public void updateTrigger(Trigger trigger)
                   throws CosmException
Throws:
CosmException

getUser

public User getUser(java.lang.String login)
             throws CosmException
Throws:
CosmException

getUsers

public User[] getUsers()
                throws CosmException
Throws:
CosmException

deleteUser

public void deleteUser(java.lang.String login)
                throws CosmException
Throws:
CosmException

updateUser

public void updateUser(java.lang.String login,
                       User user)
                throws CosmException
Throws:
CosmException

createUser

public void createUser(User user)
                throws CosmException
Throws:
CosmException