org.kepler.objectmanager.lsid

Class KeplerLSID

java.lang.Object

org.kepler.objectmanager.lsid.KeplerLSID

All Implemented Interfaces:

java.io.Serializable

public class KeplerLSID
extends java.lang.Object
implements java.io.Serializable

A kepler class to store lsids of the form urn:lsid:<authority>:<namespace>:<object>:<revision>#<anchor> where <authority> and <namespace> are strings that do not contain : characters and where <object> and <revision> are Long, 64 bit integers, and <anchor> is any string that does not contain a # or : character.

See Also:

Serialized Form

Created:

June 20, 2005

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTOR_METADATA
static java.lang.String	anchorSeparator
static char	anchorSeparatorChar
static java.lang.String	DATA
static java.lang.String	JAR
static java.lang.String	JAVA_CLASS
static java.lang.String	NATIVE_LIBRARY
static java.lang.String	RESOURCE_FILE
static java.lang.String	separator
static char	separatorChar
static java.lang.String	WORKFLOW
static java.lang.String	XML_METADATA

Constructor Summary

Constructors

Constructor and Description
KeplerLSID(java.lang.String lsidString) Construct an lsid.
KeplerLSID(java.lang.String metacatDocid, java.lang.String authority) creates an lsid from a metacat docid of the form .
KeplerLSID(java.lang.String authority, java.lang.String namespace, java.lang.Long object, java.lang.Long revision) construct an lsid from components

Method Summary

Modifier and Type	Method and Description
java.lang.String	createFilename() this will create a valid filename out of the lsid (without an extension).
boolean	equals(java.lang.Object lsidObj) return true if this lsid equals the passed in lsid regardless of anchor
boolean	equalsWithAnchor(KeplerLSID lsid) return true if this lsid equals the passed in lsid and the anchors are the same.
boolean	equalsWithoutRevision(KeplerLSID lsid) return true if this lsid equals the passed in lsid regardless of revision or anchor
java.lang.String	getAnchor()
java.lang.String	getAuthority() returns the authority component of this lsid
java.lang.String	getNamespace() returns the namespace component of this lsid
java.lang.Long	getObject() returns the object component of this lsid
java.lang.Long	getRevision() return the revision componenent of this lsid
boolean	hasAnchor()
int	hashCode()
void	incrementRevision() increment the revision number by 1.
static boolean	isKeplerLSIDFormat(java.lang.String lsidStr)
boolean	isLocalToInstance() If this LSID was generated by this Kepler Instance return true else return false
void	setAnchor(java.lang.String anchor)
void	setRevision(java.lang.Long newRevision) Specifically set the revision on this LSID.
java.lang.String	toString() return a string representation of the lsid
java.lang.String	toStringWithoutRevision() Return a string that contains only the first five elements of the LSID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

separatorChar

public static final char separatorChar

See Also:

Constant Field Values

separator

public static final java.lang.String separator

See Also:

Constant Field Values

anchorSeparatorChar

public static final char anchorSeparatorChar

See Also:

Constant Field Values

anchorSeparator

public static final java.lang.String anchorSeparator

See Also:

Constant Field Values

ACTOR_METADATA

public static final java.lang.String ACTOR_METADATA

See Also:

Constant Field Values

JAR

public static final java.lang.String JAR

See Also:

Constant Field Values

JAVA_CLASS

public static final java.lang.String JAVA_CLASS

See Also:

Constant Field Values

WORKFLOW

public static final java.lang.String WORKFLOW

See Also:

Constant Field Values

NATIVE_LIBRARY

public static final java.lang.String NATIVE_LIBRARY

See Also:

Constant Field Values

XML_METADATA

public static final java.lang.String XML_METADATA

See Also:

Constant Field Values

DATA

public static final java.lang.String DATA

See Also:

Constant Field Values

RESOURCE_FILE

public static final java.lang.String RESOURCE_FILE

See Also:

Constant Field Values

Constructor Detail

KeplerLSID

public KeplerLSID(java.lang.String lsidString)
           throws java.lang.Exception

Construct an lsid.

Throws:

java.lang.Exception

KeplerLSID

public KeplerLSID(java.lang.String authority,
                  java.lang.String namespace,
                  java.lang.Long object,
                  java.lang.Long revision)
           throws java.lang.Exception

construct an lsid from components

Parameters:

authority - the authority of the new lsid

namespace - the namespace of the new lsid

the - object number of the new lsid

revision - the revision of the new lsid

Throws:

java.lang.Exception

KeplerLSID

public KeplerLSID(java.lang.String metacatDocid,
                  java.lang.String authority)
           throws java.lang.Exception

creates an lsid from a metacat docid of the form .