nesstar.api.common
Class Server

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.Server
              extended by nesstar.api.ServerEx
                  extended by nesstar.api.common.Server
All Implemented Interfaces:
Comparable, RDFObj

public class Server
extends ServerEx

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
Server(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
 RDFRef get_acuCatalog()
           
 RDFRef get_homes()
           
 String get_securePort()
           
 RDFRef get_statEngine()
           
 Catalog getAcuCatalog()
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
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()
           
 Bookmark GetHome(URL classURL)
           
 RDFObject GetHome(URL classURL, BasicExecutorLog log)
           
 List getHomes()
           
static Server getInstance(RDFDB db, URL id)
          If an object of type Server with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Server getInstance(String rdf)
           
 Bookmark GetOrphans(String classURL)
           Return all the orphans of the indicated class present in the server.
 List GetOrphans(String classURL, BasicExecutorLog log)
           Return all the orphans of the indicated class present in the server.
static Collection getPartsDescriptor()
           
 Integer getSecurePort()
           
 NSDStatEngine getStatEngine()
           
 Bookmark Import(File file)
           
 void Import(File file, BasicExecutorLog log)
           
 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 Server newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
 Bookmark PathsTo(RDFObject to)
           Return a list of paths that lead from the server to the 'to' object.
 String PathsTo(RDFObject to, BasicExecutorLog log)
           Return a list of paths that lead from the server to the 'to' object.
static Server retrieve(URL id)
          If an object of type Server 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_acuCatalog(RDFRef acuCatalog)
           
 void set_homes(RDFRef homes)
           
 void set_securePort(String securePort)
           
 void set_statEngine(RDFRef statEngine)
           
 void setAcuCatalog(Catalog acuCatalog)
           
 void setHomes(List homes)
           
 void setSecurePort(Integer securePort)
           
 void setStatEngine(NSDStatEngine statEngine)
           
 Bookmark XSLTransform(String file, String MIMEType, String parameters, String xslFile)
           Does ...
 String XSLTransform(String file, String MIMEType, String parameters, String xslFile, BasicExecutorLog log)
           Does ...
 
Methods inherited from class nesstar.api.ServerEx
dbg, getAllCatalogs, getAllCatalogs, getAllServersAndCatalogs, oldGetCatalogs, reloadCatalogs
 
Methods inherited from class nesstar.api.Server
get_catalogs, get_debug, get_port, get_revision, get_services, get_version, getCatalogs, getDebug, GetFile, GetFile, getPort, GetReport, GetReport, getRevision, getServices, getVersion, Login, Login, Reboot, Reboot, SaveFile, SaveFile, SaveWebFile, SaveWebFile, set_catalogs, set_debug, set_port, set_revision, set_services, set_version, setCatalogs, setDebug, setPort, setRevision, setServices, setVersion, Shutdown, Shutdown, Update, Update
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, 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

Server

public Server(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_statEngine

public void set_statEngine(RDFRef statEngine)
Parameters:
statEngine -

setStatEngine

public void setStatEngine(NSDStatEngine statEngine)
                   throws Exception
Parameters:
statEngine -
Throws:
Exception

set_acuCatalog

public void set_acuCatalog(RDFRef acuCatalog)
Parameters:
acuCatalog -

setAcuCatalog

public void setAcuCatalog(Catalog acuCatalog)
                   throws Exception
Parameters:
acuCatalog -
Throws:
Exception

setHomes

public void setHomes(List homes)
              throws Exception
Parameters:
homes -
Throws:
Exception

set_homes

public void set_homes(RDFRef homes)
Parameters:
homes -

setSecurePort

public void setSecurePort(Integer securePort)
Parameters:
securePort -

set_securePort

public void set_securePort(String securePort)
Parameters:
securePort -

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 Server getInstance(RDFDB db,
                                 URL id)
                          throws Exception
If an object of type Server 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 Server 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_statEngine

public RDFRef get_statEngine()
                      throws Exception
Throws:
Exception

getStatEngine

public NSDStatEngine getStatEngine()
Returns:

get_acuCatalog

public RDFRef get_acuCatalog()
                      throws Exception
Throws:
Exception

getAcuCatalog

public Catalog getAcuCatalog()
Returns:

getHomes

public List getHomes()
              throws Exception
Throws:
Exception

get_homes

public RDFRef get_homes()
                 throws Exception
Throws:
Exception

getSecurePort

public Integer getSecurePort()

get_securePort

public String get_securePort()
                      throws Exception
Throws:
Exception

GetHome

public Bookmark GetHome(URL classURL)
                 throws Exception
Parameters:
classURL -
Throws:
Exception

GetHome

public RDFObject GetHome(URL classURL,
                         BasicExecutorLog log)
                  throws Exception
Parameters:
classURL -
log - the Executor of this method;if null a default one is used
Throws:
Exception

GetOrphans

public Bookmark GetOrphans(String classURL)
                    throws Exception

Return all the orphans of the indicated class present in the server. An orphan is an object that has not parents (e.g. Catalogs that are not children of the Server or of another Catalog or Studies that are not children of a Catalog).

Parameters:
classURL - the full URL of the class of the orphan objects
Returns:
a Collection of objects
Throws:
Exception

GetOrphans

public List GetOrphans(String classURL,
                       BasicExecutorLog log)
                throws Exception

Return all the orphans of the indicated class present in the server. An orphan is an object that has not parents (e.g. Catalogs that are not children of the Server or of another Catalog or Studies that are not children of a Catalog).

Parameters:
classURL - the full URL of the class of the orphan objects
log - the Executor of this method;if null a default one is used
Returns:
a Collection of objects
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 Server 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 Server

retrieve

public static Server retrieve(URL id)
                       throws Exception
If an object of type Server 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 Server 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 Server

Import

public Bookmark Import(File file)
                throws Exception
Parameters:
file -
Throws:
Exception

Import

public void Import(File file,
                   BasicExecutorLog log)
            throws Exception
Parameters:
file -
log - the Executor of this method;if null a default one is used
Throws:
Exception

XSLTransform

public Bookmark XSLTransform(String file,
                             String MIMEType,
                             String parameters,
                             String xslFile)
                      throws Exception

Does ...

Parameters:
file - URL of the file to be transformed (can be absolute or relative)

parameters - the parameters used by the xsl file, if any

xslFile - the xsl file describing the transformation

MIMEType -
Returns:
the file transformed according with the xsl transformations defined

Throws:
Exception

XSLTransform

public String XSLTransform(String file,
                           String MIMEType,
                           String parameters,
                           String xslFile,
                           BasicExecutorLog log)
                    throws Exception

Does ...

Parameters:
file - URL of the file to be transformed (can be absolute or relative)

parameters - the parameters used by the xsl file, if any

xslFile - the xsl file describing the transformation

MIMEType -
log - the Executor of this method;if null a default one is used
Returns:
the file transformed according with the xsl transformations defined

Throws:
Exception

PathsTo

public Bookmark PathsTo(RDFObject to)
                 throws Exception

Return a list of paths that lead from the server to the 'to' object. A path is a sequence of property traversals. For example catalogs[1].children[2].children[3] is a path that leads from the root down to the first catalog and then to the third child of the second catalog's subcatalog.

Parameters:
to -
Throws:
Exception

PathsTo

public String PathsTo(RDFObject to,
                      BasicExecutorLog log)
               throws Exception

Return a list of paths that lead from the server to the 'to' object. A path is a sequence of property traversals. For example catalogs[1].children[2].children[3] is a path that leads from the root down to the first catalog and then to the third child of the second catalog's subcatalog.

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

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved