TMQL

From WandoraWiki
(Difference between revisions)
Jump to: navigation, search
m (Protected "TMQL" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(Introduction)
Line 4: Line 4:
  
 
Wandora uses the [https://code.google.com/p/tmql/ TMQL4J library] for TMQL. TMQL4J in turn uses the TMAPI and standard the TMDM data model, which is slightly different to Wandora's topic map data model. This necessitates some conversion between the two data models when using TMQL, which may cause some unexpected behaviour at times. For the most part, however, TMQL works as one would expect. See the article about Wandora's [[Reduced Topic Maps]] for more information on what kind of constructs will not work in Wandora.
 
Wandora uses the [https://code.google.com/p/tmql/ TMQL4J library] for TMQL. TMQL4J in turn uses the TMAPI and standard the TMDM data model, which is slightly different to Wandora's topic map data model. This necessitates some conversion between the two data models when using TMQL, which may cause some unexpected behaviour at times. For the most part, however, TMQL works as one would expect. See the article about Wandora's [[Reduced Topic Maps]] for more information on what kind of constructs will not work in Wandora.
 +
 +
For information about TMQL itself, refer to the [http://tmql4j.topicmapslab.de/ documentation of TMQL4J], which includes some easy to follow tutorials.
  
 
== Using the TMQL search dialog ==
 
== Using the TMQL search dialog ==

Revision as of 13:55, 20 March 2014

This is an upcoming feature. The current public version of Wandora does not yet support TMQL, but will soon.

Introduction

Wandora uses the TMQL4J library for TMQL. TMQL4J in turn uses the TMAPI and standard the TMDM data model, which is slightly different to Wandora's topic map data model. This necessitates some conversion between the two data models when using TMQL, which may cause some unexpected behaviour at times. For the most part, however, TMQL works as one would expect. See the article about Wandora's Reduced Topic Maps for more information on what kind of constructs will not work in Wandora.

For information about TMQL itself, refer to the documentation of TMQL4J, which includes some easy to follow tutorials.

Using the TMQL search dialog

In the graphical user interface, TMQL can be used in the search dialog, accessed through the Edit/Search menu item. Then select the TMQL query tab and enter your TMQL query. There are also options to save queries for later use or selecting a saved query from a list.

You may perform any kind of TMQL queries, including ones that modify the topic map, not just select queries. The results however will always be returned in a tabular format when invoked through the search dialog, so trying to output XML or CTM fragments like this will be impractical. Additional tools may be created later for these use cases.

Using TMQL in Velocity templates

TMQL queries can also be ran in the Apache Velocity templates used by the services of the Embedded HTTP server. The context automatically contains a variable tmqlrunner which has the method runTMQL. This method needs the topic map and the TMQL query as variables. See the querydemo service for an example on how to use TMQL like this.

In any other web applications TMQL queries can be similarly used in Velocity templates, as long as you pass the TMQL runner object to the Velocity context. The full class name is org.wandora.topicmap.TMQLRunner.

Personal tools