com.ibm.etools.iseries.edit.sql.SQLStatements
Interface ISQLItem

All Known Implementing Classes:

SQLBuiltInFunction, SQLStatement

public interface ISQLItem

a basic iterface for SQL items used by the parser

Field Summary

static String

Copyright

Method Summary

void	appendComment(StringBuffer comment) Appends a comment to the existing comment for this item
void	appendCommentChar(char c) Appends a character to the comment buffer for this item
void	decreaseBracketLevel() Used to keep track of nexted brackets
int	getBracketLevel() Used to retrieves the bracket leve
StringBuffer	getCommentBuffer() Retrieves the comment buffer for this item
String	getName() Retrieves the name of the item
StringBuffer	getStartingBuffer() Retrieves the starting buffer for this item.
int	getStartingBufferPosition() Retrieves the position in the starting buffer that the statement is at
void	increaseBracketLevel() Used to keep track of nested brackets
boolean	isSplitOnCommasAllowed() Indicates whether or not the item allows split on commas
void	setStartingBuffer(StringBuffer start) Sets the starting buffer for this item.

Field Detail

Copyright

static final String Copyright

See Also:

Constant Field Values

Method Detail

appendCommentChar

void appendCommentChar(char c)

Appends a character to the comment buffer for this item

Parameters:

c - the character to append

appendComment

void appendComment(StringBuffer comment)

Appends a comment to the existing comment for this item

Parameters:

comment - the comment to append

decreaseBracketLevel

void decreaseBracketLevel()

Used to keep track of nexted brackets

getBracketLevel

int getBracketLevel()

Used to retrieves the bracket leve

Returns:

the number of open brackets that are not closed.

getCommentBuffer

StringBuffer getCommentBuffer()

Retrieves the comment buffer for this item

Returns:

the comment buffer for this item

getName

String getName()

Retrieves the name of the item

Returns:

the name of the item

getStartingBuffer

StringBuffer getStartingBuffer()

Retrieves the starting buffer for this item. Used to handle when comments are placed at the top of this item.

Returns:

the starting buffer

getStartingBufferPosition

int getStartingBufferPosition()

Retrieves the position in the starting buffer that the statement is at

Returns:

the position in the starting statement buffer

increaseBracketLevel

void increaseBracketLevel()

Used to keep track of nested brackets

isSplitOnCommasAllowed

boolean isSplitOnCommasAllowed()

Indicates whether or not the item allows split on commas

Returns:

true if split on commas is allowed, false otherwise

setStartingBuffer

void setStartingBuffer(StringBuffer start)

Sets the starting buffer for this item. Used to handle when comments are placed at the top of this item.

Parameters:

start - the starting buffer