nesstar.api.faster
Class Study3

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.Dataset
              extended by nesstar.api.DatasetEx
                  extended by nesstar.api.faster.Study
                      extended by nesstar.api.faster.Study2
                          extended by nesstar.api.faster.Study3
All Implemented Interfaces:
Comparable, RDFObj

public class Study3
extends Study2

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
Study3(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 Correlation(String condition, Collection variables, String missing, String type, Collection weights, String format, String filter)
          Bivariate Correlation Matrix
 String Correlation(String condition, Collection variables, String missing, String type, Collection weights, String format, String filter, BasicExecutorLog log)
          Bivariate Correlation Matrix
 Bookmark CreateDerivedVariable(String name, String label, String comment, String expression)
           Create a new unique derived variable with the specified name, label, comment and expression.
 Variable CreateDerivedVariable(String name, String label, String comment, String expression, BasicExecutorLog log)
           Create a new unique derived variable with the specified name, label, comment and expression.
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 Bookmark GetDerivedVariables()
           Return a (possibly empty) collection of derived variables linked to this study and visible to the current user according to the current access control policy.
 List GetDerivedVariables(BasicExecutorLog log)
           Return a (possibly empty) collection of derived variables linked to this study and visible to the current user according to the current access control policy.
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 Dataset getInstance(RDFDB db, URL id)
          If an object of type Study3 with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Dataset getInstance(String rdf)
           
static Collection getPartsDescriptor()
           
 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 Dataset newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
static Dataset retrieve(URL id)
          If an object of type Study3 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 Varlist(String condition, Collection variables, Boolean details, Collection weights, String format, String filter)
          General Variable Information
 String Varlist(String condition, Collection variables, Boolean details, Collection weights, String format, String filter, BasicExecutorLog log)
          General Variable Information
 
Methods inherited from class nesstar.api.faster.Study2
Breakdown, Breakdown, Datalist, Datalist, Descriptive, Descriptive, Download, Download, Frequency, Frequency, get_relatedMaterials, get_studyDistributors, getRelatedMaterials, getStudyDistributors, GFrequency, GFrequency, MultipleRegression, MultipleRegression, PathsTo, PathsTo, set_relatedMaterials, set_studyDistributors, setRelatedMaterials, setStudyDistributors, Tabulation, Tabulation, XBreak, XBreak
 
Methods inherited from class nesstar.api.faster.Study
get_accessPlace, get_analyticUnit, get_collectionEnd, get_collectionStart, get_countryCode, get_cubes, get_dataCollector, get_docAltTitl, get_docAuthEntity, get_docBiblCit, get_docCopyright, get_docEngTitle, get_docProdDate, get_docProducer, get_docTitle, get_engWeight, get_factsheets, get_files, get_keywords, get_nation, get_numCubes, get_periodEnd, get_periodStart, get_related, get_sections, get_series, get_seriesName, get_stdyAltTitl, get_stdyAuthEntity, get_stdyContact, get_stdyContactAffiliation, get_stdyContactEmail, get_stdyContributor, get_stdyCopyright, get_stdyDataAppraisal, get_stdyDataCollFreq, get_stdyDepDate, get_stdyID, get_stdyParTitl, get_stdyProdAgency, get_stdyProdDate, get_stdyProducer, get_stdyProducerAbbr, get_stdyStatus, get_stdyVersion, get_stdyVersionDate, get_stdyVersionNotes, get_stdyVersionResponsibility, get_stdyVersionType, get_tables, get_topics, get_universe, get_variables, get_weight, getAccessPlace, getAnalyticUnit, getCollectionEnd, getCollectionStart, getCountryCode, getCubes, getDataCollector, getDocAltTitl, getDocAuthEntity, getDocBiblCit, getDocCopyright, getDocEngTitle, getDocProdDate, getDocProducer, getDocTitle, getEngWeight, getFactsheets, getFiles, getKeywords, getKeywordsAsString, getNation, getNumCubes, getPeriodEnd, getPeriodStart, getRelated, getSections, getSeries, getSeriesName, getStdyAltTitl, getStdyAuthEntity, getStdyContact, getStdyContactAffiliation, getStdyContactAffiliationAsString, getStdyContactAsString, getStdyContactEmail, getStdyContactEmailAsString, getStdyContributor, getStdyCopyright, getStdyDataAppraisal, getStdyDataCollFreq, getStdyDepDate, getStdyID, getStdyParTitl, getStdyProdAgency, getStdyProdDate, getStdyProducer, getStdyProducerAbbr, getStdyStatus, getStdyVersion, getStdyVersionDate, getStdyVersionNotes, getStdyVersionResponsibility, getStdyVersionType, getTables, getTopics, getUniverse, getUniverseAsString, getVariables, getWeight, GetWeightVariables, GetWeightVariables, RangeQuery, RangeQuery, set_accessPlace, set_analyticUnit, set_collectionEnd, set_collectionStart, set_countryCode, set_cubes, set_dataCollector, set_docAltTitl, set_docAuthEntity, set_docBiblCit, set_docCopyright, set_docEngTitle, set_docProdDate, set_docProducer, set_docTitle, set_engWeight, set_factsheets, set_files, set_keywords, set_nation, set_numCubes, set_periodEnd, set_periodStart, set_related, set_sections, set_series, set_seriesName, set_stdyAltTitl, set_stdyAuthEntity, set_stdyContact, set_stdyContactAffiliation, set_stdyContactEmail, set_stdyContributor, set_stdyCopyright, set_stdyDataAppraisal, set_stdyDataCollFreq, set_stdyDepDate, set_stdyID, set_stdyParTitl, set_stdyProdAgency, set_stdyProdDate, set_stdyProducer, set_stdyProducerAbbr, set_stdyStatus, set_stdyVersion, set_stdyVersionDate, set_stdyVersionNotes, set_stdyVersionResponsibility, set_stdyVersionType, set_tables, set_topics, set_universe, set_variables, set_weight, setAccessPlace, setAnalyticUnit, setCollectionEnd, setCollectionStart, setCountryCode, setCubes, setDataCollector, setDocAltTitl, setDocAuthEntity, setDocBiblCit, setDocCopyright, setDocEngTitle, setDocProdDate, setDocProducer, setDocTitle, setEngWeight, setFactsheets, setFiles, setKeywords, setNation, setNumCubes, setPeriodEnd, setPeriodStart, setRelated, setSections, setSeries, setSeriesName, setStdyAltTitl, setStdyAuthEntity, setStdyContact, setStdyContactAffiliation, setStdyContactEmail, setStdyContributor, setStdyCopyright, setStdyDataAppraisal, setStdyDataCollFreq, setStdyDepDate, setStdyID, setStdyParTitl, setStdyProdAgency, setStdyProdDate, setStdyProducer, setStdyProducerAbbr, setStdyStatus, setStdyVersion, setStdyVersionDate, setStdyVersionNotes, setStdyVersionResponsibility, setStdyVersionType, setTables, setTopics, setUniverse, setVariables, setWeight
 
Methods inherited from class nesstar.api.DatasetEx
dbg, getDataset, getDatasetURL, getDDI, getId, getProvider, getProviderURL, hasData, setDDI
 
Methods inherited from class nesstar.api.Dataset
AddDataFile, AddDataFile, Breakdown, Breakdown, Datalist, Datalist, Delete, Delete, Descriptive, Descriptive, FindDDIVariables, FindDDIVariables, Frequency, Frequency, get_abstractText, get_accessConditions, get_accessStatus, get_collMode, get_dataKind, get_distributionDate, get_distributor, get_geographicalCover, get_geographicalUnit, get_hasData, get_sampling, get_source, get_subcat, get_timeMeth, get_timePeriod, get_title, getAbstractText, getAccessConditions, getAccessStatus, getCollMode, getComment, getDataKind, GetDDI, GetDDI, GetDDISkeleton, GetDDISkeleton, GetDDIVariable, GetDDIVariable, getDistributionDate, getDistributor, getGeographicalCover, getGeographicalCoverAsString, getGeographicalUnit, getGeographicalUnitAsString, getHasData, getLabel, getSampling, getSamplingAsString, getSource, getSubcat, getSubcatAsString, getTimeMeth, getTimePeriod, getTitle, GFrequency, GFrequency, MultipleRegression, MultipleRegression, set_abstractText, set_accessConditions, set_accessStatus, set_collMode, set_dataKind, set_distributionDate, set_distributor, set_geographicalCover, set_geographicalUnit, set_hasData, set_sampling, set_source, set_subcat, set_timeMeth, set_timePeriod, set_title, setAbstractText, setAccessConditions, setAccessStatus, setCollMode, setDataKind, setDistributionDate, setDistributor, setGeographicalCover, setGeographicalUnit, setHasData, setSampling, setSource, setSubcat, setTimeMeth, setTimePeriod, setTitle, Subset, Subset, Tabulation, Tabulation, XBreak, XBreak
 
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, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, 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

Study3

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

GetDerivedVariables

public Bookmark GetDerivedVariables()
                             throws Exception

Return a (possibly empty) collection of derived variables linked to this study and visible to the current user according to the current access control policy.

Throws:
Exception

GetDerivedVariables

public List GetDerivedVariables(BasicExecutorLog log)
                         throws Exception

Return a (possibly empty) collection of derived variables linked to this study and visible to the current user according to the current access control policy.

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 Dataset 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 Study2

retrieve

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

Varlist

public Bookmark Varlist(String condition,
                        Collection variables,
                        Boolean details,
                        Collection weights,
                        String format,
                        String filter)
                 throws Exception
General Variable Information

Parameters:
condition - The condition to be satisfied by the returned rows. <br/>For example: <B>v1 =1 and v2 =3-7</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS.
variables - The list of variables.
details - Include full variable details, the default is false.
weights - The list of weights to apply to this correlation.
format - The output format.<br/>It can be NESSTAR or XML.
filter - The short variable id with 'unlisted values' setting in single quotes followed by pairs of old then new category values, e.g. <b>V41 'origValue' 3 5 4 7 V22 'sysmis' 2 8 3 6</b>.
Throws:
Exception

Varlist

public String Varlist(String condition,
                      Collection variables,
                      Boolean details,
                      Collection weights,
                      String format,
                      String filter,
                      BasicExecutorLog log)
               throws Exception
General Variable Information

Parameters:
condition - The condition to be satisfied by the returned rows. <br/>For example: <B>v1 =1 and v2 =3-7</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS.
variables - The list of variables.
details - Include full variable details, the default is false.
weights - The list of weights to apply to this correlation.
format - The output format.<br/>It can be NESSTAR or XML.
filter - The short variable id with 'unlisted values' setting in single quotes followed by pairs of old then new category values, e.g. <b>V41 'origValue' 3 5 4 7 V22 'sysmis' 2 8 3 6</b>.
log - the Executor of this method;if null a default one is used
Throws:
Exception

Correlation

public Bookmark Correlation(String condition,
                            Collection variables,
                            String missing,
                            String type,
                            Collection weights,
                            String format,
                            String filter)
                     throws Exception
Bivariate Correlation Matrix

Parameters:
condition - The condition to be satisfied by the returned rows. <br/>For example: <B>v1 =1 and v2 =3-7</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS.
variables - The list of variables.
missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.
type - The type of correlation to perform: POLYCORRIC or blank.
weights - The list of weights to apply to this correlation.
format - The output format.<br/>It can be NESSTAR or XML.
filter - The short variable id with 'unlisted values' setting in single quotes followed by pairs of old then new category values, e.g. <b>V41 'origValue' 3 5 4 7 V22 'sysmis' 2 8 3 6</b>.
Throws:
Exception

Correlation

public String Correlation(String condition,
                          Collection variables,
                          String missing,
                          String type,
                          Collection weights,
                          String format,
                          String filter,
                          BasicExecutorLog log)
                   throws Exception
Bivariate Correlation Matrix

Parameters:
condition - The condition to be satisfied by the returned rows. <br/>For example: <B>v1 =1 and v2 =3-7</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS.
variables - The list of variables.
missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.
type - The type of correlation to perform: POLYCORRIC or blank.
weights - The list of weights to apply to this correlation.
format - The output format.<br/>It can be NESSTAR or XML.
filter - The short variable id with 'unlisted values' setting in single quotes followed by pairs of old then new category values, e.g. <b>V41 'origValue' 3 5 4 7 V22 'sysmis' 2 8 3 6</b>.
log - the Executor of this method;if null a default one is used
Throws:
Exception

CreateDerivedVariable

public Bookmark CreateDerivedVariable(String name,
                                      String label,
                                      String comment,
                                      String expression)
                               throws Exception

Create a new unique derived variable with the specified name, label, comment and expression.

The new variable is automatically associated with this study and with the current user.

Parameters:
name - the name of the variable, e.g. "AGE", the name cannot contain spaces and must start with a letter, this parameter is required
label - the human readable label for the new variable (e.g. "AGE BY DECADES"), this parameter is required
comment - a longer text (possibly containing HTML links and tags) explaining the purpose/meaning of the derived variable, this field is optional
expression - the expression that defines the new variable, this parameter is required
Returns:
the newly created derived variable.

Throws:
Exception

CreateDerivedVariable

public Variable CreateDerivedVariable(String name,
                                      String label,
                                      String comment,
                                      String expression,
                                      BasicExecutorLog log)
                               throws Exception

Create a new unique derived variable with the specified name, label, comment and expression.

The new variable is automatically associated with this study and with the current user.

Parameters:
name - the name of the variable, e.g. "AGE", the name cannot contain spaces and must start with a letter, this parameter is required
label - the human readable label for the new variable (e.g. "AGE BY DECADES"), this parameter is required
comment - a longer text (possibly containing HTML links and tags) explaining the purpose/meaning of the derived variable, this field is optional
expression - the expression that defines the new variable, this parameter is required
log - the Executor of this method;if null a default one is used
Returns:
the newly created derived variable.

Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved