<?xml version='1.0' ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
               "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % myvars SYSTEM "../variables.ent">
%myvars;
]>
<sect1 id="objects" xreflabel="OpenACS Data Models and the Object System">
<title>OpenACS Data Models and the Object System</title>

<authorblurb>
<para>By Pete Su</para>
</authorblurb>

<sect2 id="objects-overview"><title>Overview</title>

<para>
Developing data models in OpenACS &version; is much like developing data models
for OpenACS 3, save for the implementation.  As usual, you need to examine
how to model the information that the application must store and
manipulate, and define a suitable set of SQL tables.  In our Notes
application, we have to be able to keep track of who entered a
particular note, when they did it, and the actual text of the notes
that users have entered.  A simple data model might look like this:
</para>


<programlisting>
create table notes (
    note_id           integer primary key,
    owner_id          integer references users(user_id),
    creation_user     references(user_id) not null,
    creation_date     date not null,
    last_modified     date not null,
    title             varchar(255) not null,
    body              varchar(1024)
)
</programlisting>


<para>
We've omitted constraint names for the purpose of clarity.
</para>

<para>
Thinking further ahead, we can imagine doing any of the following
things with Notes as well:
</para>

<itemizedlist mark="opencircle">
<listitem><para>Define access control policies on notes.</para></listitem>
<listitem><para>Attach user comments on notes.</para></listitem>
<listitem><para>Allow users to define custom fields to store on their notes.</para></listitem>
<listitem><para>Automatically generate input forms or output displays for notes.</para></listitem>
<listitem><para>Allow other applications to use notes in ways we don't know of yet.</para></listitem>
</itemizedlist>

<para>
In OpenACS, the key to enabling these types of services on your
application data is to take advantage of the Object System.  The first
question, then, is "Just what are objects, and what do
you use them for anyway?".  The short answer: objects are anything
represented in the application's data model that will need to be
managed by any central service in OpenACS, or that may be reusable in
the context of future applications. Every object in the system is
represented using a row in the <computeroutput>acs_objects</computeroutput> table. This
table defines all the standard attributes that are stored on every
object, including its system-wide unique ID, object type, and some
generic auditing columns.
</para>

<para>
To make use of the object system, you as the application developer
have to write your data model in a way that is slightly more complex
than in the ACS 3.x days. What you get for this extra work includes:

<itemizedlist>
  <listitem><para>The <xref linkend="permissions"></xref> lets you 
      track who is allowed to do what to the rows
      in an application table, and gives you an easy way to enforce
      this from Tcl.</para></listitem>

  <listitem><para>Every object has an attribute called <computeroutput>context_id</computeroutput>
      that provides a way to trivially specify both the default
      permissions for an object, and the intended "scope" of an
      object. Just set the <computeroutput>context_id</computeroutput> to the controlling
      object and forget about it.</para></listitem>

  <listitem><para>And most importantly, any future object-level service - from
      a general-comments replacement to personalized ranking - will
      become available to your application "for free."</para></listitem>
</itemizedlist>
</para>

</sect2>

<sect2 id="objects-how-to-use"><title>How to Use Objects</title>

<para>
Using ACS objects is straightforward: all that's required are a few
extra steps in the design of your application data model. 
</para>

<para>
In order to hook our Notes application into the object system, we
make some calls to use our <computeroutput>notes</computeroutput> table as the basis for a
new <emphasis>object type</emphasis>. Object types are analogous to classes in
programming languages such as C++ and Java. In Java, a
class defines a set of attributes that store data and a set of methods
that run code. In OpenACS, we use one or more database tables to store the
data attributes, and we define a stored procedure package to hold procedures to
define the programming interface to the data model.
</para>

<para>
The object type itself is described using data in the
<computeroutput>acs_object_types</computeroutput> and
<computeroutput>acs_attributes</computeroutput> tables, which play a role
similar to the data dictionary in Oracle. As in Java, object types can
inherit attributes from a parent type, so the type system forms a
hierarchy. Unlike Java, Oracle does not support this inheritance
transparently, so we have to make sure we add our own bookkeeping code to
keep everything consistent. Below you'll find the code needed to describe a
new object type called <computeroutput>notes</computeroutput> in your
system.
</para>

<para>
Fire up your text editor and open the
<computeroutput>ROOT/packages/notes/sql/oracle/notes-create.sql</computeroutput> (<computeroutput>ROOT/packages/notes/sql/postgresql/notes-create.sql</computeroutput> for the PG version) file created
when we <link linkend="packages">created the package</link>.  Then, do the following:
</para>



<sect3>
<title>Describe the new type to the type system</title>


<para>
First, add an entry to the <computeroutput>acs_object_types</computeroutput> table with the following PL/SQL call:
</para>

<programlisting>
begin  
  acs_object_type.create_type ( 
    supertype     => 'acs_object', 
    object_type   => 'note', 
    pretty_name   => 'Note', 
    pretty_plural => 'Notes', 
    table_name    => 'NOTES', 
    id_column     => 'NOTE_ID' 
  ); 
end;
/
show errors;
</programlisting>

<para>
This PL/SQL call tells the system that we would like to use the table
<computeroutput>NOTES</computeroutput> as the basis for a new object type called
<computeroutput>note</computeroutput>. This type is a subtype of the 
<computeroutput>acs_object</computeroutput> type, which means that we want to inherit all
of the basic attributes of all ACS objects. As mentioned, it will take
some work on our part to make this happen, since Oracle can't do it
automatically.  In general, most basic applications will define types
that are simple subtypes of <computeroutput>acs_object</computeroutput>.
</para>

<para>
Add entries to the <computeroutput>acs_attributes</computeroutput> table to describe
the data attributes of the new type. This data can eventually be used
to do things like automatically generate user interfaces to manipulate
the <computeroutput>notes</computeroutput> table, though that functionality isn't yet
available.
</para>

<programlisting>
declare 
 attr_id acs_attributes.attribute_id%TYPE; 
begin
  attr_id := acs_attribute.create_attribute ( 
    object_type    => 'note', 
    attribute_name => 'TITLE', 
    pretty_name    => 'Title', 
    pretty_plural  => 'Titles', 
    datatype       => 'string' 
  ); 
 
  attr_id := acs_attribute.create_attribute ( 
    object_type    => 'note', 
    attribute_name => 'BODY', 
    pretty_name    => 'Body', 
    pretty_plural  => 'Bodies', 
    datatype       => 'string' 
  ); 
end; 
/ 
show errors; 
</programlisting>

<para>
We can stop here and not bother to register the usual OpenACS 3.x
attributes of <computeroutput>creation_user</computeroutput>, <computeroutput>creation_date</computeroutput>
and <computeroutput>last_modified</computeroutput>, since the object type
<computeroutput>acs_object</computeroutput> already defines these attributes. Again,
because the new type <computeroutput>note</computeroutput> is a subtype of
<computeroutput>acs_object</computeroutput>, it will inherit these attributes, so there is
no need for us to define them.
</para>


</sect3>

<sect3>
<title>Define a table in which to store your objects</title>

<para>
The next thing we do is make a small modification to the data model to
reflect the fact that each row in the <computeroutput>notes</computeroutput> table
represents something that is not only an object of type
<computeroutput>note</computeroutput>, but also an <computeroutput>acs_object</computeroutput>. The new table
definition looks like this:
</para>


<programlisting>
create table notes (
    note_id    integer references acs_objects(object_id) primary key,
    owner_id   integer references users(user_id),
    title      varchar(255) not null,
    body       varchar(1024)
)
</programlisting>


<para>
The usual <computeroutput>creation_date</computeroutput> and
<computeroutput>modified_date</computeroutput> columns are absent since they already exist
in <computeroutput>acs_objects</computeroutput>.  Also, note the constraint we have added
to reference the <computeroutput>acs_objects</computeroutput> table, which makes clear
that since <computeroutput>note</computeroutput> is a subtype of <computeroutput>acs_object</computeroutput>,
every row in the notes table must have a corresponding row in the
<computeroutput>acs_objects</computeroutput> table. This is the fundamental means by which
we model inheritance; it guarantees that any services that
use the <computeroutput>acs_objects</computeroutput> table to find objects will
transparently find any objects that are instances of any subtype of
<computeroutput>acs_objects</computeroutput>.
</para>

</sect3>

<sect3>
<title>Define a package for type specific procedures</title>

<para>
The next step is to define a PL/SQL package for your new type, and
write some basic procedures to create and delete objects. Here is a
package definition for our new type:
</para>


<programlisting>
create or replace package note 
as 
  function new ( 
    note_id             in notes.note_id%TYPE default null, 
    owner_id            in notes.owner_id%TYPE default null, 
    title               in notes.title%TYPE, 
    body                in notes.body%TYPE, 
    object_type         in acs_object_types.object_type%TYPE default 'note', 
    creation_date       in acs_objects.creation_date%TYPE 
                           default sysdate, 
    creation_user       in acs_objects.creation_user%TYPE 
                           default null, 
    creation_ip         in acs_objects.creation_ip%TYPE default null, 
    context_id          in acs_objects.context_id%TYPE default null 
  ) return notes.note_id%TYPE; 
 
  procedure delete ( 
    note_id      in notes.note_id%TYPE 
  ); 
end note; 
/ 
show errors 
</programlisting>


<para>
You might be wondering what all the extra parameters are to these
calls, since we haven't mentioned them before.  These parameters are
needed to fill out information that will be stored about the object
that's not stored directly in the table you defined. The OpenACS Object
System defines these attributes on the type <computeroutput>acs_object</computeroutput>
since all objects should have these attributes. Internally, there are
tables that store this information for you. Most of the data is pretty
self-explanatory and reflects attributes that existed in the earlier
OpenACS 3.x data models, with the exception of the <computeroutput>context_id</computeroutput>
attribute.
</para>

<para>
The <computeroutput>context_id</computeroutput> attribute stores the ID of an object that
represents the default security domain to which the object belongs. It
is used by the <link linkend="permissions">permissions</link> system in
this way: if no permissions are explicitly attached to the object,
then the object inherits its permissions from the context. For
example, if I had told you how to use the <link linkend="permissions">permissions</link> system to specify that an
object OBJ was "read only", then any other object that used OBJ as its
context would also be "read only" by default. We'll talk about this more
later.
</para>
</sect3>

<sect3>
<title>Define a package body for type specific procedures</title>

<para>
The PL/SQL package body contains the implementations of the procedures
defined above. The only subtle thing going on here is that we must use
<computeroutput>acs_object.new</computeroutput> to insert a row into
<computeroutput>acs_objects</computeroutput>, before inserting a row into the
<computeroutput>notes</computeroutput>. Similarly, when we delete a row from
<computeroutput>note</computeroutput>, we have to be sure to delete the corresponding
<computeroutput>acs_object</computeroutput> row.
</para>


<programlisting>
create or replace package body note 
as 
 
  function new ( 
    note_id             in notes.note_id%TYPE default null, 
    owner_id            in notes.owner_id%TYPE default null, 
    title               in notes.title%TYPE, 
    body                in notes.body%TYPE, 
    object_type         in acs_object_types.object_type%TYPE default 'note', 
    creation_date       in acs_objects.creation_date%TYPE 
                           default sysdate, 
    creation_user       in acs_objects.creation_user%TYPE 
                           default null, 
    creation_ip         in acs_objects.creation_ip%TYPE default null, 
    context_id          in acs_objects.context_id%TYPE default null 
  ) return notes.note_id%TYPE 
  is 
    v_note_id integer; 
  begin 
    v_note_id := acs_object.new ( 
      object_id     => note_id, 
      object_type   => object_type, 
      creation_date => creation_date, 
      creation_user => creation_user, 
      creation_ip   => creation_ip, 
      context_id    => context_id 
    ); 
    
    insert into notes 
     (note_id, owner_id, title, body) 
    values 
     (v_note_id, owner_id, title, body); 
 
     return v_note_id; 
  end new; 
  
  procedure delete ( 
    note_id      in notes.note_id%TYPE 
  ) 
  is 
  begin 
    delete from notes 
    where note_id = note.delete.note_id; 
 
    acs_object.del(note_id); 
  end delete; 
 
end note; 
/ 
show errors; 
</programlisting>

<para>
That's pretty much it! As long as you use the <computeroutput>note.new</computeroutput>
function to create notes, and the <computeroutput>note.delete</computeroutput> function to
delete them, you'll be assured that the relationship each
<computeroutput>note</computeroutput> has with its corresponding <computeroutput>acs_object</computeroutput>
is preserved.
</para>

<para>
The last thing to do is to make a file
<computeroutput>ROOT/packages/notes/sql/notes-drop.sql</computeroutput> so it's easy to
drop the data model when, say, you're testing:
</para>


<programlisting>
begin 
  acs_object_type.drop_type ('note'); 
end; 
/ 
show errors 
 
drop package note; 
drop table notes; 
</programlisting>



</sect3>


</sect2>



<sect2 id="objects-when-to-use-objects"><title>When to Use Objects</title>

<para>
While it is hard to give general design advice without
knowing anything about a particular application, you should follow the
following rule of thumb when deciding when to hook part of your data
model to the object system:
</para>

<para>
Anything in your data model that needs to be available to general OpenACS
services such as user comments, permissions, and so on should be a
subtype of <computeroutput>acs_object</computeroutput>. In addition, if you want your data
model to take advantage of attributes that exist in some object type
that is a subtype of <computeroutput>acs_object</computeroutput>, then you should use the
object system.
</para>

<para>
For example, for most applications, you will want to use objects to
represent the data in your application that is user visible and thus
requires access control. But other internal tables, views, mapping
tables and so on probably don't need to be objects. As before, this
kind of design decision is mostly made on an
application-by-application basis, but this is a good baseline from
which to start.
</para>

</sect2>

<sect2 id="objects-design-guidance"><title>Design Guidance</title>

<para>
In this section we cover some overall guidelines for designing data
models that are meant to be integrated with the OpenACS object
system. 
</para>

<para>
There are two basic rules you should follow when designing OpenACS &version; data
models:


<orderedlist numeration="arabic">
<listitem><para>
Never utilize fields in the <computeroutput>acs_objects</computeroutput> table in
application specific ways. That is, never assign any
application-specific semantics to this data.  In the notes
application, we use the <computeroutput>creation_date</computeroutput> and
<computeroutput>last_modified</computeroutput> fields, but this is OK since we do not
assign any application-specific meaning to these fields.
</para></listitem>

<listitem><para>
In particular, never assign any application specific semantics to the
<computeroutput>context_id</computeroutput> attribute of an object. This field is used for
a very specific purpose by the permissions system, and using this
field in <emphasis>any other way whatsoever</emphasis> is guaranteed to make your
application act strangely.
</para>

<para>
As we'll see later, the Notes example will point each note object's
<computeroutput>context_id</computeroutput> to the package instance in which the note was
created. The idea will be that in a real site, the administrator would
create one package instance for every separate set of Notes (say, one
per user). The instance would "own" all of the notes that it created,
and the administrator would be able to use the package instance as
the basis for access control, which is convenient.
</para></listitem>
</orderedlist>


The reason behind these two rules is pretty straightforward: First,
the OpenACS Object system itself is meant to be a generic and reusable
tool for any application to use for basic services. Second, in order
for this to work, the various parts of the OpenACS Objects data model must
be interpreted in the same way by all applications that use the data
model. Therefore, assigning any application-specific semantics to any
part of the core data model is a bad thing to do, because then the
semantics of the data model are no longer independent of the
application. This would make it impossible to build the generic tools
that the data model is trying to support.
</para>

<para>
Another less important reason for these two rules is to not introduce
any joins against the <computeroutput>acs_objects</computeroutput> table in SQL queries in
your application that you do not absolutely need. 
</para>

<para>
In the Notes example,  the result of applying these rules is that we
are careful to define our own attribute for <computeroutput>owner_id</computeroutput>
rather than overloading <computeroutput>creation_user</computeroutput> from the objects
table. But, since we will probably use <computeroutput>creation_date</computeroutput> and
so on for their intended purposes, we don't bother to define our own
attributes to store that data again. This will entail joins with
<computeroutput>acs_objects</computeroutput> but that's OK because it makes the overall
data model cleaner. The real lesson is that deciding exactly how and
when to use inherited attributes is fairly straightforward, but
requires a good amount of thought at design time even for simple
applications.
</para>

</sect2>

<sect2 id="objects-summary"><title>Summary</title>

<para>
Hooking into the OpenACS &version; object system brings the application developer
numerous benefits, and doing it involves only four easy steps:


<itemizedlist mark="opencircle">
<listitem><para>
Describe the a new object type to the system. Most new application
types will be subtypes of the built-in type <computeroutput>acs_object</computeroutput>.
</para></listitem>
<listitem><para>
Define a table to store application object data.
</para></listitem>
<listitem><para>
Define a PL/SQL package to store procedures related to the new
type. You have to define at least a function called <computeroutput>new</computeroutput>
to create new application objects and a procedure called
<computeroutput>delete</computeroutput> to delete them.
</para></listitem>
<listitem><para>
Define a package body that contains the implementations of the PL/SQL
procedures defined above.
</para></listitem>
<listitem><para>
Try not to write queries in your application that join against
<computeroutput>acs_objects</computeroutput>. This means you should never use the fields
in <computeroutput>acs_objects</computeroutput> for application-specific purposes. This is
especially true for the <computeroutput>context_id</computeroutput> field.
</para></listitem>
</itemizedlist>

</para>

<para><phrase role="cvstag">($Id: objects.xml,v 1.9 2006/07/17 05:38:37 torbenb Exp $)</phrase></para>

</sect2>



</sect1>
