Top Description Fields Constructors Methods
org.apache.derby.client.am.stmtcache

public Class StatementKey

extends Object
Class Inheritance
Imports
java.sql.ResultSet, .Statement, org.apache.derby.shared.common.sanity.SanityManager

A key representing a java.sql.PreparedStatement or a java.sql.CallableStatement.

The key takes a number of statement related attributes into account, and is used to insert and look up cached statement objects in the JDBC statement cache.

Key instances are created by a statement key factory.

See Also
StatementKeyFactory

Field Summary

Modifier and TypeField and Description
private final int
autogeneratedKeys

Tells if the associated statement returns auto-generated keys.

private final int
concurrency

The result set concurrency for the statement.

private final int
holdability

Result set holdability for the statement.

private final boolean
isCallableStatement

Tells if the key represents a CallableStatement.

private final String
schema

The compilation schema for the statement.

private final String
sql

The SQL query of the statement.

private final int
type

The result set type for the statement.

Constructor Summary

AccessConstructor and Description
pack-priv
StatementKey(boolean
true is this is a key for a java.sql.CallableStatement
isCallableStatement
,
String
SQL query string
sql
,
String
compilation schema
schema
,
int
result set type
rsType
,
int
result set concurrency
rsConcurrency
,
int
result set holdability
rsHoldability
,
int
if auto-generated keys are returned
autogeneratedKeys
)

Creates a statement key with all the common properties.

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

autogeneratedKeysback to summary
private final int autogeneratedKeys

Tells if the associated statement returns auto-generated keys.

concurrencyback to summary
private final int concurrency

The result set concurrency for the statement.

holdabilityback to summary
private final int holdability

Result set holdability for the statement.

isCallableStatementback to summary
private final boolean isCallableStatement

Tells if the key represents a CallableStatement.

schemaback to summary
private final String schema

The compilation schema for the statement.

sqlback to summary
private final String sql

The SQL query of the statement.

typeback to summary
private final int type

The result set type for the statement.

Constructor Detail

StatementKeyback to summary
pack-priv StatementKey(boolean isCallableStatement, String sql, String schema, int rsType, int rsConcurrency, int rsHoldability, int autogeneratedKeys)

Creates a statement key with all the common properties.

Parameters
isCallableStatement:boolean

true is this is a key for a java.sql.CallableStatement

sql:String

SQL query string

schema:String

compilation schema

rsType:int

result set type

rsConcurrency:int

result set concurrency

rsHoldability:int

result set holdability

autogeneratedKeys:int

if auto-generated keys are returned

Exceptions
IllegalArgumentException:
if schema is null

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.