RIF-CS API

RIF-CS Java API 2.0.0

See: Description

Packages 
Package Description
org.ands.rifcs.base
The base package of the RIF-CS API.
org.ands.rifcs.ch
The content handler package of the RIF-CS API.
org.ands.rifcs.example
Examples that use the RIF-CS API.

RIF-CS Java API 2.0.0

The RIF-CS API is an API developed by the Australian National Data Service (ANDS) to aid developers in the processing and assembly of RIF-CS Documents. It is currently in the early stages of development and enables developers to access the structures of an existing RIF-CS document for simpler processing. The model supported is a RIF-CS DOM and most RIF-CS elements are provided their own classes which essentially encapsulate commonly used w3c DOM API methods to provide convenience classes and methods for obtaining element content and attributes. This enables developers to think about a RIF-CS Document as a collection of objects rather than having to carry out repetitive XML API calls in a RIF-CS document context.

It is intended for this API to grow as further RIF-CS development is undertaken at The Australian National University (ANU).

Refer to the RIF-CS documentation for schema, guidelines and vocabularies which must be used in conjunction with this API.

Change History
  • 2.0.0
    • Updated for RIF-CS v1.5. (There was not a separate release of this API to support RIF-CS 1.4.)
    • The source code has been extensively reformatted. See the checks directory for configuration files to use with Checkstyle, PMD, and FindBugs. (The code passes the Checkstyle checks, but not all the PMD or FindBugs checks.)
    • Existing classes in org.ands.rifcs.example have been renamed. For example, SampleRIFCSBuildActivity became SampleRIFCSBuildActivityV1Dot3Number1 to indicate that it is a test of RIF-CS v1.3.
    • Incompatible changes:
      • The classes Right and ExistenceDate have been renamed as Rights and ExistenceDates, so that they now match the corresponding RIF-CS element names. The methods newRight() and addRight() have been renamed to newRights() and addRights().
      • The Collection class now supports existenceDates element.
      • The class TemporalCoverageDate has been renamed as DateWithTypeDataFormat. It is now also used in the contruction of Dates objects.
      • The previously deprecated method Collection.addRelatedInfo(String) has now been removed.
    • Defects fixed:
      • The Collection class did not support existenceDates elements. It now does.
      • The rights and existenceDates elements were not parsed when reading existing RIF-CS data. They now are.
      • Parsing of RIF-CS documents created by this API (e.g., running SampleRIFCSRead on the output of SampleRIFCSBuildCollectionV1Dot3Number1) often failed. This has now been fixed.
      • Parsing existing RIF-CS documents and then writing them out added duplicate namespace declarations. This has been fixed.
  • 1.3.0
    • Updated for RIF-CS 1.3.
  • 1.2.0
    • Added methods to support reading of existing RIF-CS documents
    • Minor Javadocs updates
  • 1.1.0
    • Fixed bug preventing creation of party and service
    • Workaround for Xerces bug where schema fragments in the same namespace cannot be used to generate a Schema object
    • Added methods to location to support type attribute
    • Minor changes to support Java 1.6 XML namespace processing
    • Revised Javadocs and removed out of date URLs
  • 1.0.0
    • Initial release

Note: A release is numbered as major.minor.patch where major=API change; minor=bug fix or method(s) marked as deprecated; patch=minor code or documentation fixes.