Welcome to PReServ's JavaDoc!

See:
          Description

Packages
org.pasoa.common (Mostly internal) Common classes used across the PASOA project.
org.pasoa.common.structure (External) Provenance data structures: p-assertions, interaction record, etc .
org.pasoa.common.structure.deserialiser  
org.pasoa.common.structure.serialiser  
org.pasoa.dommap (External) Simple Classes that implement W3C Document Object Model.
org.pasoa.factory (Internal) Provides classes for creating and keeping track of multiple provenance stores in a provenance service.
org.pasoa.processor (Internal) Provides classes for translating incoming information into the internal format of the provenance store and dispatching the information to the approprate plugin to be handled.
org.pasoa.query (Internal) Classes for executing queries (XPath, XQuery, Provenance) over the p-structure.
org.pasoa.query.dom  
org.pasoa.query.provenance  
org.pasoa.query.xpath  
org.pasoa.query.xpath.jaxen  
org.pasoa.query.xquery  
org.pasoa.query.xquery.ipsixq  
org.pasoa.record (Internal) Plug-in & classes to handle the recording of p-assertions.
org.pasoa.servlet (Internal) A servlet front end to a provenance store(s).
org.pasoa.storage (Internal) Classes and interfaces that abstract away from the underlying storage system.
org.pasoa.storage.je (Internal) A Berkeley Java DB based implementation of the BackendStore interface.
org.pasoa.storage.memory (Internal) An in memory based implementation of the BackendStore interface.
org.pasoa.test  
org.pasoa.test.examples (External) Assorted examples of how to use the provenance service and the client libraries provides by PReServ.
org.pasoa.test.examples.average  
org.pasoa.ui.xqforward  
org.pasoa.util (External) Utility classes.
org.pasoa.util.httpsoap (External) Utility classes for working with SOAP documents and transmitting them over http.
org.pasoa.util.rdf  
org.pasoa.wrappers.axishandler  

 


Welcome to PReServ's JavaDoc!

Before studying this API documentation in-depth, we suggest you read the Architecture for Provenance Systems document first. The architecture document provides a comprehensive discussion of the ideas that are represented/used in PReServ. It is a must read in order to effectively use and work with PReServ. This API documentation assumes you have read the architecture document.

We also note that this is alpha software. We are still working on making our documentation better. If you have any suggestions don't hesitate to contact us (pg03r@ecs.soton.ac.uk).

Audience
This API is designed with two audiences in mind.

  1. Developers using the PReServ provenance service.
  2. Developers trying to modify, extend, or improve PReServ itself.
For those developers in audience 1, the packages marked (External) will be of most interest to you. Probably, the best staring point for you is to look at org.pasoa.util.ClientLib, which provides a Java API for programatically working with a provenance store. Likewise, org.pasoa.test.examples.ClientLibExample should show you how to use ClientLib.

You will probably find those packages marked (External) to be better documented than those marked (Internal).

If you're in audience 2 then I suggest you contact us (pg03r@ecs.soton.ac.uk) so we can point you in the right direction. We have endeavoured to make PReServ easy to extend and add to by using quite a bit of abstraction but given that this is still alpha software you might need some pointers ;-)

This software is released under an open source license. Please see the distribution's readme for the exact contents or type "ant license".