org.ecoinformatics.seek.sms

Class KeplerLocalLSIDService

java.lang.Object

org.ecoinformatics.seek.sms.KeplerLocalLSIDService

public class KeplerLocalLSIDService
extends java.lang.Object

Description of the Class

Author:

berkley

Created:

February 17, 2005

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeplerLocalLSIDService() Constructor for the KeplerLocalLSIDService object

Method Summary

Modifier and Type	Method and Description
java.util.Iterator	assignedLSIDs() Description of the Method
void	assignLSID(java.lang.String lsid, NamedObj obj) Adds a named object to an lsid that hasn't been previously assigned.
void	commitChanges() TODO: throw error
java.lang.String	createLocallyUniqueLSID(java.lang.String namespace) This is a simple algorithm that computes a new id for a given namespace in the default domain.
java.lang.String	createLSID(java.lang.String namespace, java.lang.String id)
EntityTreeModel	getBasicActorLibrary() This operation provides access to the assigned library model.
NamedObj	getData(java.lang.String lsid)
java.util.Iterator	getLSIDFor(NamedObj obj)
static KeplerLocalLSIDService	instance()
boolean	isAssignedLSID(java.lang.String lsid)
boolean	isWellFormedLSID(java.lang.String lsid)
static void	main(java.lang.String[] args) The main program for the KeplerLocalLSIDService class
void	setBasicActorLibrary(EntityTreeModel _libraryModel) Assigns the current kepler actor library.
void	updateLSID(java.lang.String lsid, NamedObj obj) Updates a previously assigned lsid to be assigned the given object.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeplerLocalLSIDService

protected KeplerLocalLSIDService()

Constructor for the KeplerLocalLSIDService object

Method Detail

instance

public static KeplerLocalLSIDService instance()

Returns:

The unique instance of this class This must be called to create/obtain an instance of the service

setBasicActorLibrary

public void setBasicActorLibrary(EntityTreeModel _libraryModel)

Assigns the current kepler actor library. Clears current set of lsid objects. This operation is here because there isn't a great way in Kepler/Ptolemy to access "global" objects. Here, we grab the library model that is initially given to Kepler when the graph editor starts up.

Parameters:

_libraryModel - The current kepler actor library

getBasicActorLibrary

public EntityTreeModel getBasicActorLibrary()

This operation provides access to the assigned library model.

Returns:

The current kepler actor library

assignLSID

public void assignLSID(java.lang.String lsid,
                       NamedObj obj)
                throws IllegalLSIDAssignmentException

Adds a named object to an lsid that hasn't been previously assigned. The lsid cannot be previously assigned to an object. To create a well-formed lsid, use createLSID.

Parameters:

obj - The object to assign an lsid to

lsid - Description of the Parameter

Throws:

IllegalLSIDAssignmentException - Description of the Exception

updateLSID

public void updateLSID(java.lang.String lsid,
                       NamedObj obj)
                throws IllegalLSIDAssignmentException

Updates a previously assigned lsid to be assigned the given object. Removes the old object from the actor library, and adds the given object.

Parameters:

lsid - the lsid to update

obj - the new object to connect to the lsid

Throws:

IllegalLSIDAssignmentException - Description of the Exception

createLSID

public java.lang.String createLSID(java.lang.String namespace,
                                   java.lang.String id)
                            throws IllegalLSIDException

Parameters:

namespace - Description of the Parameter

id - Description of the Parameter

Returns:

an lsid with the default domain and the given namespace and id

Throws:

IllegalLSIDException - Description of the Exception

createLocallyUniqueLSID

public java.lang.String createLocallyUniqueLSID(java.lang.String namespace)

This is a simple algorithm that computes a new id for a given namespace in the default domain. Appends a LOCALID to the id, so shouldn't be duplicated in other ids in the same domain.

Parameters:

namespace - Description of the Parameter

Returns:

a unqiue lsid, relevant to assigned lsids, for the given namespace.

getLSIDFor

public java.util.Iterator getLSIDFor(NamedObj obj)

Parameters:

obj - Description of the Parameter

Returns:

The lSIDFor value

isAssignedLSID

public boolean isAssignedLSID(java.lang.String lsid)

Parameters:

lsid - the lsid to test

Returns:

true if the given lsid is known to the service

isWellFormedLSID

public boolean isWellFormedLSID(java.lang.String lsid)

Parameters:

lsid - the lsid to test

Returns:

true if the lsid is well formed, false otherwise

getData

public NamedObj getData(java.lang.String lsid)

Parameters:

lsid - Description of the Parameter

Returns:

null if not a resolvable lsid (i.e., unknown lsid)

commitChanges

public void commitChanges()

TODO: throw error

assignedLSIDs

public java.util.Iterator assignedLSIDs()

Description of the Method

Returns:

Description of the Return Value

main

public static void main(java.lang.String[] args)

The main program for the KeplerLocalLSIDService class

Parameters:

args - The command line arguments