Query (Basic Query Application)

java.lang.Object
- us.daveread.basicquery.queries.Query

```
public class Query
extends java.lang.Object
```
Title: Query
Description: Represents an individual SQL statement. For BasicQuery this is both the SQL statement and the mode (select or update) that is used when executing the statement.

Copyright: Copyright (c) 2004-2014, David Read

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author:

David Read

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`mode` The mode for this statement
`static int`	`MODE_DESCRIBE` Represents a select-type statement (e.g.
`static int`	`MODE_QUERY` Represents a select-type statement (e.g.
`static int`	`MODE_UPDATE` Represents and update-type statement (e.g.
`private java.lang.String`	`rawSqlStatement` The raw statement (e.g.
`private java.lang.String`	`sqlStatement` The SQL statement

Constructor Summary

Constructors
Constructor and Description
`Query(java.lang.String aRawSql)` Constructs a Query Assumes the mode is a select statement (returns result set)
`Query(java.lang.String aRawSql, int aMode)` Constructs a Query to perform the operation specified by the mode

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)`
`boolean`	`equals(Query query)` Check whether this Query instance is equavalent to another.
`int`	`getMode()` Returns the Query Mode
`java.lang.String`	`getRawSql()` The Raw SQL statement as entered, potentially contains carriage returns
`java.lang.String`	`getSql()` Returns the SQL string
`int`	`hashCode()`
`boolean`	`isCommented()` Is the statement commented out
`void`	`setMode(int aMode)` Set the mode value to aMode depending on whether the user wants to update,describe or query
`private void`	`setSql(java.lang.String aRawSql)` Set the SQL statement for this query to wrap
`java.lang.String`	`toString()` Returns the SQL statement as a string

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MODE_QUERY
```
public static final int MODE_QUERY
```
    Represents a select-type statement (e.g. produces a result set)
    
    See Also:
    Constant Field Values
  - MODE_UPDATE
```
public static final int MODE_UPDATE
```
    Represents and update-type statement (e.g. changes the data with no result set)
    
    See Also:
    Constant Field Values
  - MODE_DESCRIBE
```
public static final int MODE_DESCRIBE
```
    Represents a select-type statement (e.g. produces a result set) but reports the metadata from the result set instead of the data
    
    See Also:
    Constant Field Values
  - sqlStatement
```
private java.lang.String sqlStatement
```
    The SQL statement
  - mode
```
private int mode
```
    The mode for this statement
  - rawSqlStatement
```
private java.lang.String rawSqlStatement
```
    The raw statement (e.g. as entered by the user - potentially with carriage returns embedded)
- Constructor Detail
  - Query
```
public Query(java.lang.String aRawSql)
```
    Constructs a Query Assumes the mode is a select statement (returns result set)
    
    Parameters:
    aRawSql - The String to be queried
  - Query
```
public Query(java.lang.String aRawSql,
     int aMode)
```
    Constructs a Query to perform the operation specified by the mode
    
    Parameters:
    aRawSql - The SQL statement
    aMode - The mode value
- Method Detail
  - setMode
```
public void setMode(int aMode)
```
    Set the mode value to aMode depending on whether the user wants to update,describe or query
    
    Parameters:
    aMode - The mode value that is set
  - setSql
```
private void setSql(java.lang.String aRawSql)
```
    Set the SQL statement for this query to wrap
    
    Parameters:
    aRawSql - The SQL statement
  - getSql
```
public java.lang.String getSql()
```
    Returns the SQL string
    
    Returns:
    String
  - isCommented
```
public boolean isCommented()
```
    Is the statement commented out
    
    Returns:
    True if the statement is commented out
  - getRawSql
```
public java.lang.String getRawSql()
```
    The Raw SQL statement as entered, potentially contains carriage returns
    
    Returns:
    The raw SQL statement
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - equals
```
public boolean equals(Query query)
```
    Check whether this Query instance is equavalent to another. Equivalence is true if the SQL statements are the same
    
    Parameters:
    query - A query to compare to this query
    
    Returns:
    True if the queries are equivalent
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getMode
```
public int getMode()
```
    Returns the Query Mode
    
    Returns:
    The query mode
  - toString
```
public java.lang.String toString()
```
    Returns the SQL statement as a string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    The SQL statement

Class Query

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_QUERY

MODE_UPDATE

MODE_DESCRIBE

sqlStatement

mode

rawSqlStatement

Constructor Detail

Query

Query

Method Detail

setMode

setSql

getSql

isCommented

getRawSql

equals

equals

hashCode

getMode

toString