Difference between revisions of "PrF UG queries query editor"

From Protege Wiki
Jump to: navigation, search
Line 4: Line 4:
 
{{PrF_UG_TOC_queries}}<div id='prf_ug'>
 
{{PrF_UG_TOC_queries}}<div id='prf_ug'>
  
The Query Editor allows you to enter,
+
The Query Editor allows you to enter, modify, or save your queries.
modify,
 
or save your queries.
 
 
The Query Editor has the following components:
 
The Query Editor has the following components:
  
 
<ol class='a'>
 
<ol class='a'>
 
   <li><p>
 
   <li><p>
     One or more
+
     One or more [[#Query_Bar_s_|query bars]],
    [[#Query_Bar_s_|query bars]],
+
     where you can construct a query
     where you can construct a query by selecting a class,
+
    by selecting a class, slot, criterion, and value.
    slot,
 
    criterion,
 
    and value.
 
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     The
+
     The [[#Combined_Query_Buttons|Combined Query buttons]],
    [[#Combined_Query_Buttons|Combined Query buttons]],
 
 
     which allow you to add and remove additional query bars,
 
     which allow you to add and remove additional query bars,
 
     and to specify how they are combined.
 
     and to specify how they are combined.
Line 40: Line 34:
 
     A Class entry field,
 
     A Class entry field,
 
     which allows you to specify a class by clicking the <b>Select Class</b>
 
     which allows you to specify a class by clicking the <b>Select Class</b>
     [[Image:PrF_UG_classes_class.add.gif|classes_class.add]]
+
     [[Image:PrF_UG_classes_class.add.gif|classes_class.add]] button.
    button.
 
 
     If a class is already shown,
 
     If a class is already shown,
 
     using the <b>Select Class</b>
 
     using the <b>Select Class</b>
     [[Image:PrF_UG_classes_class.add.gif|classes_class.add]]
+
     [[Image:PrF_UG_classes_class.add.gif|classes_class.add]] button replaces it.
    button replaces it.
 
 
     You can also view the selected class by clicking the <b>View Class</b>
 
     You can also view the selected class by clicking the <b>View Class</b>
     [[Image:PrF_UG_classes_class.view.gif|classes_class.view]]
+
     [[Image:PrF_UG_classes_class.view.gif|classes_class.view]] button,
    button,
 
 
     or remove it by clicking the <b>Remove Class</b>
 
     or remove it by clicking the <b>Remove Class</b>
     [[Image:PrF_UG_classes_class.remove.gif|classes_class.remove]]
+
     [[Image:PrF_UG_classes_class.remove.gif|classes_class.remove]] button.
    button.
 
 
     </p>
 
     </p>
  
Line 57: Line 47:
 
     A Slot entry field,
 
     A Slot entry field,
 
     which allows you to specify a slot by clicking the <b>Select Slot</b>
 
     which allows you to specify a slot by clicking the <b>Select Slot</b>
     [[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]]
+
     [[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]] button.
    button.
 
 
     If a slot is already shown,
 
     If a slot is already shown,
 
     using the <b>Select Slot</b>
 
     using the <b>Select Slot</b>
     [[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]]
+
     [[Image:PrF_UG_slots_slot.add.gif|slots_slot.add]] button replaces it.
    button replaces it.
 
 
     You can also view the selected slot by clicking the <b>View Slot</b>
 
     You can also view the selected slot by clicking the <b>View Slot</b>
     [[Image:PrF_UG_slots_slot.view_top_level.gif|slots_slot.view_top_level]]
+
     [[Image:PrF_UG_slots_slot.view_top_level.gif|slots_slot.view_top_level]] button,
    button,
 
 
     or remove it by clicking the <b>Remove Slot</b>
 
     or remove it by clicking the <b>Remove Slot</b>
     [[Image:PrF_UG_slots_slot.remove.gif|slots_slot.remove]]
+
     [[Image:PrF_UG_slots_slot.remove.gif|slots_slot.remove]] button.
    button.
 
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     A criteria menu,
+
     A criteria menu, which allows you to set the criteria for the query,
    which allows you to set the criteria for the query,
 
 
     based on the slot.
 
     based on the slot.
 
     </p>
 
     </p>
Line 95: Line 80:
 
|
 
|
 
[[Image:PrF_UG_queries_query_menu_boolean.png|queries_query_menu_boolean]]
 
[[Image:PrF_UG_queries_query_menu_boolean.png|queries_query_menu_boolean]]
| Verifies whether or not the Boolean value is <b>true</b> or <b>false</b>,
+
|
 +
Verifies whether or not the Boolean value is <b>true</b> or <b>false</b>,
 
as selected from the menu at the right.
 
as selected from the menu at the right.
 
|-
 
|-
Line 104: Line 90:
 
|
 
|
 
The selected criterion is compared to a class selected at the right.
 
The selected criterion is compared to a class selected at the right.
To select a class,
+
To select a class, click the <b>Select Class</b>
click the <b>Select Class</b>
+
[[Image:PrF_UG_all_object.add.gif|all_object.add]] button
<div>[[Image:PrF_UG_all_object.add.gif|all_object.add]]</div>
+
and make a selection from the dialog.
button and make a selection from the dialog.
+
To remove a class, click the <b>Remove Class</b>
To remove a class,
+
[[Image:PrF_UG_all_object.remove.gif|all_object.remove]] button.
click the <b>Remove Class</b>
 
[[Image:PrF_UG_all_object.remove.gif|all_object.remove]]
 
button.
 
 
Only one class can be selected.
 
Only one class can be selected.
 
|-
 
|-
Line 118: Line 101:
 
|
 
|
 
[[Image:PrF_UG_queries_query_menu_float.png|queries_query_menu_float]]
 
[[Image:PrF_UG_queries_query_menu_float.png|queries_query_menu_float]]
| The selected criterion is compared to the value typed in the Float entry bar at the right.
+
|
 +
The selected criterion is compared to the value typed in the Float entry bar at the right.
 
|-
 
|-
 
|
 
|
Line 128: Line 112:
 
<ul class='a'>
 
<ul class='a'>
 
   <li><p>
 
   <li><p>
     To select an instance,
+
     To select an instance, click the <b>Select Instance</b>
    click the <b>Select Instance</b>
+
     [[Image:PrF_UG_all_object.add.gif|all_object.add]] button
     [[Image:PrF_UG_all_object.add.gif|all_object.add]]
+
     and make a selection from the dialog.
     button and make a selection from the dialog.
 
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     To select a query,
+
     To select a query, click the <b>Select Query</b>
    click the <b>Select Query</b>
+
     [[Image:PrF_UG_queries_query.gif|queries_query]] button
     [[Image:PrF_UG_queries_query.gif|queries_query]]
+
     and make a selection from the dialog.
     button and make a selection from the dialog.
 
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     To remove an instance or query,
+
     To remove an instance or query, click the <b>Remove Instance</b>
    click the <b>Remove Instance</b>
+
     [[Image:PrF_UG_all_object.remove.gif|all_object.remove]] button.
     [[Image:PrF_UG_all_object.remove.gif|all_object.remove]]
+
     Only one instance or query can be selected.
     button.Only one instance or query can be selected.
 
 
     </p>
 
     </p>
 
</ul>
 
</ul>
Line 153: Line 134:
 
|
 
|
 
[[Image:PrF_UG_queries_query_menu_float.png|queries_query_menu_float]]
 
[[Image:PrF_UG_queries_query_menu_float.png|queries_query_menu_float]]
| The selected criterion is compared to the value typed in the Integer entry bar at the right.
+
|
 +
The selected criterion is compared to the value typed in the Integer entry bar at the right.
 
|-
 
|-
 
|
 
|
Line 159: Line 141:
 
|
 
|
 
[[Image:PrF_UG_queries_query_menu_string.png|queries_query_menu_string]]
 
[[Image:PrF_UG_queries_query_menu_string.png|queries_query_menu_string]]
| The selected criterion is compared to all or part of a string typed in the entry bar to the right.
+
|
For example,
+
The selected criterion is compared to all or part of a string
selecting <b>begins with</b> and typing M in the String entry bar will find all instances of the selected class/slot combination that begin with M.
+
typed in the entry bar to the right.
 +
For example, selecting <b>begins with</b> and typing M in the String entry bar
 +
will find all instances of the selected class/slot combination that begin with M.
 
|-
 
|-
 
|
 
|
Line 167: Line 151:
 
|
 
|
 
[[Image:PrF_UG_queries_query_menu_symbol.png|queries_query_menu_symbol]]
 
[[Image:PrF_UG_queries_query_menu_symbol.png|queries_query_menu_symbol]]
| The Symbol entry bar to the right becomes a drop-down menu that displays all possible values for the slot.
+
|
 +
The Symbol entry bar to the right becomes a drop-down menu
 +
that displays all possible values for the slot.
 
The selected criterion is compared to the value.
 
The selected criterion is compared to the value.
 
|}
 
|}
Line 174: Line 160:
  
 
{| summary="combined query buttons"
 
{| summary="combined query buttons"
| More
+
|
| Click this button to create an additional query bar,
+
More
which can then be set with class,
+
|
slot,
+
Click this button to create an additional query bar,
and criterion.
+
which can then be set with class, slot, and criterion.
 
|-
 
|-
| Fewer
+
|
| If there are two or more query bars,
+
Fewer
 +
|
 +
If there are two or more query bars,
 
click this button to remove the bottom-most query bar.
 
click this button to remove the bottom-most query bar.
 
|-
 
|-
| Clear
+
|
| Click this button to clear all query bars and reduce the Query Editor to a single,
+
Clear
blank query bar.
+
|
 +
Click this button to clear all query bars and reduce the Query Editor
 +
to a single, blank query bar.
 
|-
 
|-
| Match All
+
|
| For two or more query bars,
+
Match All
click this button to specify that any instance found must match all of the criteria
+
|
(the intersection or AND)
+
For two or more query bars, click this button to specify that any instance found
specified in the query bars.
+
must match all of the criteria (the intersection or AND) specified in the query bars.
 
|-
 
|-
| Match Any
+
|
| For two or more query bars,
+
Match Any
click this button to specify that any instance found must match at least one of the criteria
+
|
(the union or OR)
+
For two or more query bars, click this button to specify that any instance found
specified in the query bars.
+
must match at least one of the criteria (the union or OR) specified in the query bars.
 
|}
 
|}
  
 
</div>
 
</div>

Revision as of 14:07, October 16, 2008

The Query Editor


Protege-Frames User's Guide
Queries
The Queries Tab
The Query Editor
The Search Results Pane
The Query Library Pane
Creating a Single Query
Combining Multiple Queries
Chaining Multiple Queries
Running a Query
Saving a Query
Retrieving a Query
Clearing a Query
Exporting Query Results
Glossary, Editing Help

The Query Editor allows you to enter, modify, or save your queries. The Query Editor has the following components:

  1. One or more query bars, where you can construct a query by selecting a class, slot, criterion, and value.

  2. The Combined Query buttons, which allow you to add and remove additional query bars, and to specify how they are combined.

  3. The Find button, which allows you to run your query.

Query Bar(s)

Each query bar has:

  1. A Class entry field, which allows you to specify a class by clicking the Select Class classes_class.add button. If a class is already shown, using the Select Class classes_class.add button replaces it. You can also view the selected class by clicking the View Class classes_class.view button, or remove it by clicking the Remove Class classes_class.remove button.

  2. A Slot entry field, which allows you to specify a slot by clicking the Select Slot slots_slot.add button. If a slot is already shown, using the Select Slot slots_slot.add button replaces it. You can also view the selected slot by clicking the View Slot slots_slot.view_top_level button, or remove it by clicking the Remove Slot slots_slot.remove button.

  3. A criteria menu, which allows you to set the criteria for the query, based on the slot.

  4. A value entry bar or menu, which allows you to set the value for comparison. The entry type is based on the slot value type.

Choices for the criteria menu and value are as follows:

Slot Type Criteria Menu Action

Boolean

queries_query_menu_boolean

Verifies whether or not the Boolean value is true or false, as selected from the menu at the right.

Class

queries_query_menu_class

The selected criterion is compared to a class selected at the right. To select a class, click the Select Class all_object.add button and make a selection from the dialog. To remove a class, click the Remove Class all_object.remove button. Only one class can be selected.

Float

queries_query_menu_float

The selected criterion is compared to the value typed in the Float entry bar at the right.

Instance

queries_query_menu_class

The selected criterion is compared to an instance or query selected at the right.

  • To select an instance, click the Select Instance all_object.add button and make a selection from the dialog.

  • To select a query, click the Select Query queries_query button and make a selection from the dialog.

  • To remove an instance or query, click the Remove Instance all_object.remove button. Only one instance or query can be selected.

Integer

queries_query_menu_float

The selected criterion is compared to the value typed in the Integer entry bar at the right.

String

queries_query_menu_string

The selected criterion is compared to all or part of a string typed in the entry bar to the right. For example, selecting begins with and typing M in the String entry bar will find all instances of the selected class/slot combination that begin with M.

Symbol

queries_query_menu_symbol

The Symbol entry bar to the right becomes a drop-down menu that displays all possible values for the slot. The selected criterion is compared to the value.

Combined Query Buttons

More

Click this button to create an additional query bar, which can then be set with class, slot, and criterion.

Fewer

If there are two or more query bars, click this button to remove the bottom-most query bar.

Clear

Click this button to clear all query bars and reduce the Query Editor to a single, blank query bar.

Match All

For two or more query bars, click this button to specify that any instance found must match all of the criteria (the intersection or AND) specified in the query bars.

Match Any

For two or more query bars, click this button to specify that any instance found must match at least one of the criteria (the union or OR) specified in the query bars.