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

```
public class SignatureChecker
extends java.lang.Object
```
This class shows which user declared SQL functions and procedures cannot be matched with Java methods.

To run from the command-line, enter the following if running on J2SE:

java org.apache.derby.tools.SignatureChecker CONNECTION_URL_TO_DATABASE

And enter the following if running on J2ME:

java org.apache.derby.tools.SignatureChecker DATABASE_NAME

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class SignatureChecker.ParsedArgs

(package private) class SignatureChecker.SQLRoutine

Field Summary

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

Constructor Summary

Constructors
Modifier Constructor Description

private SignatureChecker(SignatureChecker.ParsedArgs parsedArgs)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`checkSignature(java.sql.Connection conn, java.lang.String query, java.lang.String readableSignature)`	Prepared a routine invocation in order to check whether it matches a Java method.
`private void`	`countFunctionArgs(java.sql.DatabaseMetaData dbmd)`	Count up the arguments to the user-coded procedures.
`private void`	`countProcedureArgs(java.sql.DatabaseMetaData 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(java.sql.DatabaseMetaData dbmd)`	Find all of the user-declared functions.
`private void`	`findProcedures(java.sql.DatabaseMetaData dbmd)`	Find all of the user-declared procedures.
`private static java.lang.String`	`formatMessage(java.lang.String key, java.lang.Object... args)`	Format a localizable message.
`private SignatureChecker.SQLRoutine`	`getFunction(int idx)`	Get a function descriptor from `_functions` .
`private java.sql.Connection`	`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`	`getMessageFormatter()`	Get the message resource.
`private SignatureChecker.SQLRoutine`	`getProcedure(int idx)`	Get a procedure descriptor from `_procedures`.
`private boolean`	`isSystemSchema(java.lang.String schema)`	Return true if the schema is a system schema.
`static void`	`main(java.lang.String[] args)`
`private java.lang.String`	`makeReadableSignature(SignatureChecker.SQLRoutine routine)`	Make a human readable signature for a routine.
`private void`	`matchFunctions(java.sql.Connection conn)`	Match the signatures of functions in this database.
`private void`	`matchProcedures(java.sql.Connection conn)`	Match the signatures of procedures in this database.
`private void`	`matchSignatures(java.sql.Connection conn)`	Match the signatures of routines in the database attached to this connection.
`private java.sql.PreparedStatement`	`prepareStatement(java.sql.Connection conn, java.lang.String text)`
`private static void`	`println(java.lang.String text)`
`private static void`	`printThrowable(java.lang.Throwable t)`
`private static void`	`printUsage()`
`private void`	`putFunction(java.lang.String schema, java.lang.String name, boolean isTableFunction)`	Store a function descriptor.
`private void`	`putProcedure(java.lang.String schema, java.lang.String name)`	Store a procedure descriptor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WILDCARD
```
private static final java.lang.String WILDCARD
```
    See Also:
    
    Constant Field Values
  - SYSTEM_SCHEMAS
```
private static final java.lang.String[] SYSTEM_SCHEMAS
```
  - _parsedArgs
```
private final SignatureChecker.ParsedArgs _parsedArgs
```
  - _procedures
```
private final java.util.ArrayList<SignatureChecker.SQLRoutine> _procedures
```
  - _functions
```
private final java.util.ArrayList<SignatureChecker.SQLRoutine> _functions
```
  - _debugging
```
private final boolean _debugging
```
    See Also:
    
    Constant Field Values
  - _messageFormatter
```
private static LocalizedResource _messageFormatter
```
- Constructor Detail
  - SignatureChecker
```
private SignatureChecker(SignatureChecker.ParsedArgs parsedArgs)
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
  - execute
```
private void execute()
```
    Get a connection to a database and then match the signatures of routines in that database.
  - matchSignatures
```
private void matchSignatures(java.sql.Connection conn)
                      throws java.sql.SQLException
```
    Match the signatures of routines in the database attached to this connection.
    
    Parameters:
    
    conn - This connection
    
    Throws:
    
    java.sql.SQLException
  - matchProcedures
```
private void matchProcedures(java.sql.Connection conn)
                      throws java.sql.SQLException
```
    Match the signatures of procedures in this database.
    
    Parameters:
    
    conn - The connection to use to access the database
    
    Throws:
    
    java.sql.SQLException
  - matchFunctions
```
private void matchFunctions(java.sql.Connection conn)
                     throws java.sql.SQLException
```
    Match the signatures of functions in this database.
    
    Parameters:
    
    conn - The connection to use to access the database
    
    Throws:
    
    java.sql.SQLException
  - makeReadableSignature
```
private java.lang.String makeReadableSignature(SignatureChecker.SQLRoutine routine)
```
    Make a human readable signature for a routine. This can be used in error messages.
    
    Parameters:
    
    routine - the routine for which we want a signature
    
    Returns:
    
    human readable string
  - findProcedures
```
private void findProcedures(java.sql.DatabaseMetaData dbmd)
                     throws java.sql.SQLException
```
    Find all of the user-declared procedures.
    
    Parameters:
    
    dbmd - the database metadata of the database
    
    Throws:
    
    java.sql.SQLException
  - countProcedureArgs
```
private void countProcedureArgs(java.sql.DatabaseMetaData dbmd)
                         throws java.sql.SQLException
```
    Count up the arguments to the user-coded procedures in _procedures and update that data structure accordingly
    
    Parameters:
    
    dbmd - the database metadata of the database
    
    Throws:
    
    java.sql.SQLException
  - findFunctions
```
private void findFunctions(java.sql.DatabaseMetaData dbmd)
                    throws java.sql.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 - the database metadata of the database
    
    Throws:
    
    java.sql.SQLException
  - countFunctionArgs
```
private void countFunctionArgs(java.sql.DatabaseMetaData dbmd)
                        throws java.sql.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 - the database metadata of the database
    
    Throws:
    
    java.sql.SQLException
  - checkSignature
```
private void checkSignature(java.sql.Connection conn,
                            java.lang.String query,
                            java.lang.String readableSignature)
```
    Prepared a routine invocation in order to check whether it matches a Java method.
    
    Parameters:
    
    conn - The connection to the database
    
    query - The SQL to prepare
    
    readableSignature - the signature: printed if prepare fails
  - getJ2SEConnection
```
private java.sql.Connection getJ2SEConnection()
                                       throws java.sql.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:
    
    a connection to the database
    
    Throws:
    
    java.sql.SQLException
  - prepareStatement
```
private java.sql.PreparedStatement prepareStatement(java.sql.Connection conn,
                                                    java.lang.String text)
                                             throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - printUsage
```
private static void printUsage()
```
  - printThrowable
```
private static void printThrowable(java.lang.Throwable t)
```
  - println
```
private static void println(java.lang.String text)
```
  - isSystemSchema
```
private boolean isSystemSchema(java.lang.String schema)
```
    Return true if the schema is a system schema.
    
    Parameters:
    
    schema - the schema to check
    
    Returns:
    
    true if the schema is a system schema
  - putProcedure
```
private void putProcedure(java.lang.String schema,
                          java.lang.String name)
```
    Store a procedure descriptor. Updates _procedures.
    
    Parameters:
    
    schema - schema of the procedure
    
    name - of a procedure
  - getProcedure
```
private SignatureChecker.SQLRoutine getProcedure(int idx)
```
    Get a procedure descriptor from _procedures.
    
    Parameters:
    
    idx - The index of the procedure in _procedures.
    
    Returns:
    
    a procedure descriptor
  - putFunction
```
private void putFunction(java.lang.String schema,
                         java.lang.String name,
                         boolean isTableFunction)
```
    Store a function descriptor. Updates _functions.
    
    Parameters:
    
    schema - The schema of the function
    
    name - The name of the function
    
    isTableFunction - true iff the function is a table function
  - getFunction
```
private SignatureChecker.SQLRoutine getFunction(int idx)
```
    Get a function descriptor from _functions .
    
    Parameters:
    
    idx - The index of the procedure in _functions.
    
    Returns:
    
    a function descriptor
  - formatMessage
```
private static java.lang.String formatMessage(java.lang.String key,
                                              java.lang.Object... args)
```
    Format a localizable message.
    
    Parameters:
    
    key - The message key by which we located the localized text
    
    args - Any arguments to the localized text to be filled in
    
    Returns:
    
    A localized message
  - getMessageFormatter
```
private static LocalizedResource getMessageFormatter()
```
    Get the message resource.
    
    Returns:
    
    localized resource

Modifier and Type	Class	Description
`(package private) static class`	`SignatureChecker.ParsedArgs`
`(package private) class`	`SignatureChecker.SQLRoutine`

Class SignatureChecker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WILDCARD

SYSTEM_SCHEMAS

_parsedArgs

_procedures

_functions

_debugging

_messageFormatter

Constructor Detail

SignatureChecker

Method Detail

main

execute

matchSignatures

matchProcedures

matchFunctions

makeReadableSignature

findProcedures

countProcedureArgs

findFunctions

countFunctionArgs

checkSignature

getJ2SEConnection

prepareStatement

printUsage

printThrowable

println

isSystemSchema

putProcedure

getProcedure

putFunction

getFunction

formatMessage

getMessageFormatter