nesstar.api
Class Explorer

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

public class Explorer
extends RDFObject

A rapresentation of the Explorer, used by the Nesstar Explorer

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
Explorer(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 DisplayFactsheet(String factsheet)
           A method to access Factsheet
 void DisplayFactsheet(String factsheet, BasicExecutorLog log)
           A method to access Factsheet
 Bookmark DisplayTable(String table)
           A method to access Tables
 void DisplayTable(String table, BasicExecutorLog log)
           A method to access Tables
 Bookmark Explore(String analysisData, String dataset, String selectData, String weightData)
           
 void Explore(String analysisData, String dataset, String selectData, String weightData, BasicExecutorLog log)
           
 Bookmark ExploreCube(Cube cube, String query)
           
 void ExploreCube(Cube cube, String query, BasicExecutorLog log)
           
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()
           
static Explorer getInstance(RDFDB db, URL id)
          If an object of type Explorer with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Explorer getInstance(String rdf)
           
static Collection getPartsDescriptor()
           
 void initialised()
          Notify that the object has been created and its properties setup for the first time.
 Bookmark Learn(String operation)
           
 void Learn(String operation, BasicExecutorLog log)
           
static void listenForNewObj(NewObjListener listener)
          Register to be notified when new objects are added.
static Explorer newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
static Explorer retrieve(URL id)
          If an object of type Explorer with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 Bookmark Search(String catalogs, String query, String searchData, String searchType)
           
 void Search(String catalogs, String query, String searchData, String searchType, BasicExecutorLog log)
           
 Bookmark Trend(Collection bookmarks, String name, String label, Collection codes, Collection labels, Collection categoryLabels, Integer variableType)
           
 void Trend(Collection bookmarks, String name, String label, Collection codes, Collection labels, Collection categoryLabels, Integer variableType, BasicExecutorLog log)
           
 
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

Explorer

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

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

Learn

public Bookmark Learn(String operation)
               throws Exception
Parameters:
operation -
Throws:
Exception

Learn

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

Explore

public Bookmark Explore(String analysisData,
                        String dataset,
                        String selectData,
                        String weightData)
                 throws Exception
Parameters:
analysisData -
dataset -
selectData -
weightData -
Throws:
Exception

Explore

public void Explore(String analysisData,
                    String dataset,
                    String selectData,
                    String weightData,
                    BasicExecutorLog log)
             throws Exception
Parameters:
analysisData -
dataset -
selectData -
weightData -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Search

public Bookmark Search(String catalogs,
                       String query,
                       String searchData,
                       String searchType)
                throws Exception
Parameters:
catalogs -
query -
searchData -
searchType -
Throws:
Exception

Search

public void Search(String catalogs,
                   String query,
                   String searchData,
                   String searchType,
                   BasicExecutorLog log)
            throws Exception
Parameters:
catalogs -
query -
searchData -
searchType -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Trend

public Bookmark Trend(Collection bookmarks,
                      String name,
                      String label,
                      Collection codes,
                      Collection labels,
                      Collection categoryLabels,
                      Integer variableType)
               throws Exception
Parameters:
bookmarks - An array of analysis bookmarks which will result in hingeable N-ary tables
name - The name of the variable to be constructed
label - The label of the variable to be constructed
codes - The category codes of the variable to be constructed. Must be equal in length to <code>bookmarks</code>
labels - The category labels of the variable to be constructed. Must be equal in length to <code>bookmarks</code>
categoryLabels - A vector of labels for the categories.
variableType -
Throws:
Exception

Trend

public void Trend(Collection bookmarks,
                  String name,
                  String label,
                  Collection codes,
                  Collection labels,
                  Collection categoryLabels,
                  Integer variableType,
                  BasicExecutorLog log)
           throws Exception
Parameters:
bookmarks - An array of analysis bookmarks which will result in hingeable N-ary tables
name - The name of the variable to be constructed
label - The label of the variable to be constructed
codes - The category codes of the variable to be constructed. Must be equal in length to <code>bookmarks</code>
labels - The category labels of the variable to be constructed. Must be equal in length to <code>bookmarks</code>
categoryLabels - A vector of labels for the categories.
variableType -
log - the Executor of this method;if null a default one is used
Throws:
Exception

ExploreCube

public Bookmark ExploreCube(Cube cube,
                            String query)
                     throws Exception
Parameters:
cube -
query -
Throws:
Exception

ExploreCube

public void ExploreCube(Cube cube,
                        String query,
                        BasicExecutorLog log)
                 throws Exception
Parameters:
cube -
query -
log - the Executor of this method;if null a default one is used
Throws:
Exception

DisplayFactsheet

public Bookmark DisplayFactsheet(String factsheet)
                          throws Exception

A method to access Factsheet

Parameters:
factsheet -
Throws:
Exception
Bug:
it is a method only for Dais

DisplayFactsheet

public void DisplayFactsheet(String factsheet,
                             BasicExecutorLog log)
                      throws Exception

A method to access Factsheet

Parameters:
factsheet -
log - the Executor of this method;if null a default one is used
Throws:
Exception
Bug:
it is a method only for Dais

DisplayTable

public Bookmark DisplayTable(String table)
                      throws Exception

A method to access Tables

Parameters:
table -
Throws:
Exception
Bug:
it is a method only for Dais

DisplayTable

public void DisplayTable(String table,
                         BasicExecutorLog log)
                  throws Exception

A method to access Tables

Parameters:
table -
log - the Executor of this method;if null a default one is used
Throws:
Exception
Bug:
it is a method only for Dais

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved