com.ibm.etools.iseries.edit.sql
Class SQLRPGLESignature

java.lang.Object
  com.ibm.etools.iseries.edit.sql.SQLRPGLESignature

All Implemented Interfaces:

ISQLSignature

public class SQLRPGLESignature
extends Object
implements ISQLSignature

This class handles signatures for embedded SQL statements in SQL ILE RPG source

Since:

7.0

Field Summary

static String

Copyright

Constructor Summary

SQLRPGLESignature()
The constructor for this class

Method Summary

String	addSignature(String statementText) Called by the SQL formatter to add the signature to the formatted SQL statement
boolean	isSignatureOnAllLines() Indicates whether or not the signature should be applied to every line of the SQL statement
boolean	isSignatureOnFirstLineOnly() Indicates whether the signature should be applied to only the first line of the SQL statement
boolean	isSignatureOnLastLineOnly() Indicates whether or not the signature should be applied to the last line of the SQL Statement
boolean	isSignatureOnlyOnExecSQL() Indicates whether or not the signature is only allowed on the EXEC SQL line
boolean	needsSignature() Indicates whether or not a signature is needed

Methods inherited from class java.lang.Object

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

Field Detail

Copyright

public static final String Copyright

See Also:

Constant Field Values

Constructor Detail

SQLRPGLESignature

public SQLRPGLESignature()

The constructor for this class

Method Detail

addSignature

public String addSignature(String statementText)

Description copied from interface: ISQLSignature

Called by the SQL formatter to add the signature to the formatted SQL statement

Specified by:

addSignature in interface ISQLSignature

Parameters:

statementText - a line in the formatted SQL statement

Returns:

the SQL line with the signature added

isSignatureOnAllLines

public boolean isSignatureOnAllLines()

Description copied from interface: ISQLSignature

Indicates whether or not the signature should be applied to every line of the SQL statement

Specified by:

isSignatureOnAllLines in interface ISQLSignature

Returns:

true if the signature should be added to each line of the SQL statement

isSignatureOnFirstLineOnly

public boolean isSignatureOnFirstLineOnly()

Description copied from interface: ISQLSignature

Indicates whether the signature should be applied to only the first line of the SQL statement

Specified by:

isSignatureOnFirstLineOnly in interface ISQLSignature

Returns:

true if the signature should be added only to the first line, false otherwise

isSignatureOnLastLineOnly

public boolean isSignatureOnLastLineOnly()

Description copied from interface: ISQLSignature

Indicates whether or not the signature should be applied to the last line of the SQL Statement

Specified by:

isSignatureOnLastLineOnly in interface ISQLSignature

Returns:

true if the signature should be added only to the last line, false otherwise

isSignatureOnlyOnExecSQL

public boolean isSignatureOnlyOnExecSQL()

Description copied from interface: ISQLSignature

Indicates whether or not the signature is only allowed on the EXEC SQL line

Specified by:

isSignatureOnlyOnExecSQL in interface ISQLSignature

Returns:

true if the signature is only allowed on the EXEC SQL line, false otherwise

needsSignature

public boolean needsSignature()

Description copied from interface: ISQLSignature

Indicates whether or not a signature is needed

Specified by:

needsSignature in interface ISQLSignature

Returns:

true if a signature is needed, false otherwise