PrF UG files database backend - Revision history

TaniaTudorache at 01:45, March 6, 2009

2009-03-06T01:45:45Z

RichMorin at 00:45, November 14, 2008

2008-11-14T00:45:44Z

RichMorin at 10:12, October 23, 2008

2008-10-23T10:12:34Z

RichMorin at 20:33, October 21, 2008

2008-10-21T20:33:43Z

RichMorin at 21:10, October 20, 2008

2008-10-20T21:10:08Z

RichMorin at 21:09, October 20, 2008

2008-10-20T21:09:22Z

RichMorin at 21:07, October 20, 2008

2008-10-20T21:07:03Z

RichMorin at 20:58, October 15, 2008

2008-10-15T20:58:51Z

RichMorin at 22:24, October 14, 2008

2008-10-14T22:24:45Z

RichMorin: Automated import of articles

2008-10-09T08:45:11Z

Automated import of articles

New page

__NOTOC__
== {{#var:Pr}} Database Format ==

{{PrF_UG_TOC_files}}<div id='prf_ug'>

You can save the ontology-related information for a {{#var:PrF}} project as a single table in a
[[PrF_UG_|JDBC database]].
Note that this is a "flat" table that does not use any special database constructs to represent the information.
Information specific to the {{#var:PrF}} user interface is stored in a separate {{#var:Pr}} project
(.pprj)
file.
See
[[PrF_UG_files_project_types|Understanding Project Types]]
for more information about these files.

<ul class='a'>
<li>
[[#Requirements|database requirements]]


<li>
[[#Creating_or_Importing_a_Database_Project|create or import]]
a database project


<li>
[[#Converting_a_Protege-frames_Project_to_a_Database|convert]]
a {{#var:PrF}} project to database format

</ul>

=== Requirements ===

Before you create a {{#var:Pr}} Database project,
you will need to do the following:

<ul class='a'>
<li>
Make sure you have a database program installed on your system.


<li>
Make sure you have a JDBC driver that is compatible with your database and the version of the Java VM that you are using.


<ul>
<li>
If you are using Microsoft Access,
you don't need to acquire a JDBC driver;
it's already bundled into the JDK.


<li>
Otherwise,
acquire a driver and rename it to "<tt>driver.jar</tt>" (or "<tt>driver1.jar</tt>" or "<tt>driver2.jar</tt>",
if you have several).
Add this driver to the {{#var:Pr}} installation directory (NOT the plugins directory).

</ul>
</ul>

You can store multiple projects in the same database by giving their tables different names.

Note: When a project is saved in a JDBC database,
backend changes to the database
(for example,
changes to slots,
classes,
and instances)
are committed as soon as they are made.
However,
changes to the User Interface
(stored in the .pprj file)
are not committed until you save the project,
for example by clicking Save.

=== Creating or Importing a Database Project ===

<ol class='a'>
<li>
Select New Project from the File menu.
The Create New Project dialog box will open.

 <div>[[Image:PrF_UG_projects_create_from_database.png|projects_create_from_database]]</div>


<li>
To
[[PrF_UG_projects_import_project|import]]
a project from existing files,
select Create from Existing Sources.
To create a new,
empty {{#var:PrF}} project,
leave this blank (the default).

 <div>[[Image:PrF_UG_files_create_from_existing_checkbox.png|files_create_from_existing_checkbox]]</div>


<li>
Select {{#var:Pr}} Database as the project type.


<li>
Click Next.


<li>
A {{#var:Pr}} Database dialog box will be displayed.

 <div>[[Image:PrF_UG_files_database_create.png|files_database_create]]</div>


<li>
Enter the class name of your JDBC driver in the JDBC Driver line of the dialog box.
The class name can be found in the documentation provided with your particular driver. (For Microsoft Access,
use: <tt>sun.jdbc.odbc.JdbcOdbcDriver</tt>)


<li>
Enter the URL for your database in the JDBC URL line.


 Note: For Microsoft Access,
navigate to the "ODBC Data Source Administrator" dialog via the Control Panel and add a User DSN for your Access database.
If you're unfamiliar with how to find this dialog or how to add a User DSN,
please refer to Microsoft Windows Help.
Your URL will look like: <tt>jdbc:odbc:<User DSN name></tt>


<li>
Enter the name for the database table where you will be storing the information.
If you are importing a file,
enter the name of the table that contains the information you wish to import.
This field is required.


<li>
If your database requires a username and/or password,
enter these in the appropriate lines of the dialog box.


<li>
Click Finish.

</ol>

To save your project and give it a name,
select Save from the File menu.
See
[[PrF_UG_projects_saving_a_project|Saving a Project]]
for more information.

=== Converting a {{#var:PrF}} Project to a Database ===

<ol class='a'>
<li>
Select File | Convert Project to Format...


<li>
Select {{#var:Pr}} Database in the Select Format dialog box.

 <div>[[Image:PrF_UG_files_database_convert.png|files_database_convert]]</div>


<li>
In the {{#var:Pr}} Database dialog box,
fill out the required information,
as described above.

</ol>

</div>

@@ Line 2: / Line 2: @@
 == {{#var:Pr}} Database Format ==
-{{PrF_UG_TOC_files}}<div id='prf_ug'>
+<noinclude>{{PrF_UG_TOC_files}}<div id='prf_ug'></noinclude>
 You can save the ontology-related information for a {{#var:PrF}} project
@@ Line 154: / Line 154: @@
-</div>
+<noinclude></div></noinclude>

@@ Line 66: / Line 66: @@
      </p>
      <div>[[Image:PrF_UG_projects_create_from_database.png|frame|none|
-            Create New Project dialog box]]</div>
+            Create New Project dialog box, "Protege Database" selected]]</div>
    <li><p>
@@ Line 76: / Line 76: @@
      </p>
      <div>[[Image:PrF_UG_files_create_from_existing_checkbox.png|frame|none|
-            Create from Existing Sources checkbox]]</div>
+            Create from Existing Sources checkbox (checked)]]</div>
    <li><p>
@@ Line 145: / Line 145: @@
      </p>
      <div>[[Image:PrF_UG_files_database_convert.png|frame|none|
-            Select Format dialog box]]</div>
+            Select Format dialog, "Protege Database" selected]]</div>
    <li><p>

@@ Line 79: / Line 79: @@
    <li><p>
-     Select <b>{{#var:Pr}} Database as the project type.
+     Select <b>{{#var:Pr}}</b> Database as the project type.
      </p>
@@ Line 90: / Line 90: @@
      </p>
      <div>[[Image:PrF_UG_files_database_create.png|frame|none|
-            {{#var:Pr}} Database</b> dialog box]]</div>
+            {{#var:Pr}} Database dialog box]]</div>
    <li><p>

@@ Line 76: / Line 76: @@
      </p>
      <div>[[Image:PrF_UG_files_create_from_existing_checkbox.png|frame|none|
-            Create from Existing_Sources checkbox]]</div>
+            Create from Existing Sources checkbox]]</div>
    <li><p>
-     Select <b>{{#var:Pr}} Database</b> as the project type.
+     Select <b>{{#var:Pr}} Database as the project type.
      </p>
@@ Line 144: / Line 144: @@
      Select <b>{{#var:Pr}} Database</b> in the <b>Select Format</b> dialog box.
      </p>
-     <div>[[Image:PrF_UG_files_database_convert.png|files_database_convert]]</div>
+     <div>[[Image:PrF_UG_files_database_convert.png|frame|none|
    <li><p>

@@ Line 65: / Line 65: @@
      The <b>Create New Project</b> dialog box will open.
      </p>
-     <div>[[Image:PrF_UG_projects_create_from_database.png|projects_create_from_database]]</div>
+     <div>[[Image:PrF_UG_projects_create_from_database.png|frame|none|
    <li><p>
@@ Line 74: / Line 75: @@
      leave this blank (the default).
      </p>
-     <div>[[Image:PrF_UG_files_create_from_existing_checkbox.png|files_create_from_existing_checkbox]]</div>
+     <div>[[Image:PrF_UG_files_create_from_existing_checkbox.png|frame|none|
    <li><p>
@@ Line 87: / Line 89: @@
      A <b>{{#var:Pr}} Database</b> dialog box will be displayed.
      </p>
-     <div>[[Image:PrF_UG_files_database_create.png|files_database_create]]</div>
+     <div>[[Image:PrF_UG_files_database_create.png|frame|none|
    <li><p>

@@ Line 32: / Line 32: @@
        If you are using Microsoft Access,
        you don't need to acquire a JDBC driver;
-       it's already bundled into the JDK.
+       it's already bundled into the JDK. (not recommended option due to slow performance)
        </p>

@@ Line 5: / Line 5: @@
 You can save the ontology-related information for a {{#var:PrF}} project
-as a single table in a [[PrF_UG_|JDBC database]].
+as a single table in a [{{#var:P_D}}/design/jdbc_backend.html JDBC database].
 Note that this is a "flat" table that does not use any special database constructs
 to represent the information.

@@ Line 4: / Line 4: @@
 {{PrF_UG_TOC_files}}<div id='prf_ug'>
-You can save the ontology-related information for a {{#var:PrF}} project as a single table in a
+You can save the ontology-related information for a {{#var:PrF}} project
-[[PrF_UG_|JDBC database]].
+as a single table in a [[PrF_UG_|JDBC database]].
-Note that this is a "flat" table that does not use any special database constructs to represent the information.
+Note that this is a "flat" table that does not use any special database constructs
-Information specific to the {{#var:PrF}} user interface is stored in a separate {{#var:Pr}} project
+to represent the information.
-(<b>.pprj</b>)
+Information specific to the {{#var:PrF}} user interface is stored
-file.
+in a separate {{#var:Pr}} project (<b>.pprj</b>) file.
-See
+See [[PrF_UG_files_project_types|Understanding Project Types]]
 for more information about these files.
@@ Line 25: / Line 24: @@
    <li><p>
-     Make sure you have a JDBC driver that is compatible with your database and the version of the Java VM that you are using.
+     Make sure you have a JDBC driver that is compatible with your database
      </p>
@@ Line 37: / Line 37: @@
      <li><p>
        Otherwise,
-       acquire a driver and rename it to "<tt>driver.jar</tt>" (or "<tt>driver1.jar</tt>" or "<tt>driver2.jar</tt>",
+       acquire a driver and rename it to "<tt>driver.jar</tt>"
-      if you have several).
+      (or "<tt>driver1.jar</tt>" or "<tt>driver2.jar</tt>", if you have several).
-       Add this driver to the {{#var:Pr}} installation directory (NOT the plugins directory).
+       Add this driver to the {{#var:Pr}} installation directory
        </p>
    </ul>
 </ul>
-You can store multiple projects in the same database by giving their tables different names.
+You can store multiple projects in the same database
-<b>Note:</b> When a project is saved in a JDBC database,
+<b>Note:</b>
 backend changes to the database
-(for example,
+(for example, changes to slots, classes, and instances)
 are committed as soon as they are made.
-However,
+However, changes to the User Interface
 (stored in the <b>.pprj</b> file)
 are not committed until you save the project,
@@ Line 65: / Line 64: @@
      Select <b>New Project</b> from the <b>File</b> menu.
      The <b>Create New Project</b> dialog box will open.
      </p>
    <li><p>
-     To
+     To [[PrF_UG_projects_import_project|import]]
      a project from existing files,
      select <b>Create from Existing Sources</b>.
-     To create a <i>new</i>,
+     To create a <i>new</i>, <i>empty</i> {{#var:PrF}} project,
      leave this blank (the default).
      </p>
    <li><p>
@@ Line 91: / Line 86: @@
    <li><p>
      A <b>{{#var:Pr}} Database</b> dialog box will be displayed.
      </p>
    <li><p>
-     Enter the class name of your JDBC driver in the <b>JDBC Driver</b> line of the dialog box.
+     Enter the class name of your JDBC driver
-     The class name can be found in the documentation provided with your particular driver. (For Microsoft Access,
+    in the <b>JDBC Driver</b> line of the dialog box.
-    use: <tt>sun.jdbc.odbc.JdbcOdbcDriver</tt>)
+     The class name can be found in the documentation provided with your particular driver.
      </p>
    <li><p>
      Enter the URL for your database in the <b>JDBC URL</b> line.
      </p>
-     <p> <b>Note:</b> For Microsoft Access,
+     <p>
-     navigate to the "ODBC Data Source Administrator" dialog via the Control Panel and add a User DSN for your Access database.
+    <b>Note:</b>
      If you're unfamiliar with how to find this dialog or how to add a User DSN,
      please refer to Microsoft Windows Help.
@@ Line 131: / Line 128: @@
 To save your project and give it a name,
 select <b>Save</b> from the <b>File</b> menu.
-See
+See [[PrF_UG_projects_saving_a_project|Saving a Project]]
 for more information.
@@ Line 144: / Line 140: @@
    <li><p>
      Select <b>{{#var:Pr}} Database</b> in the <b>Select Format</b> dialog box.
      </p>
    <li><p>
      In the <b>{{#var:Pr}} Database</b> dialog box,
-     fill out the required information,
+     fill out the required information, as described above.
      </p>
 </ol>