Skip navigation links

com.sigmadynamics.server.DataServices.DatabaseProvider
Interface Where

All Known Subinterfaces:

TableDeleter, TableReader, TableUpdater

public interface Where

Interface that provides Where clause handling.

Field Summary

static int	AND
static int	OR

Method Summary

void	close()
void	initWhere(java.lang.String[] columns, int type) Set up WHERE constraints.
void	initWhere(java.lang.String[] columns, java.lang.String whereClause) Set up WHERE constraints.
void	setDateWhereArg(int index, long value) Sets the value of a where constraint.
void	setDateWhereArg(int index, long value, java.util.Calendar cal) Provides data to be inserted into a DATE, TIME or TIMESTAMP column.
void	setWhereArg(int index, double value) Set the bind var value of a where constraint.
void	setWhereArg(int index, int value) set the bind var value of a where constraint.
void	setWhereArg(int index, long value) set the bind var value of a where constraint.
void	setWhereArg(int index, java.lang.String value) Set the bind var value of a where constraint.

Field Detail

AND

static final int AND

See Also:

Constant Field Values

OR

static final int OR

See Also:

Constant Field Values

Method Detail

initWhere

void initWhere(java.lang.String[] columns,
               int type)
               throws DatabaseProviderException

Set up WHERE constraints.

Call this method to pass in the columns to be used for WHERE clause constraints. The columns will be tested for equality to values set by subsequent calls to setWhere. You pass in the columns and a flag to indicate whether you want intersection or union of the constraints. The array of column names are used to build a string with the column names (after any case sensitive handling) and placemarkers. The placemarkers will be replaced with values set in subsequent setWhere calls.

For example, if you pass an array that holds "Fred" and "Barney" and use the Where.AND flag, then it will generate "WHERE Fred=? AND Barney=?".

Parameters:

columns - the column names

type - either Where.AND or Where.OR to indicate to AND or OR the constraints

Throws:

DatabaseProviderException

initWhere

void initWhere(java.lang.String[] columns,
               java.lang.String whereClause)
               throws DatabaseProviderException

Set up WHERE constraints.

Call this method to pass in the columns to be used for WHERE clause constraints. You pass in the columns and a string that is used to build the Sql Where. The string has the following features:

• a '?' is used as a placemarker that will be bound to a value passed through a call to a setWhereArg.
• a '#' is used as a placemarker for a column name. The column name comes from the array of column names after any necessary handling for case sensitivity. E.g. the first '#' is replaced with a column name from the first array element, etc.
• is does not contain the string "WHERE"

  Here's an example: You pass in an array with 3 column names and the string is "#>? AND NOT (#=? OR #=?)".

  Parameters:

  columns - the column names

  whereClause - the string containing the WHERE clause with placemarkers as described above

  Throws:

  DatabaseProviderException

  setWhereArg

  void setWhereArg(int index,
                   java.lang.String value)
                   throws DatabaseProviderException
  

  Set the bind var value of a where constraint.

  Call this to set the bind variable. Basically, this is setting the value for the '?' placemarkers that are described for the initWhere calls.

  Parameters:

  index - the ordinal number of the placemarker being set

  value - the value

  Throws:

  DatabaseProviderException

  setWhereArg

  void setWhereArg(int index,
                   double value)
                   throws DatabaseProviderException
  

  Set the bind var value of a where constraint.

  Call this to set the bind variable. Basically, this is setting the value for the '?' placemarkers that are described for the initWhere calls.

  Parameters:

  index - the ordinal number of the placemarker being set

  value - the value

  Throws:

  DatabaseProviderException

  setWhereArg

  void setWhereArg(int index,
                   long value)
                   throws DatabaseProviderException
  

  set the bind var value of a where constraint.

  Call this to set the bind variable. Basically, this is setting the value for the '?' placemarkers that are described for the initWhere calls.

  Parameters:

  index - the ordinal number of the placemarker being set

  value - the value

  Throws:

  DatabaseProviderException

  setWhereArg

  void setWhereArg(int index,
                   int value)
                   throws DatabaseProviderException
  

  set the bind var value of a where constraint.

  Call this to set the bind variable. Basically, this is setting the value for the '?' placemarkers that are described for the initWhere calls.

  Parameters:

  index - the ordinal number of the placemarker being set

  value - the value

  Throws:

  DatabaseProviderException

  setDateWhereArg

  void setDateWhereArg(int index,
                       long value)
                       throws DatabaseProviderException
  

  Sets the value of a where constraint.

  Call this to set the value for an individual WHERE condition. Basically, this is setting the value for the '?' placemarkers that are described for the initWhere calls.

  If the database column stores timezone information, then this information will be taken into account when matching the values stored in the database against the value in the WHERE condition. If the database column does not store timezone information, then the values stored in the database are assumed to be in UTC.

  Parameters:

  index - the ordinal number of the placemarker being set.

  value - the date/time value, measured in milliseconds since midnight, January 1, 1970 UTC.

  Throws:

  DatabaseProviderException

  setDateWhereArg

  void setDateWhereArg(int index,
                       long value,
                       java.util.Calendar cal)
                       throws DatabaseProviderException
  

  Provides data to be inserted into a DATE, TIME or TIMESTAMP column.

  Provides the data to be inserted into the database on the next call to insert. The data will be put into the column identified by the column parameter. The parameter is the index into the array of columns that was passed to getTableInserter. That is, if fred is the 5th element of the array, then passing 5 as the first parameter of this method will set the fred column.

  If the database column stores timezone information, then this information will be taken into account when matching the values stored in the database against the value in the WHERE condition. The cal parameter in this case has no effect on the result of the query. If the database column does not store timezone information, then the values stored in the database are assumed to be in the timezone specified by the cal parameter.

  Parameters:

  index - the column index as described above

  value - the value to insert, measured in milliseconds since midnight, January 1, 1970 UTC.

  cal - a Calendar specifying the timezone of the date in the database.

  Throws:

  DatabaseProviderException

  close

  void close()