View source for XQuery Development Tools/Where to Start

== What is the "Where to Start" page? ==

This page gathers a list of features of XQDT and the place in the project where this feature is implemented or where the developer should first look and start understanding and debugging the functionality.

== Feature table ==

<b>NOTE:</b> For all the classes below we have omitted the fully qualified name to keep the descriptions shorter. For example, <code>XQDTInterpreterInstallType</code> refers to <code>org.eclipse.wst.xquery.launching.XQDTInterpreterInstallType</code>. Eclipse helps you find these types with the <b>"Open Type"</b> dialog (available under the "Navigate" menu or by pressing the key combination: Ctrl-Shift-T). In case you find more classes having the same name (though not the case so far), just choose the one from our project, that is, having a package name starting with: <code>org.eclipse.wst.xquery</code>.

{| cellpadding="5" border="1"
|+ XQDT features 
|-
! Feature name
! Feature description
! Plug-ins involved
! Need to implement
! Sample implementation
|-
! New XQuery Processor Type
|
* A new XQuery processor type (called "interpreter" in DLTK terms) allows you to define you own logic for:
** execution environment (<b>local</b>, like in Zorba or Saxon; or <b>remote</b>, like MarkLogic Server)
** processor validation (e.g. only allow executables called zorba.exe to be added as the Zorba processor type)
** launching configuration (e.g. add custom launching parameters to your processor type upon execution)
|
* org.eclipse.wst.xquery.launching
* org.eclipse.wst.xquery.launching.<b><i>your_own_plugin</i></b>
|
* <code>XQDTInterpreterInstallType</code>
* <code>XQDTInterpreterInstall</code>
* add the <code>org.eclipse.dltk.launching.interpreterInstallTypes</code> extension point in <b><i>your_own_plugin</i></b> and provide a reference to your implementation of <code>XQDTInterpreterInstallType</code>
|
* the <code>org.eclipse.wst.xquery.launching.zorba</code> plug-in
** <code>ZorbaInstallType</code>
** <code>ZorbaInstall</code>

* the <code>org.eclipse.wst.xquery.launching</code> plug-in
* <code>XQDTJavaInterpreterInstallType</code>
* <code>XQDTJavaInterpreterInstall</code>
|-
! Semantic Checker
|
* After the syntax check is complete without errors, a particular XQuery processor is allowed to report other errors in the XQuery code. E.g. function not available, namespace not declared, variable not defined, or even more complex problems that a particular processor may detect.
|
* org.eclipse.wst.xquery.core
* org.eclipse.wst.xquery.launching
|
* <code>ISemanticValidator</code> or <code>AbstractLocalInterpreterSemanticValidator</code>
* your <code>IInterpreterInstall</code> needs to implement <code>ISemanticValidatingInterpreterInstall</code> and provide an instance of your <code>ISemanticValidator</code>
|
* <code>ZorbaSemanticValidator</code>
* <code>MarkLogicSemanticValidator</code>
|-
|-
! URI Resolving
|
* The XQuery processors resolve the module/schema URIs in an implementation specific way. This feature allows vendors to provide their own logic for URI resolving to match their processors's logic. The URI resolving is used for example in code assist in order to find the functions for code completion.
|
* org.eclipse.wst.xquery.core
* org.eclipse.wst.xquery.launching
* org.eclipse.wst.xquery.launching.<b><i>your_own_plugin</i></b>
|
* <code>IXQDTUriResolver</code> or <code>XQDTUriResolver</code>
* add the <code>org.eclipse.wst.xquery.core.uriResolver</code> extension point in <b><i>your_own_plugin</i></b> and provide a reference to your implementation of <code>IXQDTUriResolver</code>
|
* <code>ZorbaUriResolver</code>
* <code>MarkLogicUriResolver</code>
|-
|}


[[Category:XQuery Development Tools]]