oracle.ifs.server

Class LibraryQueryStatement

java.lang.Object

oracle.ifs.server.LibraryQueryStatement

public final class LibraryQueryStatement
extends Object

A LibraryQueryStatement is used to generate JDBC PreparedStatements for select statements.

Version:

2.0

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static int	INHERENT_PARAMS_PER_PUBLIC_CLASS The maximum inherent parameters used per PublicObject class.

Constructor Summary

Constructors

Constructor and Description
LibraryQueryStatement(String key, LibraryConnection lconn, SearchTarget[] targets, ColumnDescriptor[] colDescs, String joinCondition, String whereClause, SortSpecification sort, String hint, int maxCopies, int maxItemCount) Constructs a LibraryQueryStatement.
LibraryQueryStatement(String key, LibraryConnection lconn, SearchTarget[] targets, String whereClause, SortSpecification sort, boolean countOnly, boolean distinct, int maxCopies) Constructs a LibraryQueryStatement.
LibraryQueryStatement(String key, LibraryConnection lconn, SearchTarget[] targets, String whereClause, SortSpecification sort, String hint, boolean countOnly, boolean distinct, int maxCopies) Constructs a LibraryQueryStatement.
LibraryQueryStatement(String key, LibraryConnection lconn, SearchTarget[] targets, String joinCondition, String whereClause, SortSpecification sort, String hint, boolean countOnly, boolean distinct, int maxCopies, int maxItemCount) Constructs a LibraryQueryStatement.

Method Summary

Modifier and Type	Method and Description
void	close() Close and clear the Prepared statement.
static String	concatWhereClause(String str1, String str2) Concatenates two where clauses.
int	getAccessCount() Get the number of times the statement has been accessed
long	getAccessSequence() Gets the last access sequence; used by LibraryConnection for purging.
protected S_ClassObjectData	getClassData(S_LibrarySession session, Long classId) Gets the ClassData object for the specified class ID.
String	getKey() Gets the key by which this LibraryQueryStatement is stored in the LibraryConnection.
LibraryConnection	getLibraryConnection() Gets the LibraryConnection for this LibraryQueryStatement.
int	getMaxCopiesPerConnection() Gets the maximum number of copies of this LibraryQueryStatement that will be cached by each LibraryConnection.
int	getParamOffset(S_LibrarySession sess) Return the index of the first param that represents user-defined parameters.
long	getRsn() Get the resolution sequence number of this instance, which reflects the RSN of the LibraryConnection at the time this instance was constructed.
PreparedStatement	getStatement(S_LibrarySession sess) Return the Prepared statement.
int	incrementAccessCount() Increment the number of times the statement has been accessed.
static boolean	obtainRowLockByIdWithNowait(S_LibrarySession session, String tablename, String columnname, Long id) Issues a SQL statement that will lock a row in table.
void	setAccessSequence(long seq) Sets the last access sequence; used by LibraryConnection for purging.
int	setInherentParameters(S_LibrarySession sess) Sets the parameters that are not user-defined.
int	setInherentParameters(S_LibrarySession sess, int initialOffset) Sets the parameters that are not user-defined.

Methods inherited from class java.lang.Object

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

Field Detail

INHERENT_PARAMS_PER_PUBLIC_CLASS

public static final int INHERENT_PARAMS_PER_PUBLIC_CLASS

The maximum inherent parameters used per PublicObject class.

Currently has the value of 2.

See Also:

Constant Field Values

Constructor Detail

LibraryQueryStatement

public LibraryQueryStatement(String key,
                             LibraryConnection lconn,
                             SearchTarget[] targets,
                             String whereClause,
                             SortSpecification sort,
                             boolean countOnly,
                             boolean distinct,
                             int maxCopies)
                      throws IfsException

Constructs a LibraryQueryStatement.

Parameters:

key - statement key

lconn - the connection context

targets - the search targets; must be at least one

whereClause - the search condition

sort - the sort condition

countOnly - whether to select the count only

distinct - whether to include a distinct clause

maxCopies - max copies of the statement per connection

Throws:

IfsException - if the operation fails

LibraryQueryStatement

public LibraryQueryStatement(String key,
                             LibraryConnection lconn,
                             SearchTarget[] targets,
                             String whereClause,
                             SortSpecification sort,
                             String hint,
                             boolean countOnly,
                             boolean distinct,
                             int maxCopies)
                      throws IfsException

Constructs a LibraryQueryStatement.

Parameters:

key - statement key

lconn - the connection context

targets - the search targets; must be at least one

whereClause - the search condition

sort - the sort condition

hint - the SQL hint for the main select

countOnly - whether to select the count only

distinct - whether to include a distinct clause

maxCopies - max copies of the statement per connection

Throws:

IfsException - if the operation fails

LibraryQueryStatement

public LibraryQueryStatement(String key,
                             LibraryConnection lconn,
                             SearchTarget[] targets,
                             String joinCondition,
                             String whereClause,
                             SortSpecification sort,
                             String hint,
                             boolean countOnly,
                             boolean distinct,
                             int maxCopies,
                             int maxItemCount)
                      throws IfsException

Constructs a LibraryQueryStatement.

This is the main variant.

Parameters:

key - statement key

lconn - the connection context

targets - the search targets; must be at least one

joinCondition - the join condition

whereClause - the search condition

sort - the sort condition

hint - the SQL hint for the main select

countOnly - whether to select the count only

distinct - whether to include a distinct clause

maxCopies - max copies of the statement per connection

maxItemCount - max number of items to select

Throws:

IfsException - if the operation fails

LibraryQueryStatement

public LibraryQueryStatement(String key,
                             LibraryConnection lconn,
                             SearchTarget[] targets,
                             ColumnDescriptor[] colDescs,
                             String joinCondition,
                             String whereClause,
                             SortSpecification sort,
                             String hint,
                             int maxCopies,
                             int maxItemCount)
                      throws IfsException

Constructs a LibraryQueryStatement.

This is the variant used for getSearchResults().

Parameters:

lconn - the connection context

targets - the search targets; must be at least one

colDescs - the column descriptors

joinCondition - the join condition

whereClause - the search condition

sort - the sort condition

hint - the SQL hint for the main select

maxCopies - max copies of the statement per connection

maxItemCount - max number of items to select

Throws:

IfsException - if the operation fails

Method Detail

setAccessSequence

public final void setAccessSequence(long seq)

Sets the last access sequence; used by LibraryConnection for purging.

Parameters:

seq - the Access Sequence

getAccessSequence

public final long getAccessSequence()

Gets the last access sequence; used by LibraryConnection for purging.

Returns:

the Access Sequence

getKey

public final String getKey()

Gets the key by which this LibraryQueryStatement is stored in the LibraryConnection.

Returns:

the key

getLibraryConnection

public final LibraryConnection getLibraryConnection()

Gets the LibraryConnection for this LibraryQueryStatement.

Returns:

the LibraryConnection

getRsn

public long getRsn()

Get the resolution sequence number of this instance, which reflects the RSN of the LibraryConnection at the time this instance was constructed.

Returns:

the resolution sequence number

getMaxCopiesPerConnection

public final int getMaxCopiesPerConnection()

Gets the maximum number of copies of this LibraryQueryStatement that will be cached by each LibraryConnection.

Returns:

the maximum number of copies to keep

getAccessCount

public int getAccessCount()

Get the number of times the statement has been accessed

Returns:

the number of times the statement has been accessed

incrementAccessCount

public int incrementAccessCount()

Increment the number of times the statement has been accessed.

Returns:

the updated count of the number of times the statement has been accessed

getStatement

public PreparedStatement getStatement(S_LibrarySession sess)
                               throws IfsException

Return the Prepared statement.

Parameters:

sess - the session context

Returns:

the Prepared statement

Throws:

IfsException - if the operation fails

close

public void close()

Close and clear the Prepared statement.

getClassData

protected S_ClassObjectData getClassData(S_LibrarySession session,
                                         Long classId)
                                  throws IfsException

Gets the ClassData object for the specified class ID.

Parameters:

session - the session context

classId - the class ID

Returns:

the object's class's Data object for specified class

Throws:

IfsException - if operation fails.

getParamOffset

public int getParamOffset(S_LibrarySession sess)
                   throws IfsException

Return the index of the first param that represents user-defined parameters.

This is directly related to the number of PublicObject classes in the classes list.

Parameters:

sess - the session context

Returns:

the parameter offset

Throws:

IfsException - if the operation fails

setInherentParameters

public int setInherentParameters(S_LibrarySession sess)
                          throws IfsException

Sets the parameters that are not user-defined.

Sets any parameters in the query that pertain to PublicObject security clauses.

Parameters:

sess - the session context

Returns:

the bind position offset for the rest of the bind values

Throws:

IfsException - if the operation fails

setInherentParameters

public int setInherentParameters(S_LibrarySession sess,
                                 int initialOffset)
                          throws IfsException

Sets the parameters that are not user-defined.

Sets any parameters in the query that pertain to PublicObject security clauses.

Parameters:

sess - the session context

initialOffset - the initial bind position offset

Returns:

the bind position offset for the rest of the bind values

Throws:

IfsException - if the operation fails

concatWhereClause

public static String concatWhereClause(String str1,
                                       String str2)

Concatenates two where clauses.

Parameters:

str1 - the first clause

str2 - the second clause

Returns:

the concatenated clause

obtainRowLockByIdWithNowait

public static boolean obtainRowLockByIdWithNowait(S_LibrarySession session,
                                                  String tablename,
                                                  String columnname,
                                                  Long id)
                                           throws IfsException

Issues a SQL statement that will lock a row in table. the caller specifies the table name and the ID column, along with an ID value. A database lock is attempted by issuing a "Select ... For Update nowait". This will throw an IfsException if the select is unsuccessful.

Parameters:

session - the requesting session

tablename - the database table name

columnname - the ID column in the specified table

id - the ID value

Returns:

whether there was a row with the specified id

Throws:

IfsException - 20011: if unable to obtain the lock