nesstar.api.faster
Class Study3Home

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.DatasetHome
              extended by nesstar.api.faster.StudyHome
                  extended by nesstar.api.faster.Study2Home
                      extended by nesstar.api.faster.Study3Home
All Implemented Interfaces:
Comparable, RDFObj

public class Study3Home
extends Study2Home

An API class for the Study3Home 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
Study3Home(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 Bookmark EJBQuery(String query)
           
 List EJBQuery(String where, BasicExecutorLog log)
           
 Bookmark findAll()
           
 List findAll(BasicExecutorLog log)
           
 Bookmark findByKey(String id)
           
 Dataset findByKey(String id, BasicExecutorLog log)
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
static DatasetHome getInstance(RDFDB db, URL id)
          If an object of type nesstar.api.DatasetHome with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static DatasetHome getInstance(String rdf)
           
 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.
 Bookmark publishStudy(File ddiFull, File ddiSkeleton, File variableIndex)
           Publish a study xml file including it's ddi skeleton file in xml format and associated variable index file.
 Study3 publishStudy(File ddiFull, File ddiSkeleton, File variableIndex, BasicExecutorLog log)
           Publish a study xml file including it's ddi skeleton file in xml format and associated variable index file.
static DatasetHome retrieve(URL id)
          If an object of type Study3Home with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 
Methods inherited from class nesstar.api.faster.StudyHome
addStudy, addStudy, create, create
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, clear, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDescriptor, getDomain, getGetterMethods, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, 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

Study3Home

public Study3Home(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

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 DatasetHome getInstance(RDFDB db,
                                      URL id)
                               throws Exception
If an object of type nesstar.api.DatasetHome 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 DatasetHome 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

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 Study2Home

retrieve

public static DatasetHome retrieve(URL id)
                            throws Exception
If an object of type Study3Home 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 Study3Home with the indicated id
Throws:
Exception

EJBQuery

public Bookmark EJBQuery(String query)
                  throws Exception
Overrides:
EJBQuery in class Study2Home
Parameters:
query - An EJB-QL query that returns objects of the type created by this Home.
Throws:
Exception

EJBQuery

public List EJBQuery(String where,
                     BasicExecutorLog log)
              throws Exception
Overrides:
EJBQuery in class Study2Home
Parameters:
log - the Executor of this method;if null a default one is used
where -
Throws:
Exception

findByKey

public Bookmark findByKey(String id)
                   throws Exception
Overrides:
findByKey in class Study2Home
Parameters:
id - the id of the object to be found
Throws:
Exception

findByKey

public Dataset findByKey(String id,
                         BasicExecutorLog log)
                  throws Exception
Overrides:
findByKey in class Study2Home
Parameters:
id - the id of the object to be found
log - the Executor of this method;if null a default one is used
Throws:
Exception

findAll

public Bookmark findAll()
                 throws Exception
Overrides:
findAll in class Study2Home
Returns:
a list of all the object of this type
Throws:
Exception

findAll

public List findAll(BasicExecutorLog log)
             throws Exception
Overrides:
findAll in class Study2Home
Parameters:
log - the Executor of this method;if null a default one is used
Returns:
a list of all the object of this type
Throws:
Exception

publishStudy

public Bookmark publishStudy(File ddiFull,
                             File ddiSkeleton,
                             File variableIndex)
                      throws Exception

Publish a study xml file including it's ddi skeleton file in xml format and associated variable index file.

Parameters:
ddiFull - the full ddi file in xml format

ddiSkeleton - the ddi skeleton file in xml format (the ddi xml file without categories)

variableIndex - the variable system index file (an index of variable start positions in the full ddi xml file)

Throws:
Exception

publishStudy

public Study3 publishStudy(File ddiFull,
                           File ddiSkeleton,
                           File variableIndex,
                           BasicExecutorLog log)
                    throws Exception

Publish a study xml file including it's ddi skeleton file in xml format and associated variable index file.

Parameters:
ddiFull - the full ddi file in xml format

ddiSkeleton - the ddi skeleton file in xml format (the ddi xml file without categories)

variableIndex - the variable system index file (an index of variable start positions in the full ddi xml file)

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

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved