Modifier and Type	Class and Description
pack-priv static class	SignatureChecker.ParsedArgs
pack-priv class	SignatureChecker.SQLRoutine

Modifier and Type	Field and Description
private final boolean	_debugging
private final ArrayList<SignatureChecker.SQLRoutine>	_functions
private static LocalizedResource	_messageFormatter
private final SignatureChecker.ParsedArgs	_parsedArgs
private final ArrayList<SignatureChecker.SQLRoutine>	_procedures
private static final String[]	SYSTEM_SCHEMAS
private static final String	WILDCARD

Access	Constructor and Description
private	SignatureChecker(SignatureChecker.ParsedArgs parsedArgs)

Method Summary

Modifier and Type	Method and Description
private void	checkSignature(Connection The connection to the database conn, String The SQL to prepare query, String the signature: printed if prepare fails readableSignature) Prepared a routine invocation in order to check whether it matches a Java method.
private void	countFunctionArgs(DatabaseMetaData the database metadata of the database dbmd) Count up the arguments to the user-coded procedures.
private void	countProcedureArgs(DatabaseMetaData the database metadata of the database dbmd) Count up the arguments to the user-coded procedures in `_procedures` and update that data structure accordingly
private void	execute() Get a connection to a database and then match the signatures of routines in that database.
private void	findFunctions(DatabaseMetaData the database metadata of the database dbmd) Find all of the user-declared functions.
private void	findProcedures(DatabaseMetaData the database metadata of the database dbmd) Find all of the user-declared procedures.
private static String	Returns: A localized message formatMessage(String The message key by which we located the localized text key, Object... Any arguments to the localized text to be filled in args) Format a localizable message.
private SignatureChecker.SQLRoutine	Returns: a function descriptor getFunction(int The index of the procedure in `_functions`. idx) Get a function descriptor from `_functions` .
private Connection	Returns: a connection to the database getJ2SEConnection() We use reflection to get the J2SE connection so that references to DriverManager will not generate linkage errors on old J2ME platforms which may resolve references eagerly.
private static LocalizedResource	Returns: localized resource getMessageFormatter() Get the message resource.
private SignatureChecker.SQLRoutine	Returns: a procedure descriptor getProcedure(int The index of the procedure in `_procedures`. idx) Get a procedure descriptor from `_procedures`.
private boolean	Returns: `true` if the schema is a system schema isSystemSchema(String the schema to check schema) Return true if the schema is a system schema.
public static void	main(String[] args)
private String	Returns: human readable string makeReadableSignature(SignatureChecker.SQLRoutine the routine for which we want a signature routine) Make a human readable signature for a routine.
private void	matchFunctions(Connection The connection to use to access the database conn) Match the signatures of functions in this database.
private void	matchProcedures(Connection The connection to use to access the database conn) Match the signatures of procedures in this database.
private void	matchSignatures(Connection This connection conn) Match the signatures of routines in the database attached to this connection.
private PreparedStatement	prepareStatement(Connection conn, String text)
private static void	println(String text)
private static void	printThrowable(Throwable t)
private static void	printUsage()
private void	putFunction(String The schema of the function schema, String The name of the function name, boolean `true` iff the function is a table function isTableFunction) Store a function descriptor.
private void	putProcedure(String schema of the procedure schema, String of a procedure name) Store a procedure descriptor.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_debugging	back to summary
private final boolean _debugging

_functions	back to summary
private final ArrayList<SignatureChecker.SQLRoutine> _functions

_messageFormatter	back to summary
private static LocalizedResource _messageFormatter

_parsedArgs	back to summary
private final SignatureChecker.ParsedArgs _parsedArgs

_procedures	back to summary
private final ArrayList<SignatureChecker.SQLRoutine> _procedures

SYSTEM_SCHEMAS	back to summary
private static final String[] SYSTEM_SCHEMAS

WILDCARD	back to summary
private static final String WILDCARD

Constructor Detail

SignatureChecker	back to summary
private SignatureChecker(SignatureChecker.ParsedArgs parsedArgs)

Method Detail

checkSignature	back to summary
private void checkSignature(Connection conn, String query, String readableSignature) Prepared a routine invocation in order to check whether it matches a Java method. Parameters conn:Connection The connection to the database query:String The SQL to prepare readableSignature:String the signature: printed if prepare fails

checkSignature

back to summary

private void checkSignature(Connection conn, String query, String readableSignature)

Prepared a routine invocation in order to check whether it matches a Java method.

Parameters

conn:Connection: The connection to the database
query:String: The SQL to prepare
readableSignature:String: the signature: printed if prepare fails

countFunctionArgs back to summary

private void countFunctionArgs(DatabaseMetaData dbmd) throws SQLException

Count up the arguments to the user-coded procedures. We use reflection to look up the getFunctionColumns() method because that method does not appear in the JSR169 api for DatabaseMetaData. Update _functions.

Parameters

dbmd:DatabaseMetaData: the database metadata of the database

countProcedureArgs back to summary

private void countProcedureArgs(DatabaseMetaData dbmd) throws SQLException

Count up the arguments to the user-coded procedures in _procedures and update that data structure accordingly

Parameters

dbmd:DatabaseMetaData: the database metadata of the database

execute	back to summary
private void execute() Get a connection to a database and then match the signatures of routines in that database.

findFunctions back to summary

private void findFunctions(DatabaseMetaData dbmd) throws SQLException

Find all of the user-declared functions. We use reflection to get our hands on getFunctions() because that method does not appear in the JSR169 api for DatabaseMetaData. Update _functions.

Parameters

dbmd:DatabaseMetaData: the database metadata of the database

findProcedures

back to summary

private void findProcedures(DatabaseMetaData dbmd) throws SQLException

Find all of the user-declared procedures.

Parameters

dbmd:DatabaseMetaData: the database metadata of the database

formatMessage	back to summary
private static String formatMessage(String key, Object... args) Format a localizable message. Parameters key:String The message key by which we located the localized text args:Object[] Any arguments to the localized text to be filled in Returns:String A localized message

formatMessage

back to summary

private static String formatMessage(String key, Object... args)

Format a localizable message.

Parameters

key:String: The message key by which we located the localized text
args:Object[]: Any arguments to the localized text to be filled in

Returns:String

A localized message

getFunction back to summary

getFunction	back to summary
private SignatureChecker.SQLRoutine getFunction(int idx) Get a function descriptor from `_functions` . Parameters idx:int The index of the procedure in `_functions`. Returns:SignatureChecker.SQLRoutine a function descriptor

private SignatureChecker.SQLRoutine getFunction(int idx)

Get a function descriptor from _functions .

Parameters

idx:int: The index of the procedure in _functions.

Returns:SignatureChecker.SQLRoutine

a function descriptor

getJ2SEConnection	back to summary
private Connection getJ2SEConnection() throws SQLException We use reflection to get the J2SE connection so that references to DriverManager will not generate linkage errors on old J2ME platforms which may resolve references eagerly. Returns:Connection a connection to the database

getJ2SEConnection

back to summary

private Connection getJ2SEConnection() throws SQLException

We use reflection to get the J2SE connection so that references to DriverManager will not generate linkage errors on old J2ME platforms which may resolve references eagerly.

Returns:Connection: a connection to the database

getMessageFormatter	back to summary
private static LocalizedResource getMessageFormatter() Get the message resource. Returns:LocalizedResource localized resource

getMessageFormatter

back to summary

private static LocalizedResource getMessageFormatter()

Get the message resource.

Returns:LocalizedResource: localized resource

getProcedure back to summary

getProcedure	back to summary
private SignatureChecker.SQLRoutine getProcedure(int idx) Get a procedure descriptor from `_procedures`. Parameters idx:int The index of the procedure in `_procedures`. Returns:SignatureChecker.SQLRoutine a procedure descriptor

private SignatureChecker.SQLRoutine getProcedure(int idx)

Get a procedure descriptor from _procedures.

Parameters

idx:int: The index of the procedure in _procedures.

Returns:SignatureChecker.SQLRoutine

a procedure descriptor

isSystemSchema back to summary

isSystemSchema	back to summary
private boolean isSystemSchema(String schema) Return true if the schema is a system schema. Parameters schema:String the schema to check Returns:boolean `true` if the schema is a system schema

private boolean isSystemSchema(String schema)

Return true if the schema is a system schema.

Parameters

schema:String: the schema to check

Returns:boolean

true if the schema is a system schema

main	back to summary
public static void main(String[] args)

makeReadableSignature	back to summary
private String makeReadableSignature(SignatureChecker.SQLRoutine routine) Make a human readable signature for a routine. This can be used in error messages. Parameters routine:SignatureChecker.SQLRoutine the routine for which we want a signature Returns:String human readable string

makeReadableSignature

back to summary

private String makeReadableSignature(SignatureChecker.SQLRoutine routine)

Make a human readable signature for a routine. This can be used in error messages.

Parameters

routine:SignatureChecker.SQLRoutine: the routine for which we want a signature

Returns:String

human readable string

matchFunctions	back to summary
private void matchFunctions(Connection conn) throws SQLException Match the signatures of functions in this database. Parameters conn:Connection The connection to use to access the database

matchFunctions

back to summary

private void matchFunctions(Connection conn) throws SQLException

Match the signatures of functions in this database.

Parameters

conn:Connection: The connection to use to access the database

matchProcedures	back to summary
private void matchProcedures(Connection conn) throws SQLException Match the signatures of procedures in this database. Parameters conn:Connection The connection to use to access the database

matchProcedures

back to summary

private void matchProcedures(Connection conn) throws SQLException

Match the signatures of procedures in this database.

Parameters

conn:Connection: The connection to use to access the database

matchSignatures	back to summary
private void matchSignatures(Connection conn) throws SQLException Match the signatures of routines in the database attached to this connection. Parameters conn:Connection This connection

matchSignatures

back to summary

private void matchSignatures(Connection conn) throws SQLException

Match the signatures of routines in the database attached to this connection.

Parameters

conn:Connection: This connection

prepareStatement	back to summary
private PreparedStatement prepareStatement(Connection conn, String text) throws SQLException

println	back to summary
private static void println(String text)

printThrowable	back to summary
private static void printThrowable(Throwable t) Annotations @SuppressWarnings:CallToPrintStackTrace

printUsage	back to summary
private static void printUsage()

putFunction back to summary

putFunction	back to summary
private void putFunction(String schema, String name, boolean isTableFunction) Store a function descriptor. Updates `_functions`. Parameters schema:String The schema of the function name:String The name of the function isTableFunction:boolean `true` iff the function is a table function

private void putFunction(String schema, String name, boolean isTableFunction)

Store a function descriptor. Updates _functions.

Parameters

schema:String: The schema of the function
name:String: The name of the function
isTableFunction:boolean: true iff the function is a table function

putProcedure back to summary

putProcedure	back to summary
private void putProcedure(String schema, String name) Store a procedure descriptor. Updates `_procedures`. Parameters schema:String schema of the procedure name:String of a procedure

private void putProcedure(String schema, String name)

Store a procedure descriptor. Updates _procedures.

Parameters

schema:String: schema of the procedure
name:String: of a procedure

Modifier and Type	Field and Description
private boolean	_isValid
private String	_j2seConnectionUrl

Access	Constructor and Description
public	ParsedArgs(String[] args)

Modifier and Type	Method and Description
public String	getJ2seConnectionUrl()
public boolean	isValid()
private void	parseArgs(String[] args)

_isValid	back to summary
private boolean _isValid

_j2seConnectionUrl	back to summary
private String _j2seConnectionUrl

ParsedArgs	back to summary
public ParsedArgs(String[] args)

getJ2seConnectionUrl	back to summary
public String getJ2seConnectionUrl()

isValid	back to summary
public boolean isValid()

parseArgs	back to summary
private void parseArgs(String[] args)

org.apache.derby.tools back to summary

pack-priv Class SignatureChecker.SQLRoutine

Class Inheritance

extends Object

java.lang.Object
org.apache.derby.tools.SignatureChecker.SQLRoutine

Field Summary

Modifier and Type	Field and Description
private final ArrayList<String>	_argList
private final boolean	_isTableFunction
private final String	_name
private final String	_schema

Constructor Summary

Access	Constructor and Description
public	SQLRoutine(String schema, String name, boolean isTableFunction)

Method Summary

Modifier and Type	Method and Description
public void	addArg(String typeName)
private String	doubleQuote(String raw)
public int	getArgCount()
public String	getArgType(int idx)
public String	getName()
public String	getQualifiedName()
public String	getSchema()
public boolean	isTableFunction()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_argList	back to summary
private final ArrayList<String> _argList

_isTableFunction	back to summary
private final boolean _isTableFunction

_name	back to summary
private final String _name

_schema	back to summary
private final String _schema

Constructor Detail

SQLRoutine	back to summary
public SQLRoutine(String schema, String name, boolean isTableFunction)

Method Detail

addArg	back to summary
public void addArg(String typeName)

doubleQuote	back to summary
private String doubleQuote(String raw)

getArgCount	back to summary
public int getArgCount()

getArgType	back to summary
public String getArgType(int idx)

getName	back to summary
public String getName()

getQualifiedName	back to summary
public String getQualifiedName()

getSchema	back to summary
public String getSchema()

isTableFunction	back to summary
public boolean isTableFunction()

toString

back 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.

Annotations

@Override

public Class SignatureChecker

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SignatureChecker.ParsedArgs

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SignatureChecker.SQLRoutine

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail