org.purl.xnode
Interface XNodeID

All Known Subinterfaces:

XNodeLink

public interface XNodeID

XNodeID provides an interface for a common, convenient identifier for XNodes, combining an immutable Collection ID (cid) and Node ID (nid) and a method for obtaining the database URL reference. XNodeID objects should generally be created by a factory so that they are themselves unique within a JVM.

The XNode API (the package org.purl.xnode.*, both its source code and documentation), are released under the Apache 2.0 License. For more details, check the LICENSE file contained with the distribution, or see The Ceryle Project for more information. It is distributed with no warranty.

Since:

XNode 1.2

Version:

$Id: XNodeID.java,v 3.5 2007-06-20 01:28:43 altheim Exp $

Author:

Murray Altheim

Method Summary

String	cid() Returns the Collection ID String.
String	nid() Returns the Node ID String.
String	toPathNameFragment() Returns a path name representation of this XNodeID (as a String), for use in path name composition, such as in zip files or XNode serializations existing on file systems.
String	toString() Returns a String representation of this XNodeID.
String	toURI() Returns a URI representation of this XNodeLink based on the root database URI, eg., ""xnode://db/cid/nid".

Method Detail

cid

String cid()

Returns the Collection ID String.

nid

String nid()

Returns the Node ID String.

toPathNameFragment

String toPathNameFragment()

Returns a path name representation of this XNodeID (as a String), for use in path name composition, such as in zip files or XNode serializations existing on file systems. This will consist of the collection ID, a "/" character followed by the Node ID (eg., "cid/nid").

toURI

String toURI()

Returns a URI representation of this XNodeLink based on the root database URI, eg., ""xnode://db/cid/nid".

Returns:

a URI (as a String).

toString

String toString()

Returns a String representation of this XNodeID.

Overrides:

toString in class Object