com.orange.api.session

Class OrangeUser

java.lang.Object

com.orange.api.session.OrangeUser

public class OrangeUser
extends java.lang.Object

Author:

Gulliver Johnson

Constructor Summary

Constructors

Constructor and Description
OrangeUser(java.lang.String username, java.lang.String password) Instantiates an connetion to the database containing user details in order to allow for personal data retrieval.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getMyIDs() Returns the global_ids of all of the authenticated user's sensors.
int[]	getMyIDs(int[] sensor_ids) Returns the global_ids of all of the authenticated user's sensors filtered by a collection of internal IDs.
int[]	getMyIDsWhere(java.lang.String[] cols, java.lang.String[] args) Returns the global_ids of all of the authenticated user's sensors filtered by a set of columns and their respective arguments.
int[]	getMyIDsWhere(java.lang.String col, java.lang.String arg) Returns the global_ids of all of the authenticated user's sensors filtered by a column and its value argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrangeUser

public OrangeUser(java.lang.String username,
          java.lang.String password)
           throws java.sql.SQLException

Instantiates an connetion to the database containing user details in order to allow for personal data retrieval.

Parameters:

username - the company name chosen at user registration

password - the password chosen at user registration

Throws:

java.sql.SQLException - if a connection to the database couldn't be made

Method Detail

getMyIDs

public int[] getMyIDs()
               throws java.sql.SQLException

Returns the global_ids of all of the authenticated user's sensors.

Returns:

an array containing all global_ids of sensors belonging to the user

Throws:

java.sql.SQLException - if a connection to the database couldn't be made

getMyIDs

public int[] getMyIDs(int[] sensor_ids)
               throws java.sql.SQLException

Returns the global_ids of all of the authenticated user's sensors filtered by a collection of internal IDs. Aside from unique, global_id, each sensor has an ID number describing the order in which it was created for its owner. The first sensor that a new user registers will always have sensor_id = 1, whilst its global_id will be set to one higher than the sensor created (by any user) before it.

Parameters:

sensor_ids - an array containing a collection of sensor_ids describing sensors registered by the user

Returns:

an array containing all global_ids of sensors belonging to the user which match the filtering set

Throws:

java.sql.SQLException - if a connection to the database couldn't be made

getMyIDsWhere

public int[] getMyIDsWhere(java.lang.String col,
                  java.lang.String arg)
                    throws java.sql.SQLException

Returns the global_ids of all of the authenticated user's sensors filtered by a column and its value argument. The columns used are limited to 'application', 'measures', and 'unit'.

Parameters:

col - the column to filter by. One of 'application', 'measures', or 'unit'

arg - the argument to filter by

Returns:

an array containing all global_ids of sensors belonging to the user which match the filtering column argument

Throws:

java.sql.SQLException - if a connection to the database couldn't be made.

getMyIDsWhere

public int[] getMyIDsWhere(java.lang.String[] cols,
                  java.lang.String[] args)
                    throws java.sql.SQLException

Returns the global_ids of all of the authenticated user's sensors filtered by a set of columns and their respective arguments.

Parameters:

cols - the columns to filter by

args - the respective arguments to filter by

Returns:

an array containing all global_ids of sensors belonging to the user which match the filter

Throws:

java.sql.SQLException - if a connection to the database couldn't be made