Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.edit.sql.SQLStatements
Class SQLBuiltInFunction

java.lang.Object
  extended by com.ibm.etools.iseries.edit.sql.SQLStatements.SQLBuiltInFunction
All Implemented Interfaces:
ISQLItem

public class SQLBuiltInFunction
extends Object
implements ISQLItem

A class which represents built-in function for SQL statements

Since:
7.0

Field Summary
static String Copyright
           
 
Constructor Summary
protected SQLBuiltInFunction(String name)
           
 
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.
 
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

SQLBuiltInFunction

protected SQLBuiltInFunction(String name)
Method Detail

appendCommentChar

public void appendCommentChar(char c)
Description copied from interface: ISQLItem
Appends a character to the comment buffer for this item

Specified by:
appendCommentChar in interface ISQLItem
Parameters:
c - the character to append

appendComment

public void appendComment(StringBuffer comment)
Description copied from interface: ISQLItem
Appends a comment to the existing comment for this item

Specified by:
appendComment in interface ISQLItem
Parameters:
comment - the comment to append

decreaseBracketLevel

public void decreaseBracketLevel()
Description copied from interface: ISQLItem
Used to keep track of nexted brackets

Specified by:
decreaseBracketLevel in interface ISQLItem

getBracketLevel

public int getBracketLevel()
Description copied from interface: ISQLItem
Used to retrieves the bracket leve

Specified by:
getBracketLevel in interface ISQLItem
Returns:
the number of open brackets that are not closed.

getCommentBuffer

public StringBuffer getCommentBuffer()
Description copied from interface: ISQLItem
Retrieves the comment buffer for this item

Specified by:
getCommentBuffer in interface ISQLItem
Returns:
the comment buffer for this item

getName

public String getName()
Description copied from interface: ISQLItem
Retrieves the name of the item

Specified by:
getName in interface ISQLItem
Returns:
the name of the item

getStartingBuffer

public StringBuffer getStartingBuffer()
Description copied from interface: ISQLItem
Retrieves the starting buffer for this item. Used to handle when comments are placed at the top of this item.

Specified by:
getStartingBuffer in interface ISQLItem
Returns:
the starting buffer

getStartingBufferPosition

public int getStartingBufferPosition()
Description copied from interface: ISQLItem
Retrieves the position in the starting buffer that the statement is at

Specified by:
getStartingBufferPosition in interface ISQLItem
Returns:
the position in the starting statement buffer

increaseBracketLevel

public void increaseBracketLevel()
Description copied from interface: ISQLItem
Used to keep track of nested brackets

Specified by:
increaseBracketLevel in interface ISQLItem

isSplitOnCommasAllowed

public boolean isSplitOnCommasAllowed()
Description copied from interface: ISQLItem
Indicates whether or not the item allows split on commas

Specified by:
isSplitOnCommasAllowed in interface ISQLItem
Returns:
true if split on commas is allowed, false otherwise

setStartingBuffer

public void setStartingBuffer(StringBuffer start)
Description copied from interface: ISQLItem
Sets the starting buffer for this item. Used to handle when comments are placed at the top of this item.

Specified by:
setStartingBuffer in interface ISQLItem
Parameters:
start - the starting buffer

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.