Difference between revisions of "PrF UG intro extending protege"

From Protege Wiki
Jump to: navigation, search
(Automated import of articles)
 
Line 5: Line 5:
  
 
{{#var:Pr}} includes an application programmer interface,
 
{{#var:Pr}} includes an application programmer interface,
the {{#var:Pr}} API,
+
the {{#var:Pr}} API, that allows a Java programmer to extend the {{#var:Pr}} system.
that allows a Java programmer to extend the {{#var:Pr}} system.
+
The API provides the Java packages and classes for complex operations
The API provides the Java packages and classes for complex operations such as creating new widgets:
+
such as creating new widgets:
  
 
<ul class='a'>
 
<ul class='a'>
 
   <li><p>
 
   <li><p>
     <b>Tab widget</b> - a user interface tab that appears in the main {{#var:Pr}} window alongside system tabs such as the Classes tab.
+
     <b>Tab widget</b> -
 +
    a user interface tab that appears in the main {{#var:Pr}} window
 +
    alongside system tabs such as the Classes tab.
 
     The Queries tab is an example of a tab-widget plug-in.
 
     The Queries tab is an example of a tab-widget plug-in.
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     <b>Slot widget</b> - appears on a form and is used to view and acquire a value for a slot at an instance.
+
     <b>Slot widget</b> -
     The TextFieldWidget,
+
    appears on a form and is used to view and acquire a value for a slot at an instance.
    used for acquiring and displaying strings,
+
     The TextFieldWidget, used for acquiring and displaying strings,
 
     is an example of a slot-widget plug-in.
 
     is an example of a slot-widget plug-in.
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     <b>Back-end</b> - specifies the mechanism that {{#var:Pr}} will use for storage (either as text or in a database).
+
     <b>Back-end</b> -
 +
    specifies the mechanism that {{#var:Pr}} will use for storage
 +
    (either as text or in a database).
 
     The RDF back-end is an example of a back-end plug-in.
 
     The RDF back-end is an example of a back-end plug-in.
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     <b>Createproject</b> - takes a file in a source format produced by another program and creates the closest possible "natural" {{#var:Pr}} knowledge-base.
+
     <b>Createproject</b> -
 +
    takes a file in a source format produced by another program
 +
    and creates the closest possible "natural" {{#var:Pr}} knowledge-base.
 
     </p>
 
     </p>
  
 
   <li><p>
 
   <li><p>
     <b>Export</b> - provides an extensible mechanism for exporting {{#var:Pr}} knowledge-bases in a variety of formats,
+
     <b>Export</b> -
    both file and database.
+
    provides an extensible mechanism for exporting {{#var:Pr}} knowledge-bases
 +
    in a variety of formats, both file and database.
 
     This plug-in type is related to back-end plug-ins,
 
     This plug-in type is related to back-end plug-ins,
 
     but is much easier to develop and serves a somewhat different need.
 
     but is much easier to develop and serves a somewhat different need.
Line 39: Line 46:
  
 
   <li><p>
 
   <li><p>
     <b>Project</b> - allows manipulation of a {{#var:Pr}} project and {{#var:Pr}}'s project UI.
+
     <b>Project</b> -
 +
    allows manipulation of a {{#var:Pr}} project and {{#var:Pr}}'s project UI.
 
     </p>
 
     </p>
 
</ul>
 
</ul>
Line 49: Line 57:
 
Starting with {{#var:Pr}} 3.2 beta,
 
Starting with {{#var:Pr}} 3.2 beta,
 
you can programmatically add your own configuration tab to the project configuration panel.
 
you can programmatically add your own configuration tab to the project configuration panel.
The tab will also appear in the
+
The tab will also appear
[[PrF_UG_projects_configure_project|Configure]]
+
in the [[PrF_UG_projects_configure_project|Configure]] dialog box.
dialog box.
 
 
Instructions for this can be found on the {{#var:Pr}} Wiki at:
 
Instructions for this can be found on the {{#var:Pr}} Wiki at:
  
[[PrF_UG_|http://protege.cim3.net/cgi-bin/wiki.pl?AddingUserDefinedProjectConfigPanel]]
+
http://protege.cim3.net/cgi-bin/wiki.pl?AddingUserDefinedProjectConfigPanel
  
 
</div>
 
</div>

Revision as of 01:01, October 16, 2008

Extending


Protege-Frames User's Guide
Intoductory Topics
Using this Guide
What is Protege?
What is Protege-Frames?
Planning a Project
A Newspaper Example
Extending Protege
Glossary, Editing Help

Protege includes an application programmer interface, the Protege API, that allows a Java programmer to extend the Protege system. The API provides the Java packages and classes for complex operations such as creating new widgets:

  • Tab widget - a user interface tab that appears in the main Protege window alongside system tabs such as the Classes tab. The Queries tab is an example of a tab-widget plug-in.

  • Slot widget - appears on a form and is used to view and acquire a value for a slot at an instance. The TextFieldWidget, used for acquiring and displaying strings, is an example of a slot-widget plug-in.

  • Back-end - specifies the mechanism that Protege will use for storage (either as text or in a database). The RDF back-end is an example of a back-end plug-in.

  • Createproject - takes a file in a source format produced by another program and creates the closest possible "natural" Protege knowledge-base.

  • Export - provides an extensible mechanism for exporting Protege knowledge-bases in a variety of formats, both file and database. This plug-in type is related to back-end plug-ins, but is much easier to develop and serves a somewhat different need.

  • Project - allows manipulation of a Protege project and Protege's project UI.

API documentation is available at:

http://protege.stanford.edu/doc/pdk/index.html

Starting with Protege 3.2 beta, you can programmatically add your own configuration tab to the project configuration panel. The tab will also appear in the Configure dialog box. Instructions for this can be found on the Protege Wiki at:

http://protege.cim3.net/cgi-bin/wiki.pl?AddingUserDefinedProjectConfigPanel