org.postgresql.jdbc

Class ClientLogic

java.lang.Object

org.postgresql.jdbc.ClientLogic

public class ClientLogic
extends Object

Captures the client logic functionality to be exposed in the JDBC driver It uses the JNI interface as a back-end using the ClientLogicImpl class

Constructor Summary

Constructors

Constructor and Description
ClientLogic()

Method Summary

Modifier and Type	Method and Description
String	clientLogicMessage(String originalMessage) Applies client logic to extract client logic data inside error messages into user input
void	close() Closes the connection to the database
protected void	finalize() if finalize called make sure the connectiion is cloased
String	getStatementName()
boolean	isActive()
static boolean	isClientLogicField(int dataType) Check if oid of returned type is a client logic field
void	linkClientLogic(String databaseName, PgConnection jdbcConn) Link the client logic JNI & C side to the PgConnection instance
String	prepareQuery(String query, String statement_name) prepare a query
List<String>	replaceStatementParams(String statementName, List<String> paramValues) Replaces client logic parameter values in a prepared statement
String	runClientLogic(String data2Process, int dataType) Runs client logic on fields to get back the user format
void	runQueryPostProcess() Runs the post query function - executed after the query has completed
String	runQueryPreProcess(String originalQuery) Runs the pre-process function of the client logic to change the client logic fields from the user input to the client logic format

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientLogic

public ClientLogic()

Method Detail

close

public void close()

Closes the connection to the database

finalize

protected void finalize()

if finalize called make sure the connectiion is cloased

Overrides:

finalize in class Object

linkClientLogic

public void linkClientLogic(String databaseName,
                            PgConnection jdbcConn)
                     throws ClientLogicException

Link the client logic JNI & C side to the PgConnection instance

Parameters:

databaseName - database name

jdbcConn - the JDBC connection object to be used to select cache data with

Throws:

ClientLogicException

runQueryPreProcess

public String runQueryPreProcess(String originalQuery)
                          throws ClientLogicException

Runs the pre-process function of the client logic to change the client logic fields from the user input to the client logic format

Parameters:

originalQuery - query to modify with user input

Returns:

the modified query with client logic fields changed

Throws:

ClientLogicException

runQueryPostProcess

public void runQueryPostProcess()
                         throws ClientLogicException

Runs the post query function - executed after the query has completed

Throws:

ClientLogicException

runClientLogic

public String runClientLogic(String data2Process,
                             int dataType)
                      throws ClientLogicException

Runs client logic on fields to get back the user format

Parameters:

data2Process - the client logic data

dataType - the OID of the user data

Returns:

the data in user format

Throws:

ClientLogicException

isActive

public boolean isActive()

Returns:

true if the client logic instance is active (connected to the database) and false if it is not

isClientLogicField

public static boolean isClientLogicField(int dataType)

Check if oid of returned type is a client logic field

Parameters:

dataType - oid of data type

Returns:

true for client logic and false if it is not

prepareQuery

public String prepareQuery(String query,
                           String statement_name)
                    throws ClientLogicException

prepare a query

Parameters:

query - the query SQL

statement_name - the statement name

Returns:

the modified query

Throws:

ClientLogicException

replaceStatementParams

public List<String> replaceStatementParams(String statementName,
                                           List<String> paramValues)
                                    throws ClientLogicException

Replaces client logic parameter values in a prepared statement

Parameters:

statementName - the name of the statement - the one used in the prepareQuery method

paramValues - the list of current values

Returns:

list of modified parameters

Throws:

ClientLogicException

getStatementName

public String getStatementName()

Returns:

unique statement name that can be used for prepare statement.

clientLogicMessage

public String clientLogicMessage(String originalMessage)

Applies client logic to extract client logic data inside error messages into user input

Parameters:

originalMessage - the original message with client logic data

Returns: