%extPoint.queryModifierProvider

Identifier:
com.ibm.xtools.emf.query.ui.queryHandling

Since:
7.5

Description:
This extension point allows providers to be added to manage the lifecycle of queries and overlays. For example, adding a queryModificationProvider will allow users to create queries of a certain type in the wizard. Also, a query modifier will be called to modify any overlays of that type in a diagram. Template providers will provide a user with certain templates (note that the query modification provider must be available) to start from allowing them to further customize them. Preview providers are necessary to allow previewing of the .tpx file.

Configuration Markup:

<!ELEMENT extension (queryModificationProvider* , templateProvider* , previewProvider*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT queryModificationProvider EMPTY>

<!ATTLIST queryModificationProvider

type             CDATA #REQUIRED

class            CDATA #REQUIRED

name             CDATA #REQUIRED

editOverlaysOnly (true | false) >

A query modification provider allows users to create and modify queries of a particular type as well as modify overlays of that type. Optionally, a modification provider can opt-out of creating/modifying a query by choosing to "editOverlaysOnly." If this option is set then the modification provider will only be called when a user edits overlays on a diagram.



<!ELEMENT templateProvider (template*)>

<!ATTLIST templateProvider

class CDATA #IMPLIED>

A template provider provides either a set of .tpx files or a class (either the former or the latter, not both) to provide a set of query objects that can be used by the user as templates for .tpx files in the workspace. Note that a query modification provider must be available (and editOverlaysOnly either unset or set to false) for the types of these queries or the templates will not work.



<!ELEMENT template EMPTY>

<!ATTLIST template

file CDATA #REQUIRED>

The template element declares a template file that can be used in the wizard.



<!ELEMENT previewProvider EMPTY>

<!ATTLIST previewProvider

class CDATA #REQUIRED

type  CDATA #REQUIRED>

A preview provider sets up the .tpx editor so that it is capable of previewing the results of a certain type of query. For example, it is responsible for creating the appropriate type of diagram. Note that a query modification provider will be needed for this type to allow a .tpx file to be created in the first place and so that the query can be modified in the .tpx editor.



Examples:
[Enter extension point usage example here.]

API Information:
[Enter API information here.]

Supplied Implementation:
[Enter information about supplied implementation of this extension point.]


Licensed Materials - Property of IBM

(C) Copyright IBM Corp. 2008. All Rights Reserved.

US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.