Difference between revisions of "PrF UG classes references window"
(7 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
== The References Window == | == The References Window == | ||
− | {{PrF_UG_TOC_classes}}<div id='prf_ug'> | + | <noinclude>{{PrF_UG_TOC_classes}}<div id='prf_ug'></noinclude> |
In a complex project, | In a complex project, | ||
it is possible to have many different relationships | it is possible to have many different relationships | ||
between classes, instances, and slots. | between classes, instances, and slots. | ||
− | A <i>reference</i> for a frame is any other frame that has a direct relationship to it. | + | A <i>reference</i> for a frame is any other frame |
− | The References window can be viewed by selecting an item and clicking on the <b>References</b> | + | that has a direct relationship to it. |
− | ([[Image:PrF_UG_classes_class.view_references.gif|classes_class.view_references]] or | + | The References window can be viewed by selecting an item |
− | [[Image:PrF_UG_inst_instance.view_references.gif|instances_instance.view_references]]) button. | + | and clicking on the <b>References</b> |
− | See [[PrF_UG_classes_view_references|Viewing References]] for more information. | + | ([[Image:PrF_UG_classes_class.view_references.gif| |
+ | classes_class.view_references]] | ||
+ | or [[Image:PrF_UG_inst_instance.view_references.gif| | ||
+ | instances_instance.view_references]]) button. | ||
+ | See [[PrF_UG_classes_view_references| | ||
+ | Viewing References]] for more information. | ||
− | <div>[[Image:PrF_UG_classes_references_dialog.png| | + | <div>[[Image:PrF_UG_classes_references_dialog.png|frame|none| |
+ | References to Advertisement dialog, "name" selected]]</div> | ||
It is also possible to view those classes that are related through a particular slot, | It is also possible to view those classes that are related through a particular slot, | ||
Line 36: | Line 42: | ||
<li><p> | <li><p> | ||
− | any <i>direct</i> slots (inherited slots are <i>not</i> considered to be references) | + | any <i>direct</i> slots |
+ | (inherited slots are <i>not</i> considered to be references) | ||
</p> | </p> | ||
Line 48: | Line 55: | ||
</ul> | </ul> | ||
− | For a slot, | + | For a slot, references include: |
− | references include: | ||
<ul class='a'> | <ul class='a'> | ||
Line 70: | Line 76: | ||
=== The View Buttons === | === The View Buttons === | ||
+ | <div class='b'> | ||
{| summary="view buttons" | {| summary="view buttons" | ||
| width="50" | | | width="50" | | ||
[[Image:PrF_UG_all_object.view.gif|all_object.view]] | [[Image:PrF_UG_all_object.view.gif|all_object.view]] | ||
| | | | ||
− | <b>View Reference:</b> Opens the editor for the highlighted frame and allows you to view the frame's properties. | + | <b>View Reference:</b> |
+ | Opens the editor for the highlighted frame and allows you to view the frame's properties. | ||
Depending on the frame, | Depending on the frame, | ||
− | this could be the | + | this could be the [[PrF_UG_classes_class_editor|Class Editor]], |
− | [[PrF_UG_classes_class_editor|Class Editor]], | + | the [[PrF_UG_slots_slot_editor|Slot Editor]], |
− | the | + | or the [[PrF_UG_inst_instance_editor|Instance Editor]]. |
− | [[PrF_UG_slots_slot_editor|Slot Editor]], | ||
− | or the | ||
− | [[PrF_UG_inst_instance_editor|Instance Editor]]. | ||
|- | |- | ||
| | | | ||
[[Image:PrF_UG_all_object.view_references.gif|all_object.view_references]] | [[Image:PrF_UG_all_object.view_references.gif|all_object.view_references]] | ||
− | | <b>View References to Value:</b> Shows the references for the highlighted frame. | + | | |
+ | <b>View References to Value:</b> Shows the references for the highlighted frame. | ||
|} | |} | ||
+ | </div> | ||
=== The Frame Column === | === The Frame Column === | ||
This column shows the name of each frame that references the highlighted item. | This column shows the name of each frame that references the highlighted item. | ||
− | The type of frame is indicated by a | + | The type of frame is indicated |
− | [[PrF_UG_classes_class_icons|class icon]], | + | by a [[PrF_UG_classes_class_icons|class icon]], |
− | [[PrF_UG_slots_slot_icons|slot icon]], | + | [[PrF_UG_slots_slot_icons|slot icon]], or instance icon |
− | or instance icon | + | ([[Image:PrF_UG_inst_instance.gif|instances_instance]]). |
− | [[Image:PrF_UG_inst_instance.gif|instances_instance]]. | ||
=== The Slot Column === | === The Slot Column === | ||
This column specifies the slot that actually references the selected item. | This column specifies the slot that actually references the selected item. | ||
− | Note that {{#var:PrF}} provides standard slots which indicate the relationship between the selected item and the referencing frame. | + | Note that {{#var:PrF}} provides standard slots |
+ | which indicate the relationship between the selected item and the referencing frame. | ||
For example: | For example: | ||
+ | <div class='b'> | ||
{| summary="standard slots" | {| summary="standard slots" | ||
| width="175" | DIRECT-INSTANCES | | width="175" | DIRECT-INSTANCES | ||
| The selected item is a direct instance of the frame. | | The selected item is a direct instance of the frame. | ||
|- | |- | ||
− | | DIRECT-SUPERCLASSES | + | | |
− | | The selected item is a direct superclass of the frame. | + | DIRECT-SUPERCLASSES |
+ | | | ||
+ | The selected item is a direct superclass of the frame. | ||
|- | |- | ||
− | | DIRECT-SUBCLASSES | + | | |
− | | The selected item is a direct subclass of the frame. | + | DIRECT-SUBCLASSES |
+ | | | ||
+ | The selected item is a direct subclass of the frame. | ||
|- | |- | ||
− | | SLOT-VALUE-TYPE | + | | |
+ | SLOT-VALUE-TYPE | ||
| | | | ||
The frame is a slot and the selected item appears as one of its values. | The frame is a slot and the selected item appears as one of its values. | ||
− | If the selected item is an instance, | + | If the selected item is an instance, it may be a value. |
− | it may be a value. | ||
If the selected item is a class, | If the selected item is a class, | ||
− | it may be an <b>Allowed Superclass</b> (for a | + | it may be an <b>Allowed Superclass</b> |
− | [[PrF_UG_slots_value_type_class|slot of type <b>Class</b>]]) | + | (for a [[PrF_UG_slots_value_type_class|slot of type <b>Class</b>]]) |
− | or an <b>Allowed Class</b> (for a | + | or an <b>Allowed Class</b> |
− | [[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]). | + | (for a [[PrF_UG_slots_value_type_instance|slot of type <b>Instance</b>]]). |
|} | |} | ||
+ | </div> | ||
The name of any other slot in the project may also appear in this column. | The name of any other slot in the project may also appear in this column. | ||
Line 129: | Line 142: | ||
=== The Facet Column === | === The Facet Column === | ||
− | This column gives information about the facet value for certain types of references and gives information about the slot relationships between classes. | + | This column gives information about the facet value for certain types of references |
− | For example, | + | and gives information about the slot relationships between classes. |
− | an item may appear as a value for a slot which is called by that frame. | + | For example, an item may appear as a value for a slot which is called by that frame. |
In the illustration above, | In the illustration above, | ||
the class <b>Author</b> appears as an <b>Allowed Class</b> for the slot <i>author</i>, | the class <b>Author</b> appears as an <b>Allowed Class</b> for the slot <i>author</i>, | ||
as shown in the second row. | as shown in the second row. | ||
− | In addition, | + | In addition, the slot <i>author</i> appears as a slot for the class <b>Article</b>. |
− | the slot <i>author</i> appears as a slot for the class <b>Article</b>. | + | Therefore, <b>Article</b> references <b>Author</b>. |
− | Therefore, | ||
− | <b>Article</b> references <b>Author</b>. | ||
This reference appears in the fifth row in the example. | This reference appears in the fifth row in the example. | ||
For an embedded reference of this type, | For an embedded reference of this type, | ||
− | the facet value column specifies whether the selected item appears as an <b>Allowed Class</b> or an <b>Allowed Superclass</b>. | + | the facet value column specifies whether the selected item appears |
+ | as an <b>Allowed Class</b> or an <b>Allowed Superclass</b>. | ||
− | </div> | + | |
+ | <noinclude></div></noinclude> |
Latest revision as of 16:33, November 13, 2008
The References Window
In a complex project, it is possible to have many different relationships between classes, instances, and slots. A reference for a frame is any other frame that has a direct relationship to it. The References window can be viewed by selecting an item and clicking on the References ( or ) button. See Viewing References for more information.
It is also possible to view those classes that are related through a particular slot, using the Relations Menu.
Examples
For example, references for a class include:
any superclasses of the class
any direct subclasses of the class
any instances of the class
any direct slots (inherited slots are not considered to be references)
any notes at the class
the metaclass of the class
For a slot, references include:
any superslots or subslots
:STANDARD-SLOT or other slot metaclass
any classes that have the slot attached as a direct slot
The References window allows you to view a list of all the references of a selected frame.
The View Buttons
View Reference: Opens the editor for the highlighted frame and allows you to view the frame's properties. Depending on the frame, this could be the Class Editor, the Slot Editor, or the Instance Editor. | |
View References to Value: Shows the references for the highlighted frame. |
The Frame Column
This column shows the name of each frame that references the highlighted item. The type of frame is indicated by a class icon, slot icon, or instance icon ().
The Slot Column
This column specifies the slot that actually references the selected item. Note that Protege-Frames provides standard slots which indicate the relationship between the selected item and the referencing frame. For example:
DIRECT-INSTANCES | The selected item is a direct instance of the frame. |
DIRECT-SUPERCLASSES |
The selected item is a direct superclass of the frame. |
DIRECT-SUBCLASSES |
The selected item is a direct subclass of the frame. |
SLOT-VALUE-TYPE |
The frame is a slot and the selected item appears as one of its values. If the selected item is an instance, it may be a value. If the selected item is a class, it may be an Allowed Superclass (for a slot of type Class) or an Allowed Class (for a slot of type Instance). |
The name of any other slot in the project may also appear in this column.
The Facet Column
This column gives information about the facet value for certain types of references and gives information about the slot relationships between classes. For example, an item may appear as a value for a slot which is called by that frame.
In the illustration above, the class Author appears as an Allowed Class for the slot author, as shown in the second row. In addition, the slot author appears as a slot for the class Article. Therefore, Article references Author. This reference appears in the fifth row in the example.
For an embedded reference of this type, the facet value column specifies whether the selected item appears as an Allowed Class or an Allowed Superclass.