Difference between revisions of "PrF UG inst entry field instance"

From Protege Wiki
Jump to: navigation, search
Line 4: Line 4:
 
{{PrF_UG_TOC_inst}}<div id='prf_ug'>
 
{{PrF_UG_TOC_inst}}<div id='prf_ug'>
  
−
When an instance is created for a class with a slot of
+
When an instance is created for a class with a slot
−
[[PrF_UG_slots_value_type_instance|Value Type Instance]],
+
of [[PrF_UG_slots_value_type_instance|Value Type Instance]],
 
the entry field corresponding to the slot is an Instance entry field.
 
the entry field corresponding to the slot is an Instance entry field.
 
It contains values which are direct or indirect instances of the classes specified
 
It contains values which are direct or indirect instances of the classes specified
Line 19: Line 19:
 
The value of this slot is a single instance:
 
The value of this slot is a single instance:
  
−
<div>[[Image:PrF_UG_inst_filled_entry_instance.png|instances_filled_entry_instance]]</div>
+
<div>[[Image:PrF_UG_inst_filled_entry_instance.png|
 +
      instances_filled_entry_instance]]</div>
  
 
=== Multiple Cardinality ===
 
=== Multiple Cardinality ===
Line 26: Line 27:
 
The value of this slot is a list of instances:
 
The value of this slot is a list of instances:
  
−
<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|instances_filled_instance_multiple]]</div>
+
<div>[[Image:PrF_UG_inst_filled_instance_multiple.png|
 +
      instances_filled_instance_multiple]]</div>
  
 
Note the following for fields of multiple cardinality:
 
Note the following for fields of multiple cardinality:
Line 42: Line 44:
  
 
   <li><p>
 
   <li><p>
−
     If the <b>at most</b> value is set in the
+
     If the <b>at most</b> value is set
−
    [[PrF_UG_slots_slot_editor#Cardinality|Cardinality]]
+
    in the [[PrF_UG_slots_slot_editor#Cardinality|Cardinality]] field
−
     field for the slot,
+
     for the slot,
 
     there is a limit on the number of instances you can enter.
 
     there is a limit on the number of instances you can enter.
 
     </p>
 
     </p>
Line 65: Line 67:
  
 
   <li><p>
 
   <li><p>
−
     Enter the updated information directly in the
+
     Enter the updated information directly
−
    [[PrF_UG_inst_instance_editor|Instance Editor]].
+
    in the [[PrF_UG_inst_instance_editor|Instance Editor]].
 
     </p>
 
     </p>
 
</ol>
 
</ol>
  
−
Note that <i>any edits you make to this instance will appear in all locations where this instance occurs.</i> You should be sure that you want the change to be global before editing an existing instance.
+
Note that <i>any edits you make to this instance will appear in all locations
−
In some cases,
+
where this instance occurs.</i>
−
it may be more appropriate to create a new instance,
+
You should be sure that you want the change to be global before editing an existing instance.
−
instead.
+
In some cases, it may be more appropriate to create a new instance, instead.
  
 
=== Creating an Instance ===
 
=== Creating an Instance ===
Line 82: Line 84:
 
   <li><p>
 
   <li><p>
 
     Click the <b>Create Instance</b>
 
     Click the <b>Create Instance</b>
−
     [[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]]
+
     [[Image:PrF_UG_inst_instance.create.gif|instances_instance.create]] button.
−
    button.
 
 
     </p>
 
     </p>
  
Line 94: Line 95:
 
     [[Image:PrF_UG_classes_class.gif|classes_class]].
 
     [[Image:PrF_UG_classes_class.gif|classes_class]].
 
     Select a class and click <b>OK</b>.
 
     Select a class and click <b>OK</b>.
−
   
 
−
    </p><p> <div>[[Image:PrF_UG_inst_select_concrete_cls.png|instances_select_concrete_cls]]</div>
 
 
     </p>
 
     </p>
 +
    <div>[[Image:PrF_UG_inst_select_concrete_cls.png|instances_select_concrete_cls]]</div>
  
 
   <li><p>
 
   <li><p>
−
     A direct instance of the selected class will be created and a blank
+
     A direct instance of the selected class will be created
−
    [[PrF_UG_inst_instance_editor|Instance Editor]]
+
    and a blank [[PrF_UG_inst_instance_editor|Instance Editor]] will be displayed.
−
    will be displayed.
+
     Fill in the editor for the new instance, as desired.
−
     Fill in the editor for the new instance,
 
−
    as desired.
 
 
     </p>
 
     </p>
 
</ol>
 
</ol>
Line 114: Line 112:
 
   <li><p>
 
   <li><p>
 
     Click the <b>Add Instance</b>
 
     Click the <b>Add Instance</b>
−
     [[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]]
+
     [[Image:PrF_UG_inst_instance.add.gif|instances_instance.add]] button.
−
    button.
 
 
     A <b>Select Instance</b> dialog box will be displayed.
 
     A <b>Select Instance</b> dialog box will be displayed.
−
   
 
−
    </p><p> <div>[[Image:PrF_UG_inst_select_instance.png|instances_select_instance]]</div>
 
 
     </p>
 
     </p>
 +
    <div>[[Image:PrF_UG_inst_select_instance.png|instances_select_instance]]</div>
  
 
   <li><p>
 
   <li><p>
Line 128: Line 124:
 
   <li><p>
 
   <li><p>
 
     If the class has subclasses,
 
     If the class has subclasses,
−
     use the menu at the top of the Instances pane to choose the instances you want to see:
+
     use the menu at the top of the Instances pane
 +
    to choose the instances you want to see:
 
     </p>
 
     </p>
  
Line 137: Line 134:
 
    
 
    
 
     <li><p>
 
     <li><p>
−
       <b>All Instances</b> displays the instances of the class <i>and</i> all of its descendants (subclasses,
+
       <b>All Instances</b> displays the instances of the class
−
      subsubclasses,
+
      <i>and</i> all of its descendants (subclasses, subsubclasses, etc.)
−
      etc.)
 
 
       </p>
 
       </p>
 
   </ul>
 
   </ul>
Line 156: Line 152:
  
 
This selects a pre-existing instance as the value of the field.
 
This selects a pre-existing instance as the value of the field.
−
This instance can also be viewed in the
+
This instance can also be viewed
−
[[PrF_UG_inst_instance_browser|Instance Browser]]
+
in the [[PrF_UG_inst_instance_browser|Instance Browser]]
 
and may also appear as a value for other instances.
 
and may also appear as a value for other instances.
−
Note that <i>any edits you make to this instance will appear in all locations where this instance occurs.</i> You should be sure that you want the change to be global before editing an existing instance.
+
Note that <i>any edits you make to this instance will appear in all locations
−
In some cases,
+
where this instance occurs.</i>
−
it may be more appropriate to create a new instance instead.
+
You should be sure that you want the change to be global
 +
before editing an existing instance.
 +
In some cases, it may be more appropriate to create a new instance instead.
  
 
=== Removing an Instance ===
 
=== Removing an Instance ===
Line 170: Line 168:
 
   <li><p>
 
   <li><p>
 
     Click the <b>Remove Instance</b>
 
     Click the <b>Remove Instance</b>
−
     [[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]]
+
     [[Image:PrF_UG_inst_instance.remove.gif|instances_instance.remove]] button.
−
    button.
 
 
     The instance will be removed.
 
     The instance will be removed.
 
     </p>
 
     </p>
Line 178: Line 175:
 
This removes the instance as a value of the current field,
 
This removes the instance as a value of the current field,
 
but does not remove it from the project.
 
but does not remove it from the project.
−
The instance can still be viewed via the
+
The instance can still be viewed
−
[[PrF_UG_inst_instance_browser|Instance Browser]]
+
via the [[PrF_UG_inst_instance_browser|Instance Browser]]
 
for the correct class,
 
for the correct class,
 
and still appears in any other field where it has been selected.
 
and still appears in any other field where it has been selected.
−
To
+
To [[PrF_UG_inst_deleting_an_instance|delete]]
−
[[PrF_UG_inst_deleting_an_instance|delete]]
 
 
an instance from the knowledge base,
 
an instance from the knowledge base,
 
use the <b>Delete Instance</b>
 
use the <b>Delete Instance</b>
−
<div>[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]]</div>
+
[[Image:PrF_UG_inst_instance.delete.gif|instances_instance.delete]] button
−
button in the
+
in the [[PrF_UG_inst_instance_browser|Instance Browser]].
−
[[PrF_UG_inst_instance_browser|Instance Browser]].
 
  
 
</div>
 
</div>

Revision as of 16:19, October 15, 2008

The Instance Fields


Protege-Frames User's Guide
Instances
Instances Tab
Class Browser at Instances Tab
Instance Browser
Instances Window
Instance Buttons
Instance Menu
Types Pane
Instance Editor
Standard Field Types
Fields with Multiple Cardinality
Boolean Fields
Class Fields
Float Fields
Instance Fields
Integer Fields
String Fields
Symbol Fields
Creating an Instance
Creating Multiple Instances
Displaying the Instance Editor
Setting the Display Slot
Showing Subclass Instances
Editing an Instance
Copying an Instance
Deleting an Instance
Finding an Instance
Changing an Instance's Class
Working with Instance Types
Instance Icons
Glossary, Editing Help

When an instance is created for a class with a slot of Value Type Instance, the entry field corresponding to the slot is an Instance entry field. It contains values which are direct or indirect instances of the classes specified as allowed classes for the slot. (Direct instances are instances of the class; indirect instances are instances of a class subordinate to the class, e.g., a subclass.)

Single Cardinality

An instance with an Instance/Single slot shows a display field and four buttons that let you edit, create, add, and remove instances. The value of this slot is a single instance:

instances_filled_entry_instance

Multiple Cardinality

An instance with an Instance/Multiple slot shows a display list. The value of this slot is a list of instances:

instances_filled_instance_multiple

Note the following for fields of multiple cardinality:

  • To select multiple instances to view or remove, use Ctrl (Cmd); use Shift to select a range.

  • Adding an instance does not replace a previous one.

  • If the at most value is set in the Cardinality field for the slot, there is a limit on the number of instances you can enter.

Editing an Instance

To edit an existing instance:

  1. Click the View Instance instances_instance.view button to open the Instance Editor for the instance that is displayed or selected. If no instance is currently displayed, the View Instance button will be grayed out.

  2. Enter the updated information directly in the Instance Editor.

Note that any edits you make to this instance will appear in all locations where this instance occurs. You should be sure that you want the change to be global before editing an existing instance. In some cases, it may be more appropriate to create a new instance, instead.

Creating an Instance

To create a new instance:

  1. Click the Create Instance instances_instance.create button.

  2. If there is more than one allowed class, or if the allowed class has subclasses, a dialog box will appear, asking you to select a Concrete class, displayed with a solid icon classes_class. Select a class and click OK.

    instances_select_concrete_cls

  3. A direct instance of the selected class will be created and a blank Instance Editor will be displayed. Fill in the editor for the new instance, as desired.

Adding an Instance

To add an existing instance to the value of the field:

  1. Click the Add Instance instances_instance.add button. A Select Instance dialog box will be displayed.

    instances_select_instance

  2. In the Allowed Classes pane, select the class where the instance you want is located.

  3. If the class has subclasses, use the menu at the top of the Instances pane to choose the instances you want to see:

    • Direct Instances limits the display to direct instances of the class

    • All Instances displays the instances of the class and all of its descendants (subclasses, subsubclasses, etc.)

  4. Select a single instance.

  5. Click OK. The instance you selected will be displayed. If another instance was displayed previously, it will now be gone.

This selects a pre-existing instance as the value of the field. This instance can also be viewed in the Instance Browser and may also appear as a value for other instances. Note that any edits you make to this instance will appear in all locations where this instance occurs. You should be sure that you want the change to be global before editing an existing instance. In some cases, it may be more appropriate to create a new instance instead.

Removing an Instance

To remove an instance:

  1. Click the Remove Instance instances_instance.remove button. The instance will be removed.

This removes the instance as a value of the current field, but does not remove it from the project. The instance can still be viewed via the Instance Browser for the correct class, and still appears in any other field where it has been selected. To delete an instance from the knowledge base, use the Delete Instance instances_instance.delete button in the Instance Browser.

Retrieved from "https://protegewiki.stanford.edu/index.php?title=PrF_UG_inst_entry_field_instance&oldid=3559"