Skip to content Skip to navigation

ODRA-IDE Release 2007.09.06-01

Pobierz

Rozmiar pliku: 11,47 MB

ODRA-IDE Release 2007.09.06-01

(Formerly known as the jOdra2-IDE)

(C)2006 - 2007 Mariusz Trzaska

This is a prototype version of the IDE (Integrated Development Environment) for the ODRA.

[img]http://www.users.pjwstk.edu.pl/~mtrzaska/Files/ODRA/jOdra2-IDE-V2-plain-smallS2.png[/img]

Remarks
1. The IDE is build around jEdit – programmer’s text editor. The most important features:
• Unlimited undo/redo,
• "Markers" for remembering positions in files to return to later,
• Any number of editor windows may be open, each window may be split into several areas, each area can view a different file. Alternatively, different locations in one file can be viewed in more than one area
• Syntax Highlighting
• Intelligent bracket matching skips quoted literals and comments
• Auto indent
• Commands for shifting the indent left and right
• Commands for commenting out code
• Soft tabs option
• Abbreviations
• Folding, with two fold modes: indent-based, and explicit (where the buffer is parsed for "{{{" and "}}}")
• Advanced Search and Replace
• File Management
• Customization
• Extensibility
2. Current version works with SBQL/XML/TXT files, which are correctly processed. Highlighting schema has been defined following SBQL sample files. Thus it could be changed in the future (especially when SBQL strict syntax will be defined).
3. Extending of the jEdit is done by utilizing plugins and changes to the source code.

Installing and running
1. Install Java JRE or JDK. You can download it from: “http://java.sun.com/javase/downloads/index.jsp”
2. Extract the downloaded archive.
3. Run “ODRA-IDE.jar”. If “.jar” is not properly associated try this: \javaw.exe -jar \ODRA-IDE.jar. Make sure that the IDE directory is the current one.
4. The IDE is shipped with the most current version of ODRA. However it is possible to update the ODRA library manually by replacing appropriate jars in “IDE-libs” directory.

General information
1. The left panel contains “Project Explorer”, which allows viewing and manipulating workspace/projects files/structure. Each item has its own context menu (right click). Some options could be called from a few places, i.e. context menu and main menu.
2. The bottom panel contains “Messages” showing i.e. compilation errors.
3. Main part occupies text editor allowing writing source code of your SBQL programs.
4. Every window can be minimized (just click on its name), undocked/docked (see menu “under” the small triangle).
5. The last two icons on the right part of the toolbar allow building default project or executing query (running it).
6. Warning: Windows Look&Feel does not work on MS Windows Vista (due to some internal Java error related to resources).

Sample use case scenarios

1. Creating a project
Select menu Project/New Project or appropriate context menu of Workspace. Then give a name and select a project’s directory. The structure is as follows: first is a workspace which can contains unlimited number of projects. A project contains a ODRA server and files (SBQL, XML, TXT).
2. Creating a new file
Select “Create a new file” from project’s context menu. Then enter a file’s name. A new file will be created and placed in the project’s directory.
3. Adding an existing file
Select “Add an existing file” from project’s context menu. Then select a file. Selected file will be added to the project’s structure, but will not be copied to the project’s directory. Try two sample files located in “_SampleFiles” directory.
4. Starting a server.
Every project requires SBQL server to work. You can start a default one or connected to the existing one.
5. Building a project
Select “Build” from project’s context menu. If project’s server is not running, the default one will be started. After the compilation, there will be some messages in the “Messages” panel (bottom of the screen). If there will be errors/warnings, you can open appropriate file by clicking error description. Note then a line with the error is highlighted. Try to compile sample files and introduce some errors to see what will happen.
6. Debugging/Running a project
Select “Debug” from project’s context menu. This functionality allows executing a query (or running a method from a module). First enter (or select from the combo box) the module name and then a query code (method name). In case of sample files you can enter: “admin.procedures” as a module name and “proc();” as a procedure name (without quotation marks). A result of the query will be shown in a tree-like control. It is possible to open/close particular nodes containing detailed information. Notice that it is also possible to copy selected node to system clipboard as a text (using context menu).
7. Saving/Loading workspace
Select “Save/Load Workspace” from workspace’s context menu. Currently workspace remembers projects and its files as absolute paths. This approach will be probably changed in the future (because of problems with moving projects).
8. Viewing database server content
Select “DEBUG: Dump store” from server’s context menu. A simple window with textual version of server content will be shown. Next versions of ODRA-IDE should use more user-friendly tree-like view.
9. Showing modules content.
Select “Reload” from modules’ context menu. All modules and sub-modules (with their content) are shown in the tree.
10. Connecting to existing server
Create or load a project. Then, using server's node context menu, select "Connect to existing". Enter necessary information and press Connect button.
11. Import data from an XML file using a plugin.
Create a new project and run a server. Then select “Import data using plugin” from server’s context menu. Choose a plugin (i.e. “XMLImporter”), a file (i.e. “_SampleFiles\XML\bookstore.xml”), a module (i.e. “admin”) and enter necessary parameters. After a while you should see a message telling that there were no errors. Note that, in case of the sample file, a new Data section (“bookstore”) has been created under module admin. It is also possible to execute a query running on imported data i.e.: “bookstore;” (queries work only if metadata has been generated or typechecking is switched off).
12. Practice sample queries described in „_SampleFiles\XML\Dept-sample\SBQLqueries.txt”.
They work with the “_SampleFiles\XML\Dept-sample\deptemp.xml” data file, which must be correctly imported (see use case 11).
13. Utilize ODRA CLI (Command Line Interface).
Type "help" for a list of available commands.
14. Show a server data's value.
Find any kind of data under Modules node (in the project's explorer) and see its value using context menu: Show value (internal mode) or Show value (user-friendly mode).
15. Import metadata from an XSD file and data from an XML file using a plugin.
Create a new project and run a server. Then select “Import data using plugin” from server’s context menu. Choose a plugin (i.e. “XSDImporter”), a file (i.e. “_SampleFiles\XML\personnel.xsd”), a module (i.e. “admin”) and enter necessary parameters. Then repeat the same with "XMLImporter", a file (i.e. “_SampleFiles\XML\personnel.xml”), a module (i.e. “admin”) and enter necessary parameters ("useMetabase"). After a while you should see a message telling that there were no errors. Note that, in case of the sample file, a new Data section (“personnel”) has been created under module admin. It is also possible to execute a query running on imported data i.e.: personnel;”.
16. See a server's memory utilization.
Start a server and from it's context menu choose "Show persistient store" or "Show transient store".
17. Read/write CLI variables.
Activate "ODRA CLI" view and click "CLI Variables" button or use Workspaces' context menu "CLI Variables".
18. It is possible to visualize an AST tree of a query. Use "Visualize" button on "Odra query" tab.

References

ODRA files (including the IDE): “http://www.mtrzaska.com/odra-ide”
ODRA SVN repository: svn://odra.pjwstk.edu.pl:2401/egovbus
More information about SBA/SBQL: http://www.sbql.pl/
ODRA project forum (mainly in polish): http://iolab.pjwstk.edu.pl:8081/forum/
More information about jEdit itself: http://www.jedit.org/.
ODRA XML filter user's guide: "http://iolab.pjwstk.edu.pl:8081/forum/Default.aspx?g=posts&t=176"
The preliminary version of the description of SBQL "bytecode" (codename Juliet): "http://iolab.pjwstk.edu.pl:8081/forum/Default.aspx?g=posts&t=154" or "http://www.kis.p.lodz.pl/~radamus/odraforum/Juliet.pdf"
ODRA Technical Reference Manual (in Polish only): "http://iolab.pjwstk.edu.pl:8081/forum/Default.aspx?g=posts&t=156"

Feel free to send me comments/remarks.

History

ODRA-IDE Release 2007.09.06-01
1. Fixed some compatibility issues.
2. Completely new approach for working with projects' files.

ODRA-IDE Release 2007.06.15-01
1. New functionality: remove a project from a workspace.
2. New functionality: remove a file from a project.
3. New functionality: integrated memory monitor.
4. New functionality: integrated AST visualizer.
5. Some minor changes.

ODRA-IDE Release 2007.05.09-01
1. Improved server's management.
2. Upgraded to jEdit V4.3pre9.

ODRA-IDE Release 2007.04.22-01
1. Fixed some problems.

ODRA-IDE Release 2007.04.09-01
1. It is possible to read/write CLI variables using IDE (see use case no 17).
2. IDE works with two syntaxes: SBQL, OCL (switch them using CLI variable).
3. Some minor changes.

ODRA-IDE Release 2007.03.13
1. Some minor changes.

ODRA-IDE Release 2007.01.23
1. Component visually showing memory utilization has been added.
2. It is possible to show value of data existing on a server.
3. Every tree in the IDE has a new command: expand all subnodes.
4. Added more XML/XSD samples to the directory (and a new UC no 15).

ODRA-IDE Release 2006.12.14
1. A list of XML test queries has been added - see "_SampleFiles\XML\Dept-sample" directory (and use case 12).
2. Fixed problem when a query result contained some empty nodes (in user friendly output mode).
3. Integrated ODRA-CLI. Type Help for a list of available commands.
4. Updated SBQL keywords according to the "SBQL-syntax-061123.doc" document.

jOdra2-IDE Release 2006.12.02-01
1. Query window is integrated with the rest of the windows (no longer modal).

jOdra2-IDE Release 2006.12.01-01
1. Some minor language fixes.
2. File chooser remembers the last selected path.
3. Added an option for copying query result to clipboard as an XML.

jOdra2-IDE Release 2006.11.23-01
1. Chnges to processing query results.
2. Some minor refactorings.

jOdra2-IDE Release 2006.11.21-01
1. Fixed problem with executing queries (caused by changes in DBRequest.EXECUTE_SBQL_RQST).
2. Changed the loction of a default server file (now it is the same folder where jOdra2-IDE.jar is located).
3. Added a new mode for showing query results ("XML mode" which is more user friendly - hides internal structure of the query result).

jOdra2-IDE Release 2006.11.08-01
1. Default Look&Feel has been changed to "MetalLookAndFeel" (important in case non Windows OS). It is always possible to change current L&F using editor's options: Utilities/Global options/Appearance --> Swing L&F.
2. XML test files have been added (included XQuery use cases) - see "_SampleFiles\XML" directory.
3. Added a new functionality allowing copy query results to system clipboard using context menu.

jOdra2-IDE Release 2006.10.27-01
1. Added functionality allowing importing data using plugins. Currently only the XML plugin is shipped.

jOdra2-IDE Release 2006.09.28-01
1. Added "Connect to existing server" functionality.
2. Some minor improvements.

jOdra2-IDE Release 2006.09.26-01
1. Build status information has been moved to the main status area (from messages window).
2. A context menu has been introduced in the messages window (and "remove all messages" button has been replaced by the appropriate menu).
3. A new "Execute query" functionality has been added. It allows to see query results using tree structure.

jOdra2-IDE Release 2006.09.01-01
1. Changed jar-libs names.
2. Shows modules (and their content) on the server.
3. Adding multiple files to the project in one step.

jOdra2-IDE Release 2006.08.24-01
1. Initial release