Difference between revisions of "XQuery Development Tools/Where to Start"

From Eclipsepedia

Jump to: navigation, search
Line 50: Line 50:
 
* <code>ZorbaSemanticValidator</code>
 
* <code>ZorbaSemanticValidator</code>
 
* <code>MarkLogicSemanticValidator</code>
 
* <code>MarkLogicSemanticValidator</code>
|-
 
 
|-
 
|-
 
! URI Resolving
 
! URI Resolving
Line 65: Line 64:
 
* <code>ZorbaUriResolver</code>
 
* <code>ZorbaUriResolver</code>
 
* <code>MarkLogicUriResolver</code>
 
* <code>MarkLogicUriResolver</code>
 +
|-
 +
! Vendor code templates
 +
|
 +
* Vendors can provide their own templates (code snippets) to be added to the default set of templates shipped with the core of XQDT.
 +
|
 +
* org.eclipse.wst.xquery.ui.<b><i>your_own_plugin</i></b>
 +
|
 +
* <code>ScriptCompletionProposalComputer</code>
 +
* add the <code>org.eclipse.dltk.ui.scriptCompletionProposalComputer</code> extension point in <b><i>your_own_plugin</i></b> and provide a reference to your implementation of <code>ScriptCompletionProposalComputer</code>. See the Zorba implementation for the complete extension point implementation.
 +
* <code>ScriptTemplateCompletionProcessor</code>
 +
* <code>ScriptTemplateAccess</code> (reads and caches the templates from disk)
 +
* <code>ScriptTemplateContextType</code>
 +
* add your <code>ScriptTemplateContextType</code> to the <code>org.eclipse.ui.editors.templates</code> extension point in <b><i>your_own_plugin</i></b>. In the same extension point, provide also the .xml and .properties files where the templates will be read from. See the Zorba implementation for the complete extension point implementation.
 +
* <code>ScriptTemplateContext<code> (allows you to resolve template variables)
 +
|
 +
* plug-in <code>org.eclipse.wst.xquery.ui.zorba</code>
 +
* <code>ZorbaTemplateProposalComputer</code>
 +
* <code>ZorbaTemplateCompletionProcessor</code>
 +
* <code>ZorbaTemplateAccess</code>
 +
* <code>ZorbaTemplateContentType</code>
 +
* <code>ZorbaTemplateContext<code>
 
|-
 
|-
 
|}
 
|}

Revision as of 09:03, 28 May 2010

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

NOTE: For all the classes below we have omitted the fully qualified name to keep the descriptions shorter. For example, XQDTInterpreterInstallType refers to org.eclipse.wst.xquery.launching.XQDTInterpreterInstallType. Eclipse helps you find these types with the "Open Type" 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: org.eclipse.wst.xquery.

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 (local, like in Zorba or Saxon; or remote, 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.your_own_plugin
  • XQDTInterpreterInstallType
  • XQDTInterpreterInstall
  • add the org.eclipse.dltk.launching.interpreterInstallTypes extension point in your_own_plugin and provide a reference to your implementation of XQDTInterpreterInstallType
  • the org.eclipse.wst.xquery.launching.zorba plug-in
    • ZorbaInstallType
    • ZorbaInstall
  • the org.eclipse.wst.xquery.launching plug-in
  • XQDTJavaInterpreterInstallType
  • XQDTJavaInterpreterInstall
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
  • ISemanticValidator or AbstractLocalInterpreterSemanticValidator
  • your IInterpreterInstall needs to implement ISemanticValidatingInterpreterInstall and provide an instance of your ISemanticValidator
  • ZorbaSemanticValidator
  • MarkLogicSemanticValidator
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.your_own_plugin
  • IXQDTUriResolver or XQDTUriResolver
  • add the org.eclipse.wst.xquery.core.uriResolver extension point in your_own_plugin and provide a reference to your implementation of IXQDTUriResolver
  • ZorbaUriResolver
  • MarkLogicUriResolver
Vendor code templates
  • Vendors can provide their own templates (code snippets) to be added to the default set of templates shipped with the core of XQDT.
  • org.eclipse.wst.xquery.ui.your_own_plugin
  • ScriptCompletionProposalComputer
  • add the org.eclipse.dltk.ui.scriptCompletionProposalComputer extension point in your_own_plugin and provide a reference to your implementation of ScriptCompletionProposalComputer. See the Zorba implementation for the complete extension point implementation.
  • ScriptTemplateCompletionProcessor
  • ScriptTemplateAccess (reads and caches the templates from disk)
  • ScriptTemplateContextType
  • add your ScriptTemplateContextType to the org.eclipse.ui.editors.templates extension point in your_own_plugin. In the same extension point, provide also the .xml and .properties files where the templates will be read from. See the Zorba implementation for the complete extension point implementation.
  • ScriptTemplateContext<code> (allows you to resolve template variables)
  • plug-in <code>org.eclipse.wst.xquery.ui.zorba
  • ZorbaTemplateProposalComputer
  • ZorbaTemplateCompletionProcessor
  • ZorbaTemplateAccess
  • ZorbaTemplateContentType
  • ZorbaTemplateContext<code>