risource

[..] [files] ( content dom dps ds pia sax servlet site tf util )

This directory contains the Java reference implementation of the PIA. All of the source code under this directory is ``open source'' under the terms of the Ricoh Source Code Public License, which can be found in the top-level directory of this software distribution.

Annotated Contents

Top Level Packages

org.risource.dps: Document Processing System. This is the PIA's mechanism for expanding ``active content'' represented in XML, and for operating on HTML and other documents from the Web. You will need to understand parts of this package if you want to implement new tag handlers in Java, or use the DPS in situations not covered by the simplified interfaces in the sax package.
org.risource.pia: The PIA proxy server itself. You will need to understand parts of this package if you want to implement new agents in Java, in order to perform unusual operations on web transactions.
org.risource.site: The Site Resource Package, which provides flexible web-site configuration and management to PIA-based servers. You will need to understand parts of this package if you want to implement classes that can be ``mounted'' as part of an application's URL hierarchy.

Standard API's

org.risource.dom: Interfaces and classes for use by application programmers who want to use the Document Processing System in applications based on the W3C's Document Object Model. The DPS includes an implementation, with extensions, of the DOM in dps/tree/; the extended interfaces are in dps/active/.
org.risource.sax: Interfaces and classes for use by application programmers who want to use the Document Processing System in applications based on SAX, the Simple API for XML.
org.risource.servlet: Servlet implementation classes, for use in servlet engines such as Tomcat and Apache-JServ

Subsidiary Packages

In most cases, the average application programmer will not need to make direct use of these packages. You may need to refer to some of their interfaces if you are writing extensions in the dps or pia packages.

org.risource.content

Representations for message content.

org.risource.ds

Data Structures. Classes in this directory provide a largely language-independent set of data structures that are used throughout the PIA.

org.risource.tf

Classes that compute Transaction Features. These are lazily-evaluated values matched by the PIA against each agent's selection criteria.

org.risource.util

Utility classes.

test/

Test cases and drivers (mostly obsolete at this point).

Naming Conventions

Every effort has been made to reduce directory depth in order to accommodate Microsoft and ISO9660 restrictions. In particular, the hierarchy extends only two more levels below this directory (e.g. dps/handle).

      Name                    Last modified      Size  Description
      Parent Directory                             -   
      Makefile                2012-04-01 16:18  1.3K  
      Version.java            2012-04-01 16:18  2.5K  
      content/                2012-04-01 16:18    -   
      dom/                    2012-04-01 16:18    -   
      dps/                    2012-04-01 16:18    -   
      ds/                     2012-04-01 16:18    -   
      pia/                    2012-04-01 16:18    -   
      sax/                    2012-04-01 16:18    -   
      servlet/                2012-04-01 16:18    -   
      site/                   2012-04-01 16:18    -   
      test/                   2012-04-01 16:18    -   
      tf/                     2012-04-01 16:18    -   
      util/                   2012-04-01 16:18    -