|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IQuery
The base query interface to prepare and execute a query text to retrieve data. This base interface covers most basic query capabilities, such as returning data rows in a single result set, and may support scalar input parameters.
Note: An IQuery object must always be prepared before it can be executed. For example:
query.prepare( "SELECT * FROM TABLE" );
// prepare succeeded, no exception was thrown
query.executeQuery();
An input parameter may be referenced by name or position.
The case-sensitivity of a name is implementation-dependent.
All indices in this interface are 1-based.
Method Summary | |
---|---|
void |
clearInParameters()
An optional method to clear the current input parameter values immediately. |
void |
close()
Attempts to close this IQuery. |
IResultSet |
executeQuery()
Executes the query's prepared query text and returns a single IResultSet object. |
int |
findInParameter(java.lang.String parameterName)
Returns the 1-based index of the specified input parameter. |
int |
getMaxRows()
Returns the maximum number of rows that can be fetched from the query's result set(s). |
IResultSetMetaData |
getMetaData()
Returns the metadata of the current result set for this prepared IQuery. |
IParameterMetaData |
getParameterMetaData()
Returns the count, data types, and other metadata attributes of the parameters defined in this prepared IQuery object. |
SortSpec |
getSortSpec()
Returns the sort specification associated with this IQuery . |
void |
prepare(java.lang.String queryText)
Performs necessary checks to determine whether the query text is of a valid format supported by this IQuery implementation. |
void |
setAppContext(java.lang.Object context)
Sets the query context passed through from an application. |
void |
setBigDecimal(int parameterId,
java.math.BigDecimal value)
Sets the designated parameter to the given decimal value. |
void |
setBigDecimal(java.lang.String parameterName,
java.math.BigDecimal value)
Sets the designated parameter to the given decimal value. |
void |
setBoolean(int parameterId,
boolean value)
Sets the designated parameter to the given boolean value. |
void |
setBoolean(java.lang.String parameterName,
boolean value)
Sets the designated parameter to the given boolean value. |
void |
setDate(int parameterId,
java.sql.Date value)
Sets the designated parameter to the given Date value. |
void |
setDate(java.lang.String parameterName,
java.sql.Date value)
Sets the designated parameter to the given Date value. |
void |
setDouble(int parameterId,
double value)
Sets the designated parameter to the given double value. |
void |
setDouble(java.lang.String parameterName,
double value)
Sets the designated parameter to the given double value. |
void |
setInt(int parameterId,
int value)
Sets the designated parameter to the given integer value. |
void |
setInt(java.lang.String parameterName,
int value)
Sets the designated parameter to the given integer value. |
void |
setMaxRows(int max)
Specifies the maximum number of rows that can be fetched from the query's result set(s). |
void |
setNull(int parameterId)
Sets the designated parameter to a null value. |
void |
setNull(java.lang.String parameterName)
Sets the designated parameter to a null value. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets the named property with the specified value. |
void |
setSortSpec(SortSpec sortBy)
Specifies the sort specification for this IQuery . |
void |
setString(int parameterId,
java.lang.String value)
Sets the designated parameter to the given string value. |
void |
setString(java.lang.String parameterName,
java.lang.String value)
Sets the designated parameter to the given string value. |
void |
setTime(int parameterId,
java.sql.Time value)
Sets the designated parameter to the given Time value. |
void |
setTime(java.lang.String parameterName,
java.sql.Time value)
Sets the designated parameter to the given Time value. |
void |
setTimestamp(int parameterId,
java.sql.Timestamp value)
Sets the designated parameter to the given Timestamp value. |
void |
setTimestamp(java.lang.String parameterName,
java.sql.Timestamp value)
Sets the designated parameter to the given Timestamp value. |
Method Detail |
---|
void prepare(java.lang.String queryText) throws OdaException
queryText
- a query text to prepare or pre-compile;
it cannot be null.
OdaException
- if data source error occursvoid setAppContext(java.lang.Object context) throws OdaException
context
- Application context object of this instance.
OdaException
- if data source error occursvoid setProperty(java.lang.String name, java.lang.String value) throws OdaException
prepare(String)
, and
before executeQuery()
or other extended execution method(s).
name
- name of the property.value
- value to assign to the named property; may be null.
OdaException
- if data source error occursvoid close() throws OdaException
OdaException
- if data source error occursvoid setMaxRows(int max) throws OdaException
max
- the maximum number of rows that can be fetched from each
result set of this IQuery; zero means there is no limit.
OdaException
- if data source error occursint getMaxRows() throws OdaException
OdaException
- if data source error occursIResultSetMetaData getMetaData() throws OdaException
OdaException
- if data source error occursIResultSet executeQuery() throws OdaException
OdaException
- if data source error occursvoid clearInParameters() throws OdaException
In general, input parameter values remain in force for repeated use of a query. Setting a parameter value automatically clears its previous value. However, to reset all the parameters to their default values without explicitly setting new values, use this method.
OdaException
- if data source error occurs
java.lang.UnsupportedOperationException
- if this operation is not supportedvoid setInt(java.lang.String parameterName, int value) throws OdaException
parameterName
- name of the parameter.value
- integer value.
OdaException
- if data source error occursvoid setInt(int parameterId, int value) throws OdaException
parameterId
- id of the parameter (1-based).value
- integer value.
OdaException
- if data source error occursvoid setDouble(java.lang.String parameterName, double value) throws OdaException
parameterName
- name of the parameter.value
- double value.
OdaException
- if data source error occursvoid setDouble(int parameterId, double value) throws OdaException
parameterId
- id of the parameter (1-based).value
- double value.
OdaException
- if data source error occursvoid setBigDecimal(java.lang.String parameterName, java.math.BigDecimal value) throws OdaException
parameterName
- name of the parameter.value
- decimal value.
OdaException
- if data source error occursvoid setBigDecimal(int parameterId, java.math.BigDecimal value) throws OdaException
parameterId
- id of the parameter (1-based).value
- decimal value.
OdaException
- if data source error occursvoid setString(java.lang.String parameterName, java.lang.String value) throws OdaException
parameterName
- name of the parameter.value
- string value.
OdaException
- if data source error occursvoid setString(int parameterId, java.lang.String value) throws OdaException
parameterId
- id of the parameter (1-based).value
- string value.
OdaException
- if data source error occursvoid setDate(java.lang.String parameterName, java.sql.Date value) throws OdaException
parameterName
- name of the parameter.value
- the java.sql.Date value.
OdaException
- if data source error occursvoid setDate(int parameterId, java.sql.Date value) throws OdaException
parameterId
- id of the parameter (1-based).value
- the java.sql.Date value.
OdaException
- if data source error occursvoid setTime(java.lang.String parameterName, java.sql.Time value) throws OdaException
parameterName
- name of the parameter.value
- the java.sql.Time value.
OdaException
- if data source error occursvoid setTime(int parameterId, java.sql.Time value) throws OdaException
parameterId
- id of the parameter (1-based).value
- the java.sql.Time value.
OdaException
- if data source error occursvoid setTimestamp(java.lang.String parameterName, java.sql.Timestamp value) throws OdaException
parameterName
- name of the parameter.value
- the java.sql.Timestamp value.
OdaException
- if data source error occursvoid setTimestamp(int parameterId, java.sql.Timestamp value) throws OdaException
parameterId
- id of the parameter (1-based).value
- the java.sql.Timestamp value.
OdaException
- if data source error occursvoid setBoolean(java.lang.String parameterName, boolean value) throws OdaException
parameterName
- name of the parameter.value
- boolean value.
OdaException
- if data source error occursvoid setBoolean(int parameterId, boolean value) throws OdaException
parameterId
- id of the parameter (1-based).value
- boolean value
OdaException
- if data source error occursvoid setNull(java.lang.String parameterName) throws OdaException
parameterName
- name of the parameter.
OdaException
- if data source error occursvoid setNull(int parameterId) throws OdaException
parameterId
- id of the parameter (1-based).
OdaException
- if data source error occursint findInParameter(java.lang.String parameterName) throws OdaException
parameterName
- name of the parameter.
OdaException
- if data source error occursIParameterMetaData getParameterMetaData() throws OdaException
Note: This should only be called after prepare() is called.
OdaException
- if data source error occursvoid setSortSpec(SortSpec sortBy) throws OdaException
IQuery
.
This method must be called before this IQuery
is executed
or before IAdvancedQuery.getMoreResults()
is called.
More sort keys can be added to the SortSpec after
it is associated with the query.
The final sort specification is then applied
to subsequent result set(s) at execution.
It is up to individual ODA runtme drivers to validate the type of sort specification
that are acceptable to its data provider, based on its level
of dynamic sorting support.
An OdaException
should be thrown if the specified sort
specification is not valid or not supported by the driver.
sortBy
- the sort specification assigned to this IQuery
.
OdaException
- if data source error occursSortSpec getSortSpec() throws OdaException
IQuery
.
SortSpec
assigned to this IQuery
;
null
if no SortSpec
was explicitly set.
OdaException
- if data source error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |