org.apache.xalan.lib.sql

Class SQLQueryParser


public class SQLQueryParser
extends java.lang.Object

This is used by the SQLDocumentHandler for processing JDBC queries. This prepares JDBC PreparedStatement or CallableStatements and the input/output of parameters from/to variables.

Field Summary

static int
INLINE_PARSER
static int
NO_INLINE_PARSER
static int
NO_OVERRIDE

Constructor Summary

SQLQueryParser()
The SQLStatement Parser will be created as a psuedo SINGLETON per XConnection.

Method Summary

Vector
getParameters()
String
getSQLQuery()
Return a copy of the parsed SQL query that will be set to the Database system to execute.
boolean
hasParameters()
If a SQL Statement does not have any parameters, then it can be executed directly.
boolean
isCallable()
If the Inline Parser is used, the parser will note if this stastement is a plain SQL Statement or a Called Procedure.
SQLQueryParser
parse(XConnection xconn, String query, int override)
Produce an SQL Statement Parser based on the incomming query.
void
populateStatement(PreparedStatement stmt, ExpressionContext ctx)
The SQL Statement Parser, when an Inline Parser is used, tracks the XSL variables used to populate a statement.
void
registerOutputParameters(CallableStatement cstmt)
void
setParameters(Vector p)
The XConnection will use this method to store the Parameters that were supplied by the style sheet in the case where the inline parser was not used

Field Details

INLINE_PARSER

public static final int INLINE_PARSER
Field Value:
2

NO_INLINE_PARSER

public static final int NO_INLINE_PARSER
Field Value:
1

NO_OVERRIDE

public static final int NO_OVERRIDE
Field Value:
0

Constructor Details

SQLQueryParser

public SQLQueryParser()
The SQLStatement Parser will be created as a psuedo SINGLETON per XConnection. Since we are only caching the Query and its parsed results we may be able to use this as a real SINGLETON. It all depends on how Statement Caching will play out.

Method Details

getParameters

public Vector getParameters()

getSQLQuery

public String getSQLQuery()
Return a copy of the parsed SQL query that will be set to the Database system to execute. If the inline parser was not used, then the original query will be returned.

hasParameters

public boolean hasParameters()
If a SQL Statement does not have any parameters, then it can be executed directly. Most SQL Servers use this as a performance advantage since no parameters need to be parsed then bound.

isCallable

public boolean isCallable()
If the Inline Parser is used, the parser will note if this stastement is a plain SQL Statement or a Called Procedure. Called Procudures generally have output parameters and require special handling. Called Procudures that are not processed with the Inline Parser will still be executed but under the context of a PreparedStatement and not a CallableStatement. Called Procudures that have output parameters MUST be handled with the Inline Parser.

parse

public SQLQueryParser parse(XConnection xconn,
                            String query,
                            int override)
Produce an SQL Statement Parser based on the incomming query. For now we will just create a new object, in the future we may have this interface cache the queries so that we can take advantage of a preparsed String. If the Inline Parser is not enabled in the Options, no action will be taken on the parser. This option can be set by the Stylesheet. If the option is not set or cleared, a default value will be set determined by the way variables were passed into the system.

populateStatement

public void populateStatement(PreparedStatement stmt,
                              ExpressionContext ctx)
The SQL Statement Parser, when an Inline Parser is used, tracks the XSL variables used to populate a statement. The data use to popoulate a can also be provided. If the data is provided, it will overide the populastion using XSL variables. When the Inline PArser is not used, then the Data will always be provided.

registerOutputParameters

public void registerOutputParameters(CallableStatement cstmt)
            throws SQLException

setParameters

public void setParameters(Vector p)
The XConnection will use this method to store the Parameters that were supplied by the style sheet in the case where the inline parser was not used

Copyright © 2006 Apache XML Project. All Rights Reserved.