nesstar.api.hc
Class Factsheet

java.lang.Object
  java.util.Observable
      nesstar.rdf.RDFObject
          nesstar.api.hc.Factsheet

All Implemented Interfaces:

Comparable, RDFObj

public class Factsheet
extends RDFObject

Code automatically generated from ARGO/UML

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

Factsheet(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
Bookmark	Delete()
void	Delete(BasicExecutorLog log)
String	get_access()
String	get_accessibility()
String	get_author()
String	get_file()
String	get_groupName()
String	get_notes()
String	get_numberRange()
String	get_pages()
String	get_source()
RDFRef	get_study()
RDFRef	get_tables()
String	get_title()
String	get_url()
RDFRef	get_variables()
String	getAccess() Deprecated. replaced by accessibility
String	getAccessibility()
static Vector	getAllInstances()
static Vector	getAllInstances(RDFDB db)
String	getAuthor()
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
String	getFile() Deprecated. replcaed by url
Bookmark	GetFolders()
List	GetFolders(BasicExecutorLog log)
static Collection	getGetterMethods()
String	getGroupName()
static Factsheet	getInstance(RDFDB db, URL id) If an object of type Factsheet with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Factsheet	getInstance(String rdf)
String	getNotes()
String	getNumberRange()
String	getPages()
static Collection	getPartsDescriptor()
String	getSource()
Study	getStudy()
List	getTables()
String	getTitle()
String	getUrl()
List	getVariables()
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 Factsheet	newInstance(RDFDB db) Create a new object of this type with a locally unique id and returns it
static Factsheet	retrieve(URL id) If an object of type Factsheet 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_access(String access)
void	set_accessibility(String accessibility)
void	set_author(String author)
void	set_file(String file)
void	set_groupName(String groupName)
void	set_notes(String notes)
void	set_numberRange(String numberRange)
void	set_pages(String pages)
void	set_source(String source)
void	set_study(RDFRef study)
void	set_tables(RDFRef tables)
void	set_title(String title)
void	set_url(String url)
void	set_variables(RDFRef variables)
void	setAccess(String access) Deprecated. replaced by accessibility
void	setAccessibility(String accessibility)
void	setAuthor(String author)
void	setFile(String file) Deprecated. replcaed by url
void	setGroupName(String groupName)
void	setNotes(String notes)
void	setNumberRange(String numberRange)
void	setPages(String pages)
void	setSource(String source)
void	setStudy(Study study)
void	setTables(List tables)
void	setTitle(String title)
void	setUrl(String url)
void	setVariables(List variables)

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, getComment, 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

Factsheet

public Factsheet(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(Study study)
              throws Exception

Parameters:

study -

Throws:

Exception

set_variables

public void set_variables(RDFRef variables)

Parameters:

variables -

setVariables

public void setVariables(List variables)
                  throws Exception

Parameters:

variables -

Throws:

Exception

set_tables

public void set_tables(RDFRef tables)

Parameters:

tables -

setTables

public void setTables(List tables)
               throws Exception

Parameters:

tables -

Throws:

Exception

setAccess

public void setAccess(String access)

Deprecated. replaced by accessibility

Parameters:

access -

set_access

public void set_access(String access)

Parameters:

access -

setAuthor

public void setAuthor(String author)

Parameters:

author -

set_author

public void set_author(String author)

Parameters:

author -

setTitle

public void setTitle(String title)

Parameters:

title -

set_title

public void set_title(String title)

Parameters:

title -

setNumberRange

public void setNumberRange(String numberRange)

Parameters:

numberRange -

set_numberRange

public void set_numberRange(String numberRange)

Parameters:

numberRange -

setUrl

public void setUrl(String url)

Parameters:

url -

This property replaces:

file

set_url

public void set_url(String url)

Parameters:

url -

setNotes

public void setNotes(String notes)

Parameters:

notes -

set_notes

public void set_notes(String notes)

Parameters:

notes -

setPages

public void setPages(String pages)

Parameters:

pages -

set_pages

public void set_pages(String pages)

Parameters:

pages -

setSource

public void setSource(String source)

Parameters:

source -

set_source

public void set_source(String source)

Parameters:

source -

setGroupName

public void setGroupName(String groupName)

Parameters:

groupName -

set_groupName

public void set_groupName(String groupName)

Parameters:

groupName -

setFile

public void setFile(String file)

Deprecated. replcaed by url

Parameters:

file -

set_file

public void set_file(String file)

Parameters:

file -

setAccessibility

public void setAccessibility(String accessibility)

Parameters:

accessibility -

This property replaces:

access

set_accessibility

public void set_accessibility(String accessibility)

Parameters:

accessibility -

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 Factsheet getInstance(RDFDB db,
                                    URL id)
                             throws Exception

If an object of type Factsheet 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 Factsheet 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 Study getStudy()

Returns:

get_variables

public RDFRef get_variables()
                     throws Exception

Throws:

Exception

getVariables

public List getVariables()
                  throws Exception

Returns:

Throws:

Exception

get_tables

public RDFRef get_tables()
                  throws Exception

Throws:

Exception

getTables

public List getTables()
               throws Exception

Returns:

Throws:

Exception

getAccess

public String getAccess()

Deprecated. replaced by accessibility

get_access

public String get_access()
                  throws Exception

Throws:

Exception

getAuthor

public String getAuthor()

get_author

public String get_author()
                  throws Exception

Throws:

Exception

getTitle

public String getTitle()

get_title

public String get_title()
                 throws Exception

Throws:

Exception

getNumberRange

public String getNumberRange()

get_numberRange

public String get_numberRange()
                       throws Exception

Throws:

Exception

getUrl

public String getUrl()

This property replaces:

file

get_url

public String get_url()
               throws Exception

Throws:

Exception

getNotes

public String getNotes()

get_notes

public String get_notes()
                 throws Exception

Throws:

Exception

getPages

public String getPages()

get_pages

public String get_pages()
                 throws Exception

Throws:

Exception

getSource

public String getSource()

get_source

public String get_source()
                  throws Exception

Throws:

Exception

getGroupName

public String getGroupName()

get_groupName

public String get_groupName()
                     throws Exception

Throws:

Exception

getFile

public String getFile()

Deprecated. replcaed by url

get_file

public String get_file()
                throws Exception

Throws:

Exception

getAccessibility

public String getAccessibility()

This property replaces:

access

get_accessibility

public String get_accessibility()
                         throws Exception

Throws:

Exception

GetFolders

public Bookmark GetFolders()
                    throws Exception

Throws:

Exception

GetFolders

public List GetFolders(BasicExecutorLog log)
                throws Exception

Parameters:

log - the Executor of this method;if null a default one is used

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 Factsheet 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 RDFObject

retrieve

public static Factsheet retrieve(URL id)
                          throws Exception

If an object of type Factsheet 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 Factsheet 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 RDFObject

Delete

public Bookmark Delete()
                throws Exception

Throws:

Exception

Delete

public void Delete(BasicExecutorLog log)
            throws Exception

Parameters:

log - the Executor of this method;if null a default one is used

Throws:

Exception