nesstar.api.common
Class Organisation

java.lang.Object
  java.util.Observable
      nesstar.rdf.RDFObject
          nesstar.api.common.Resource
              nesstar.api.common.Organisation

All Implemented Interfaces:

Comparable, RDFObj

public class Organisation
extends Resource

Field Summary

static String

CLASS_ID

Fields inherited from class nesstar.rdf.RDFObject

COLSEP, IS_GETTER, IS_PART, IS_PART_OF, WRITE_OP

Constructor Summary

Organisation(RDFDB db, URL id)
Create an object with the indicated id in the indicated db

Method Summary

void	clear() Clear all properties of this object
String	get_affiliation()
RDFRef	get_study()
String	get_uri()
String	getAffiliation()
static Vector	getAllInstances()
static Vector	getAllInstances(RDFDB db)
String	getComment() Returns a human readable comment/description of the object as an HTML string (it should contain only basic HTML markers).
static FeatureDescriptor	getDescriptor(String featureName) get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented
static Collection	getGetterMethods()
static Resource	getInstance(RDFDB db, URL id) If an object of type Organisation with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Resource	getInstance(String rdf)
static Collection	getPartsDescriptor()
Study2	getStudy()
String	getUri()
void	initialised() Notify that the object has been created and its properties setup for the first time.
static void	listenForNewObj(NewObjListener listener) Register to be notified when new objects are added.
static Resource	newInstance(RDFDB db) Create a new object of this type with a locally unique id and returns it
static Resource	retrieve(URL id) If an object of type Organisation with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
void	set_affiliation(String affiliation)
void	set_study(RDFRef study)
void	set_uri(String uri)
void	setAffiliation(String affiliation)
void	setStudy(Study2 study)
void	setUri(String uri)

Methods inherited from class nesstar.rdf.RDFObject

AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, set, setComment, setComplete, setCreationDate, setDB, setHardOrSoft, setID, setLabel, setLastClear, SetProperty, setServer, SetStringProperty, setTimeoutInSecs, setTimestamp, setType, setTypeID, stale, toRDF, toRDFWrapped, toString, update

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_ID

public static String CLASS_ID

Constructor Detail

Organisation

public Organisation(RDFDB db,
                    URL id)
             throws Exception

Create an object with the indicated id in the indicated db

Parameters:

db - the db where the object is to be created

id - the id of the object to create

Throws:

Exception

Method Detail

set_study

public void set_study(RDFRef study)

Parameters:

study -

setStudy

public void setStudy(Study2 study)
              throws Exception

Parameters:

study -

Throws:

Exception

setUri

public void setUri(String uri)

Parameters:

uri -

This property stores the contents of the DDI field:

<codeBook><stdyDscr><citation><distStmt><distrbtr URI>

set_uri

public void set_uri(String uri)

Parameters:

uri -

setAffiliation

public void setAffiliation(String affiliation)

Parameters:

affiliation -

This property stores the contents of the DDI field:

<codeBook><stdyDscr><citation><distStmt><distrbtr affiliation>

set_affiliation

public void set_affiliation(String affiliation)

Parameters:

affiliation -

getAllInstances

public static Vector getAllInstances(RDFDB db)
                              throws Exception

Parameters:

db - the db where the instances are to be found

Returns:

all the instances of this class in the database

Throws:

Exception

getAllInstances

public static Vector getAllInstances()
                              throws Exception

Returns:

get all the instances of this class from the default database

Throws:

Exception

getInstance

public static Resource getInstance(RDFDB db,
                                   URL id)
                            throws Exception

If an object of type Organisation with the indicated id exists in the db returns it otherwise create a new object in the db and returns it

Parameters:

db - the db where the object is to be found or created

id - the id of the object to retrieve or create

Returns:

an object of type Server with the indicated id and existing in the indicated db

Throws:

Exception

getInstance

public static Resource getInstance(String rdf)
                            throws Exception

Parameters:

rdf - some rdf code that contains a description of an object of this kind

Returns:

the single instance of this class described in the passed RDF code

Throws:

Exception

get_study

public RDFRef get_study()
                 throws Exception

Throws:

Exception

getStudy

public Study2 getStudy()

Returns:

getComment

public String getComment()

Description copied from class: RDFObject

Returns a human readable comment/description of the object as an HTML string (it should contain only basic HTML markers).

Overrides:

getComment in class RDFObject

Returns:

the comment

This property stores the contents of the DDI field:

<codeBook><stdyDscr><citation><distStmt><distrbtr>

getUri

public String getUri()

This property stores the contents of the DDI field:

<codeBook><stdyDscr><citation><distStmt><distrbtr URI>

get_uri

public String get_uri()
               throws Exception

Throws:

Exception

getAffiliation

public String getAffiliation()

This property stores the contents of the DDI field:

<codeBook><stdyDscr><citation><distStmt><distrbtr affiliation>

get_affiliation

public String get_affiliation()
                       throws Exception

Throws:

Exception

getDescriptor

public static FeatureDescriptor getDescriptor(String featureName)

get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented

Parameters:

featureName -

getPartsDescriptor

public static Collection getPartsDescriptor()

Returns:

the descriptor of the attribute that are part of the class

getGetterMethods

public static Collection getGetterMethods()

Returns:

the descriptor of the attribute that are part of the class

newInstance

public static Resource newInstance(RDFDB db)
                            throws Exception

Create a new object of this type with a locally unique id and returns it

Parameters:

db - the db where the object is to be found or created

Returns:

an object of this type

Throws:

Exception

listenForNewObj

public static void listenForNewObj(NewObjListener listener)

Register to be notified when new objects are added.

Parameters:

listener - the listener

initialised

public void initialised()

Notify that the object has been created and its properties setup for the first time. This is NOT called when the object is simply reloaded.

Overrides:

initialised in class Resource

retrieve

public static Resource retrieve(URL id)
                         throws Exception

If an object of type Organisation with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)

Parameters:

id - the id of the object to retrieve

Returns:

an object of type Organisation with the indicated id

Throws:

Exception

clear

public void clear()

Description copied from class: RDFObject

Clear all properties of this object

Overrides:

clear in class Resource