Package edu.ucsb.nceas.metacat

Class DocumentIdentifier

java.lang.Object

edu.ucsb.nceas.metacat.DocumentIdentifier

public class DocumentIdentifier
extends Object

A class to parse document ids The docid is of the form siteCode.uniqueId.rev

Constructor Summary

Constructors

Constructor	Description
DocumentIdentifier(String docid)	Constructor to build a docid object and parse an incoming string.

Method Summary

Modifier and Type	Method	Description
String	getIdentifier()	returns
String	getRev()	returns the revision number encoded in this docid
String	getSeparator()	returns the separator used in the accession number
String	getSiteCode()	returns the siteCode encoded in this docid
String	getUniqueId()	returns the uniqueId encoded in this docid
static void	main(String[] args)	Test driver.
String	toString()	returns the whole docid as a string

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DocumentIdentifier

public DocumentIdentifier(String docid)
                   throws AccessionNumberException

Constructor to build a docid object and parse an incoming string.

Throws:

AccessionNumberException

Method Details

getRev

public String getRev()

returns the revision number encoded in this docid

getUniqueId

public String getUniqueId()

returns the uniqueId encoded in this docid

getSiteCode

public String getSiteCode()

returns the siteCode encoded in this docid

getSeparator

public String getSeparator()

returns the separator used in the accession number

getIdentifier

public String getIdentifier()

returns

toString

public String toString()

returns the whole docid as a string

Overrides:

toString in class Object

main

public static void main(String[] args)

Test driver. The first command line argument is the docid you want to create an object for. For instance ">java DocumentIdentifer nceas.1.2" will return "rev: 2 \n uniqueId: 1 \n siteCode: nceas \n"