LPEX
4.4.0

com.ibm.lpex.java
Class JavaSqlParser

java.lang.Object
  extended by com.ibm.lpex.core.LpexCommonParser
      extended by com.ibm.lpex.java.JavaParser
          extended by com.ibm.lpex.java.JavaSqlParser
All Implemented Interfaces:
LpexConstants, LpexParser

public class JavaSqlParser
extends JavaParser

Document parser for Java with embedded SQL.

Action added by this parser: sql for a selective view of the embedded SQL statements.


Field Summary
 
Fields inherited from class com.ibm.lpex.core.LpexCommonParser
ATTRIBUTES_COMMENT, ATTRIBUTES_COMMENT_KEYWORD, ATTRIBUTES_COMMENT1, ATTRIBUTES_DEFAULT, ATTRIBUTES_DIRECTIVE, ATTRIBUTES_ERROR, ATTRIBUTES_ERROR1, ATTRIBUTES_KEYWORD, ATTRIBUTES_KEYWORD1, ATTRIBUTES_LIBRARY, ATTRIBUTES_NONSOURCE, ATTRIBUTES_NUMERAL, ATTRIBUTES_STRING, ATTRIBUTES_STRING1, BACKGROUND_COLOR, CLASS_MESSAGE, LANGUAGE_CCPP, LANGUAGE_CICS, LANGUAGE_CL, LANGUAGE_COBOL, LANGUAGE_COBOL400, LANGUAGE_COBOLILE, LANGUAGE_DDS, LANGUAGE_DLI, LANGUAGE_FORTRAN, LANGUAGE_HLASM, LANGUAGE_HTML, LANGUAGE_JAVA, LANGUAGE_JCL, LANGUAGE_LISP, LANGUAGE_PERL, LANGUAGE_PLI, LANGUAGE_REXX, LANGUAGE_RPG, LANGUAGE_RPGLEFIXED, LANGUAGE_RPGLEFREE, LANGUAGE_SABRETALK, LANGUAGE_SQL, LANGUAGE_XMI, LANGUAGE_XML, LANGUAGE_XSL, LEXER_RC_END, LEXER_RC_EOF, LEXER_RC_MORE, LEXER_RC_OK, POPUP_END, POPUP_FILTERVIEW, POPUP_SOURCE, POPUP_TOP, PROTOKEY_EMPTY, STYLE_MESSAGE, STYLE_NAME, view
 
Fields inherited from interface com.ibm.lpex.core.LpexConstants
HELP_COMMAND_MAP, LPEX_VERSION, MSG_POPUP_COMMENT, MSG_POPUP_ERRORS, MSG_POPUP_EXCLUDESELECTION, MSG_POPUP_FILTERVIEWMENU, MSG_POPUP_INSERTMENU, MSG_POPUP_SELECTEDMENU, MSG_POPUP_SHOWALL, MSG_POPUP_SOURCEMENU, MSG_POPUP_TASKS, MSG_POPUP_UNCOMMENT, PARSE_PENDING_CHANGE_MASK, PARSE_PENDING_INSERT_MASK, PARSE_PENDING_NEXT_DELETED_MASK, PARSE_PENDING_NEXT_SHOW_DELETED_MASK, PARSE_PENDING_PREV_DELETED_MASK, PARSE_PENDING_PREV_SHOW_DELETED_MASK, PARSE_PENDING_UNDO_MASK, PLATFORM_AWT, PLATFORM_SWT, PLATFORM_SWT_KEY, SHOW_ALL, SHOW_DOCUMENT, SHOW_NONE, SHOW_VIEW, STATUS_FIELDS_NOINSERT, STATUS_FIELDS_TRUNCATE, STATUS_FILE_ERRORREADING, STATUS_FILE_INCORRECTENCODING, STATUS_FILE_NOTFOUND, STATUS_FINDTEXT_INVALIDPATTERN, STATUS_FINDTEXT_NOTFOUND, STATUS_FINDTEXT_ONLYOCCURRENCE, STATUS_FINDTEXT_READONLY, STATUS_FINDTEXT_WRAPPED, STATUS_LOCATE_NOSEQUENCETEXT, STATUS_LOCATE_NOTFOUND, STATUS_LOCATE_WRAPPED, STATUS_SAVE_CANCELLED, STATUS_SAVE_FAILED, STATUS_TEXTLIMIT_ENFORCED, STATUS_TEXTLIMIT_OVERFLOW, STATUS_UNDO_NOTHINGUNDONE
 
Constructor Summary
JavaSqlParser(LpexView lpexView)
          Constructor.
 
Method Summary
protected  String getPopupItems(int popupLocation)
          Extended to return this parser's contribution to the popup.
 String getProperty(String key)
          Extended to return "sample.sql" rather than "sample" for the preview window of the styles preference page.
protected  SqlLexer getSqlLexer(LpexCharStream stream)
          Returns the SqlLexer.
protected  void initParser()
          Extended to define the Filter view submenu editor action sql.
protected  void setStyleAttributes()
          Extended to define SQL-specific additional style attributes.
 
Methods inherited from class com.ibm.lpex.java.JavaParser
addErrorMessage, delete, document, expandProtoKeyword, getCommentStyleCharacters, getLanguage, getLanguage, getPopupItem, getProfile, isTokenDelimiter, isWordCharacter, join, openLine, parseAll, parseElement, propertySet, setLexer, split, splitLine, trace
 
Methods inherited from class com.ibm.lpex.core.LpexCommonParser
addDocumentMessage, addMessage, addMessage, addMessage, blockMarkWord, copyDocumentMessages, cursorIndent, defineFilterAction, defineFilterAction, getInstallStyleAttributes, getLshToken, getStyleName, getStyles, getTextIndent, getToken, getTokenLocation, indentText, indentText, indentText, isDebuggable, isPrimaryParser, lineComment, lpexView, matchToken, newLine, parse, removeDocumentMessages, removeMessages, removeMessages, resetParser, setProperty, setStyle, styleString, terminateParser, tokenBegin, tokenEnd, totalParse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavaSqlParser

public JavaSqlParser(LpexView lpexView)
Constructor.

Method Detail

initParser

protected void initParser()
Extended to define the Filter view submenu editor action sql.

Overrides:
initParser in class JavaParser
See Also:
Life cycle

getPopupItems

protected String getPopupItems(int popupLocation)
Extended to return this parser's contribution to the popup. This parser changes the contribution to the Filter view submenu (Methods, Logic outline, Embedded SQL, Errors, Tasks).

Overrides:
getPopupItems in class JavaParser
Parameters:
popupLocation - the location on the pop-up menu of the items requested, one of:
LpexCommonParser.POPUP_TOP, LpexCommonParser.POPUP_FILTERVIEW, LpexCommonParser.POPUP_SOURCE, LpexCommonParser.POPUP_END
Returns:
this parser's contribution to the pop-up menu, or
null if none
See Also:
LpexCommonParser.defineFilterAction(java.lang.String, java.lang.String)

setStyleAttributes

protected void setStyleAttributes()
Extended to define SQL-specific additional style attributes. One style character is added: 'f' (SQL built-in function).

Overrides:
setStyleAttributes in class JavaParser

getProperty

public String getProperty(String key)
Extended to return "sample.sql" rather than "sample" for the preview window of the styles preference page.

Specified by:
getProperty in interface LpexParser
Overrides:
getProperty in class JavaParser
Parameters:
key - property name, for example, "proto.doc" for this parser's expansion of the keyword "doc" by the proto action, or "view.proto.doc" for this property as defined in the current view's instance of the parser
See Also:
LpexCommonParser.getLanguage(), LpexCommonParser.getProfile(), Parser properties

getSqlLexer

protected SqlLexer getSqlLexer(LpexCharStream stream)
Returns the SqlLexer. This method constructs and returns an SqlLexer object for parsing Java embedded SQL statements.

Overrides:
getSqlLexer in class JavaParser
Parameters:
stream - input character stream for the SQL lexer

LPEX
4.4.0

Copyright � 2016 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.