Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
==Startup==
Via On top of the main window, you can find an input bar. The attached dropdown menu provides three modes: ''Options'Find''' menu, you can change how queries are executed '''XQuery''' and visualized'''Command''':
* '''Realtime Execution''': If realtime execution is enabled, your searches and queries will be executed with each key click and the results will be instantly shown.* '''Realtime Filtering''': If enabled, all visualizations will be limited to the actual results in realtime. If this feature is disabled, the query results are highlighted in the visualizations and can be explicitly filtered with the 'Filter' button.[[CategoryImage:GUIInputBar.png|Input Bar]]
==Querying==The upcoming example queries can all be used with an instance of the <code>factbook</code> database:
The Keyword Search can be executed in In the '''SearchFind''' mode in, the combo box of the main window. This options allows for a simple,keyword-based search input bar can be used to find single elements and texts in the currently opened database.The following syntax is supported:
The following syntax is supported:
Apart from the basic search facilities, BaseX offers far more sophisticated processing options to query your documents. Below are some examples you might give a try. This guide is far from being a comprehensive XQuery reference, but might point you in the right direction.==Command==
To execute In the following queries'''Command''' mode, enter them in the XQuery Panel [[Commands|BaseX Commands]] can be entered and press ENTER or click on executed. Just try the START button.following examples:
XPath provides * <code>INFO</code>: Returns system information.* <code>CREATE DB TEST</code>: Creates an easy facility to query your documents in a navigational mannerempty database named "TEST". It is the basic tool of * <code>LIST</code>: Lists all node-related operations that you encounter when using XQuery. We will start with a trivial example and extend it to our needsdatabases.
''' Example: Find Countries '''=Text Editor=
<pre class="brushThe powerful text editor can be used to write and edit [[XQuery]] code (simple queries, modules), XML documents, [[Commands#Basics|Command Scripts]], and any other textual files:xquery">//country</pre>
tells BaseX to look for all <code>country</code> elements in * XQuery and command scripts can be '''executed''' by clicking on the documentgreen triangle. The query is introduced by two slashes <code>//</code>* XQuery, which trigger the traversal of all document nodesXML and JavaScript will be '''syntax highlighted'''. The queries {{Code|//country}} andd {{Code|/descendant::country}} * XQuery and XML will return the same resultsautomatically '''parsed''' with each key click, and '''errors''' will be highlighted.
''' Example: Find Cities in Switzerland '''Numerous [[Shortcuts|keyboard shortcuts]] are available to speed up editing and debugging.
The following query uses a '''predicate''' <code>[...]</code> to filter all <code>country</code> nodes which have a <code>name</code> child, the string value of which is "Switzerland":==Project View==
To return Erroneous XQuery modules, and all cities of the resulting element nodequeries importing these modules, the query will be highlighted. Highlighting can be extended by a trailing <code>//city</code> path:disabled in the GUI preferences dialog.
<pre class="brush:xquery">//country[name Realtime Options= "Switzerland"]//city</pre>
===Text Editor===Via the ''Options'' menu, you can change how queries are executed and visualized:
The text editor can be used to type in [[XQuery]] expressions, [[Commands#Basics|Command Scripts]], XML documents* '''Realtime Execution''': If realtime execution is enabled, or any other text files. Query files your searches and XML documents can queries will be started by clicking on the green triangle. They will automatically parsed executed with each key clickand the results will be instantly shown.* '''Realtime Filtering''': If enabled, and errors all visualizations will be highlightedlimited to the actual results in realtime. Various [[Shortcuts|keyboard shortcuts]] If this feature is disabled, the query results are available to speed up editing highlighted in the visualizations and debuggingcan be explicitly filtered with the 'Filter' button.
==Visualizations==
Various tutorials on XPath are available in the internet. We invite you to e.g. have a look at the [http://www.w3schools.com/xquery/ XQuery Tutorial at W3Schools];Version 8.0
[[Category* Updated:Beginner]][[Category:GUI]][[Category:XQuery]]support for dark look and feels; support for JTatto library
no edit summary
This page is part of the [[Getting Started]] Section.
The BaseX homepage gives you a [http://basex.org/products/gui visual impression] of the graphical user interface (GUI) of BaseX,and the an [http://www.youtube.com/watch?v=xILHKGPGaJ4&hd=1 introductory video] is available, which presents some of the its interactive features that the BaseX GUI provides.
First of all, please launch a GUI instance of BaseX. Depending on your operating system, double click on the '''BaseX GUI''' start icon or run the <code>basexgui</code> script. Beside that, some more [[Startup#BaseX GUI|startup options]] are available.
==Create Database==
Select ''Database'' → ''New'' and browse to an XML document of your choice. As an example, you can start with the {{Code|factbook.xml}} document, which contains statistical information on the worlds' countries. It is included in our official releases and can also be [http://files.basex.org/xml/factbook.xml downloaded] (1.3 MB). If you type nothing in the input field, an empty database will be created. Next, choose the ''OK'' button, and BaseX will create a database that you can visually explore and query.
If no XML document is available, the [[#Text Editor|Text Editor]] can also be used to create an initial XML document. After saving the entered XML document to harddisk, it can be specified supplied as database input in the above dialog.
==Realtime Options=Input Bar=
===Keyword Search=Find==
{| class="wikitable"
!Query
!Description
|-
|<code>worldcity</code>|Find tags elements named {{Code|city}}, and texts containing this token.|-|<code>=India</code>|Find texts matching the exact string {{Code|worldIndia}}.
|-
|<code>=world~Cing</code>|Find exact matching text nodestexts equal or similar to the token {{Code|Cingdom}}.
|-
|<code>~worldid</code>|Find text nodes similar to attributes named {{Code|worldid}}and attribute values containing this token.
|-
|<code>@world=f0_119</code>|Find attributes and attribute valuesmatching the exact string {{Code|f0_119}}.
|-
|<code>@=world"European Chinese"</code>|Find exact attribute valuestexts containing the phrase {{Code|"European Chinese"}}.
|-
|<code>"united world"//city</code>|Find tags and texts containing Leading slash: Interpret the phrase {{Code|"united world"}}input as XPath expression (see below).
|}
==XQuery== In the '''XQuery''' mode, XPath/and XQueryexpressions can be entered in the input bar. To evaluate the following example queries: enter them in the input bar, and press ENTER or click on the START button: {| class="wikitable"!Query!Description|-|<code>//country</code>|Return all <code>country</code> elements.|-|<code>//country[name =="Switzerland"]</code>|Return the <code>country</code> element of "Switzerland".|-|<code>for $city in //city<br/>where $city/population > 1000000<br/>order by $city ascending<br/>return $city/name</code>|Return the names of all cities with a population larger than one million and order the results by the name of the city.|}
The Project View is attached to the editor panel. It displays all files of the current project directory in a tree structure. Files can be renamed and deleted by right-clicks on the files. The project directory can be changed by clicking on the button with the three dots <pre class="brush:xquery"code>//country[name = "Switzerland"]...</precode>in the upper left corner of the project view panel.
The BaseX GUI offers various visualizations,
<table cellpadding="0" cellspacing="10"><tr><td valign="top">
[[Image:TextViewResult.jpgpng|thumb|Text View]]
'''TextResult'''
:Displays query results and other textual output. Query results can be saved in a file.
</td><td valign="top">
[[Image:MapViewMap.jpgpng|thumb|Map View]]
'''Map'''
:This visualization represents Displays all data in a [http://en.wikipedia.org/wiki/Treemap TreeMap]. All nodes of the XML document are represented as rectangles, filling the complete area. You can choose different layout algorithms in the Menu ''Options'' → ''Map Layout''.
</td></tr><tr><td valign="top">
[[Image:TreeViewTree.jpgpng|thumb|Tree View]]
'''Tree'''
:This visualization displays Displays all XML nodes in a top down tree with edges and nodes. You can change some settings of the Tree in the Menu ''Options'' → ''Tree Options''.
</td><td valign="top">
[[Image:Folder.png|thumb|Folder View]]
'''Folder'''
:This visualization displays Displays all nodes in an Explorer-like folder view. Nodes can be expanded or closed by clicking on the arrows.
</td></tr><tr><td valign="top">
[[Image:Scatterplot.png|thumb|Scatterplot View]]
'''Plot'''
:This visualization displays Displays all nodes in a scatterplot, which is particularly helpful if you want to explore analyze your data. Three drop down menus allow custom axis assignments.
</td><td valign="top">
[[Image:Table.png|thumb|The Table View]]
'''Table'''
:This visualization comes Comes in handy if your data is highly regular. It displays all nodes in a table with rows and columns. Different assignments can be chosen by clicking on the arrow in the right upper corner.
</td></tr><tr><td valign="top">
[[Image:Explorer.png|thumb|Explorer View]]
'''Explorer'''
:With this visualization you can Can be used to explore the contents of your database via drop-down menus, search fields and double sliders.
</td><td valign="top">
[[Image:InfoView.png|thumb|Info View]]
'''Info'''
:This view is helpful Helpful for analyzing the query plans of your XQuery expressions. It also displays information on the compilation and evaluation of queries.
</td></tr></table>
=Look and Feels=What’s Next? <table> <tr> <td>By default, the Look and Feel of your operating system will be used in the GUI.In the ''Preferences'' dialog, you can choose among some more window themes. The [http://www.jtattoo.net/ScreenShots.html JTattoo library] offers some morelook and feels. If you download and copy the JTattoo jar file into the {{Code|lib}}directory provided by the ZIP and EXE distribution of BaseX,13 additional looks and feels will get available. </td> <td>[[Image:defaultlaf.png|thumb|Default Look & Feel]]</td> <td>[[Image:hifilaf.png|thumb|HiFi Look & Feel]]</td> </tr></table> =Changelog= ;Version 8.4 * Added: highlighting of erroneous XQuery modules in the project view.
