nesstar.api
Class Dataset

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.Dataset
All Implemented Interfaces:
Comparable, RDFObj
Direct Known Subclasses:
DatasetEx

public class Dataset
extends RDFObject

A dataset, whose metadata is defined according to the DDI standard and whose data is stored in one or more NSDSTAT files.

The 'comment' property is derived from the DDI field:
<codeBook><stdyDscr><stdyInfo><abstract> Code automatically generated from ARGO/UML
The 'label' property is derived from the DDI field:
<codeBook><stdyDscr><citation><titlStmt><titl>

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
Dataset(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 Bookmark AddDataFile(String fileID, File dkm, File ind, File nsf)
          Deprecated. support for old-style NSD datafiles has been dropped, use Datafile.AddDatafile(..) instead.
 void AddDataFile(String fileID, File dkm, File ind, File nsf, BasicExecutorLog log)
          Deprecated. support for old-style NSD datafiles has been dropped, use Datafile.AddDatafile(..) instead.
 Bookmark Breakdown(String condition, String dependent, String independent, String keys, String mergeVariables, String weights)
          Deprecated. Replaced by Study2 Breakdown
 String Breakdown(String condition, String dependent, String independent, String keys, String mergeVariables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Breakdown
 void clear()
          Clear all properties of this object
 Bookmark Datalist(String condition, String keys, String mergeVariables, String unique, String variables, String weights)
          Deprecated. Replaced by Study2 Datalist
 String Datalist(String condition, String keys, String mergeVariables, String unique, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Datalist
 Bookmark Delete()
          Delete the dataset from the server.
 void Delete(BasicExecutorLog log)
          Delete the dataset from the server.
 Bookmark Descriptive(String condition, String keys, String mergeVariables, String polygon, String variables, String weights)
          Deprecated. Replaced by Study2 Descriptive
 String Descriptive(String condition, String keys, String mergeVariables, String polygon, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Descriptive
 Bookmark FindDDIVariables(String keyword)
          Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.* CONTAINS 'phrase'").
 String FindDDIVariables(String keyword, BasicExecutorLog log)
          Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.* CONTAINS 'phrase'").
 Bookmark Frequency(String condition, String keys, String mergeVariables, String variables, String weights)
          Deprecated. Replaced by Study2 Frequency
 String Frequency(String condition, String keys, String mergeVariables, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Frequency
 String get_abstractText()
           
 String get_accessConditions()
           
 String get_accessStatus()
           
 String get_collMode()
           
 String get_dataKind()
           
 String get_distributionDate()
           
 String get_distributor()
           
 String get_geographicalCover()
           
 String get_geographicalUnit()
           
 String get_hasData()
           
 String get_sampling()
           
 String get_source()
           
 String get_subcat()
           
 String get_timeMeth()
           
 String get_timePeriod()
           
 String get_title()
           
 String getAbstractText()
           The abstract.
 String getAccessConditions()
           Restriction on access or use.
 String getAccessStatus()
           The access status of the study with respect to the current user (e.g.
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 String getCollMode()
           The collection mode, e.g.
 String getComment()
           The abstract.
 String getDataKind()
           The kind of data, e.g.
 Bookmark GetDDI()
           Get the full DDI metadata for this dataset.
 String GetDDI(BasicExecutorLog log)
           Get the full DDI metadata for this dataset.
 Bookmark GetDDISkeleton()
          Get a possibly incomplete DDI document.
 String GetDDISkeleton(BasicExecutorLog log)
          Get a possibly incomplete DDI document.
 Bookmark GetDDIVariable(Integer varID)
          Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.id == 'VID'").
 String GetDDIVariable(Integer varID, BasicExecutorLog log)
          Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.id == 'VID'").
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
 Date getDistributionDate()
           Date of distribution of study
 String getDistributor()
           A distributor is defined as the organization designated by the author or producer to generate copies of the data/documentation including any necessary editions or revisions.
 String[] getGeographicalCover()
           Geographic coverage
 String getGeographicalCoverAsString()
           
 String[] getGeographicalUnit()
           Lowest level of geog.
 String getGeographicalUnitAsString()
           
static Collection getGetterMethods()
           
 String getHasData()
           Does this dataset have data files?.
static Dataset getInstance(RDFDB db, URL id)
          If an object of type Dataset 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)
           
 String getLabel()
           Title of the Dataset
static Collection getPartsDescriptor()
           
 String[] getSampling()
           sampling procedure, inc.
 String getSamplingAsString()
           
 String getSource()
           Used to list the book(s), article(s), serial(s), and/or machine-readable data file(s), if any, that served as the source(s) of the data collection.
 String[] getSubcat()
           The classification field indicates the broad substantive topic(s) that the data cover.
 String getSubcatAsString()
           
 String getTimeMeth()
           eg panel, trend, time series
 Date getTimePeriod()
           The time period to which the data refer.
 String getTitle()
          Deprecated. replaced by label
 Bookmark GFrequency(String condition, String keys, String mergeVariables, String variables, String weights)
          Deprecated. Replaced by Study2 GFrequency
 String GFrequency(String condition, String keys, String mergeVariables, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 GFrequency
 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 MultipleRegression(String condition, String dependent, String independent, String keys, String mergeVariables, String method, String missing, String weights, Double pin, Double pout)
          Deprecated. Replaced by Study2 MultipleRegression
 String MultipleRegression(String condition, String dependent, String independent, String keys, String mergeVariables, String method, String missing, String weights, Double pin, Double pout, BasicExecutorLog log)
          Deprecated. Replaced by Study2 MultipleRegression
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 Dataset 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_abstractText(String abstractText)
           
 void set_accessConditions(String accessConditions)
           
 void set_accessStatus(String accessStatus)
           
 void set_collMode(String collMode)
           
 void set_dataKind(String dataKind)
           
 void set_distributionDate(String distributionDate)
           
 void set_distributor(String distributor)
           
 void set_geographicalCover(String geographicalCover)
           
 void set_geographicalUnit(String geographicalUnit)
           
 void set_hasData(String hasData)
           
 void set_sampling(String sampling)
           
 void set_source(String source)
           
 void set_subcat(String subcat)
           
 void set_timeMeth(String timeMeth)
           
 void set_timePeriod(String timePeriod)
           
 void set_title(String title)
           
 void setAbstractText(String abstractText)
           The abstract.
 void setAccessConditions(String accessConditions)
           Restriction on access or use.
 void setAccessStatus(String accessStatus)
           The access status of the study with respect to the current user (e.g.
 void setCollMode(String collMode)
           The collection mode, e.g.
 void setDataKind(String dataKind)
           The kind of data, e.g.
 void setDistributionDate(Date distributionDate)
           Date of distribution of study
 void setDistributor(String distributor)
           A distributor is defined as the organization designated by the author or producer to generate copies of the data/documentation including any necessary editions or revisions.
 void setGeographicalCover(String[] geographicalCover)
           Geographic coverage
 void setGeographicalUnit(String[] geographicalUnit)
           Lowest level of geog.
 void setHasData(String hasData)
           Does this dataset have data files?.
 void setSampling(String[] sampling)
           sampling procedure, inc.
 void setSource(String source)
           Used to list the book(s), article(s), serial(s), and/or machine-readable data file(s), if any, that served as the source(s) of the data collection.
 void setSubcat(String[] subcat)
           The classification field indicates the broad substantive topic(s) that the data cover.
 void setTimeMeth(String timeMeth)
           eg panel, trend, time series
 void setTimePeriod(Date timePeriod)
           The time period to which the data refer.
 void setTitle(String title)
          Deprecated. replaced by label
 Bookmark Subset(String cases, String condition, String format, String keys, String mergeVariables)
          Deprecated. Replaced by Study2 Download
 URL Subset(String cases, String condition, String format, String keys, String mergeVariables, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Download
 Bookmark Tabulation(String condition, String keys, String mergeVariables, String variables, String weights)
          Deprecated. Replaced by Study2 Tabulation
 String Tabulation(String condition, String keys, String mergeVariables, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 Tabulation
 Bookmark XBreak(String condition, String keys, String mergeVariables, String variables, String weights)
          Deprecated. Replaced by Study2 XBreak
 String XBreak(String condition, String keys, String mergeVariables, String variables, String weights, BasicExecutorLog log)
          Deprecated. Replaced by Study2 XBreak
 
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, 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

Dataset

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

setAbstractText

public void setAbstractText(String abstractText)

The abstract.

Parameters:
abstractText -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><abstract>

set_abstractText

public void set_abstractText(String abstractText)
Parameters:
abstractText -

setAccessConditions

public void setAccessConditions(String accessConditions)

Restriction on access or use.

Parameters:
accessConditions -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><dataAccs><useStmt><restrctn>

set_accessConditions

public void set_accessConditions(String accessConditions)
Parameters:
accessConditions -

setAccessStatus

public void setAccessStatus(String accessStatus)

The access status of the study with respect to the current user (e.g. NoAccess, FreeAccess, etc.)

Parameters:
accessStatus -

set_accessStatus

public void set_accessStatus(String accessStatus)
Parameters:
accessStatus -

setCollMode

public void setCollMode(String collMode)

The collection mode, e.g. Telephone, mail, questionnaire

Parameters:
collMode -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><collMode>

set_collMode

public void set_collMode(String collMode)
Parameters:
collMode -

setDataKind

public void setDataKind(String dataKind)

The kind of data, e.g. individual level.

Parameters:
dataKind -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><dataKind>

set_dataKind

public void set_dataKind(String dataKind)
Parameters:
dataKind -

setDistributionDate

public void setDistributionDate(Date distributionDate)

Date of distribution of study

Parameters:
distributionDate -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><distDate date>

set_distributionDate

public void set_distributionDate(String distributionDate)
Parameters:
distributionDate -

setDistributor

public void setDistributor(String distributor)

A distributor is defined as the organization designated by the author or producer to generate copies of the data/documentation including any necessary editions or revisions. Names and addresses may be specified, and other archives may be co-distributors.

Parameters:
distributor -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><distrbtr>

set_distributor

public void set_distributor(String distributor)
Parameters:
distributor -

setGeographicalCover

public void setGeographicalCover(String[] geographicalCover)

Geographic coverage

Parameters:
geographicalCover -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><geogCover>

set_geographicalCover

public void set_geographicalCover(String geographicalCover)
Parameters:
geographicalCover -

setGeographicalUnit

public void setGeographicalUnit(String[] geographicalUnit)

Lowest level of geog. aggregation

Parameters:
geographicalUnit -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><geogUnit>

set_geographicalUnit

public void set_geographicalUnit(String geographicalUnit)
Parameters:
geographicalUnit -

setHasData

public void setHasData(String hasData)

Does this dataset have data files?.

Parameters:
hasData -

set_hasData

public void set_hasData(String hasData)
Parameters:
hasData -

setSampling

public void setSampling(String[] sampling)

sampling procedure, inc. size, fraction.

Parameters:
sampling -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><sampProc>

set_sampling

public void set_sampling(String sampling)
Parameters:
sampling -

setSource

public void setSource(String source)

Used to list the book(s), article(s), serial(s), and/or machine-readable data file(s), if any, that served as the source(s) of the data collection.

Parameters:
source -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><sources><dataSrc>

set_source

public void set_source(String source)
Parameters:
source -

setSubcat

public void setSubcat(String[] subcat)

The classification field indicates the broad substantive topic(s) that the data cover.

Parameters:
subcat -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><subject><topcClas>

set_subcat

public void set_subcat(String subcat)
Parameters:
subcat -

setTimeMeth

public void setTimeMeth(String timeMeth)

eg panel, trend, time series

Parameters:
timeMeth -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><timeMeth>

set_timeMeth

public void set_timeMeth(String timeMeth)
Parameters:
timeMeth -

setTimePeriod

public void setTimePeriod(Date timePeriod)

The time period to which the data refer.

Parameters:
timePeriod -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=single>

set_timePeriod

public void set_timePeriod(String timePeriod)
Parameters:
timePeriod -

setTitle

public void setTitle(String title)
Deprecated. replaced by label

Title of the Dataset

Parameters:
title -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><titl>

set_title

public void set_title(String title)
Parameters:
title -

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

getAbstractText

public String getAbstractText()

The abstract.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><abstract>

get_abstractText

public String get_abstractText()
                        throws Exception
Throws:
Exception

getAccessConditions

public String getAccessConditions()

Restriction on access or use.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><dataAccs><useStmt><restrctn>

get_accessConditions

public String get_accessConditions()
                            throws Exception
Throws:
Exception

getAccessStatus

public String getAccessStatus()

The access status of the study with respect to the current user (e.g. NoAccess, FreeAccess, etc.)


get_accessStatus

public String get_accessStatus()
                        throws Exception
Throws:
Exception

getCollMode

public String getCollMode()

The collection mode, e.g. Telephone, mail, questionnaire

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><collMode>

get_collMode

public String get_collMode()
                    throws Exception
Throws:
Exception

getDataKind

public String getDataKind()

The kind of data, e.g. individual level.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><dataKind>

get_dataKind

public String get_dataKind()
                    throws Exception
Throws:
Exception

getDistributionDate

public Date getDistributionDate()

Date of distribution of study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><distDate date>

get_distributionDate

public String get_distributionDate()
                            throws Exception
Throws:
Exception

getDistributor

public String getDistributor()

A distributor is defined as the organization designated by the author or producer to generate copies of the data/documentation including any necessary editions or revisions. Names and addresses may be specified, and other archives may be co-distributors.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><distrbtr>

get_distributor

public String get_distributor()
                       throws Exception
Throws:
Exception

getGeographicalCover

public String[] getGeographicalCover()

Geographic coverage

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><geogCover>

getGeographicalCoverAsString

public String getGeographicalCoverAsString()

get_geographicalCover

public String get_geographicalCover()
                             throws Exception
Throws:
Exception

getGeographicalUnit

public String[] getGeographicalUnit()

Lowest level of geog. aggregation

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><geogUnit>

getGeographicalUnitAsString

public String getGeographicalUnitAsString()

get_geographicalUnit

public String get_geographicalUnit()
                            throws Exception
Throws:
Exception

getHasData

public String getHasData()

Does this dataset have data files?.


get_hasData

public String get_hasData()
                   throws Exception
Throws:
Exception

getSampling

public String[] getSampling()

sampling procedure, inc. size, fraction.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><sampProc>

getSamplingAsString

public String getSamplingAsString()

get_sampling

public String get_sampling()
                    throws Exception
Throws:
Exception

getSource

public String getSource()

Used to list the book(s), article(s), serial(s), and/or machine-readable data file(s), if any, that served as the source(s) of the data collection.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><sources><dataSrc>

get_source

public String get_source()
                  throws Exception
Throws:
Exception

getSubcat

public String[] getSubcat()

The classification field indicates the broad substantive topic(s) that the data cover.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><subject><topcClas>

getSubcatAsString

public String getSubcatAsString()

get_subcat

public String get_subcat()
                  throws Exception
Throws:
Exception

getTimeMeth

public String getTimeMeth()

eg panel, trend, time series

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><timeMeth>

get_timeMeth

public String get_timeMeth()
                    throws Exception
Throws:
Exception

getTimePeriod

public Date getTimePeriod()

The time period to which the data refer.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=single>

get_timePeriod

public String get_timePeriod()
                      throws Exception
Throws:
Exception

getTitle

public String getTitle()
Deprecated. replaced by label

Title of the Dataset

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><titl>

get_title

public String get_title()
                 throws Exception
Throws:
Exception

getLabel

public String getLabel()

Title of the Dataset

Overrides:
getLabel in class RDFObject
This property replaces:
Title
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><titl>

getComment

public String getComment()

The abstract.

Overrides:
getComment in class RDFObject
Returns:
the comment
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><abstract>

GetDDI

public Bookmark GetDDI()
                throws Exception

Get the full DDI metadata for this dataset.

Throws:
Exception

GetDDI

public String GetDDI(BasicExecutorLog log)
              throws Exception

Get the full DDI metadata for this dataset.

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

GetDDISkeleton

public Bookmark GetDDISkeleton()
                        throws Exception
Get a possibly incomplete DDI document.

Some or all of the variable elements might have been reduced to their skeleton form.

Throws:
Exception

GetDDISkeleton

public String GetDDISkeleton(BasicExecutorLog log)
                      throws Exception
Get a possibly incomplete DDI document.

Some or all of the variable elements might have been reduced to their skeleton form.

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

GetDDIVariable

public Bookmark GetDDIVariable(Integer varID)
                        throws Exception
Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.id == 'VID'").

Get the full XML code of the variable.

Parameters:
varID - The sequential number of the variable to get (starting from 1).
Throws:
Exception

GetDDIVariable

public String GetDDIVariable(Integer varID,
                             BasicExecutorLog log)
                      throws Exception
Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.id == 'VID'").

Get the full XML code of the variable.

Parameters:
varID - The sequential number of the variable to get (starting from 1).
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 RDFObject

retrieve

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

AddDataFile

public Bookmark AddDataFile(String fileID,
                            File dkm,
                            File ind,
                            File nsf)
                     throws Exception
Deprecated. support for old-style NSD datafiles has been dropped, use Datafile.AddDatafile(..) instead.

Upload one of the datafiles of this dataset.

There can be one or more datafiles associated with each dataset.

Each datafile has an unique ID indicated in the ID attribute of the fileDscr/fileName element.

The datafile should be in NSDSTAT format and it's actually composed by three separate files with suffixes: dkm, ind and nsf.

Parameters:
fileID - The unique datafile ID as indicated in the <b>ID</b> attribute of the <b>fileDscr/fileName</b> element.
dkm -
ind -
nsf -
Throws:
Exception

AddDataFile

public void AddDataFile(String fileID,
                        File dkm,
                        File ind,
                        File nsf,
                        BasicExecutorLog log)
                 throws Exception
Deprecated. support for old-style NSD datafiles has been dropped, use Datafile.AddDatafile(..) instead.

Upload one of the datafiles of this dataset.

There can be one or more datafiles associated with each dataset.

Each datafile has an unique ID indicated in the ID attribute of the fileDscr/fileName element.

The datafile should be in NSDSTAT format and it's actually composed by three separate files with suffixes: dkm, ind and nsf.

Parameters:
fileID - The unique datafile ID as indicated in the <b>ID</b> attribute of the <b>fileDscr/fileName</b> element.
dkm -
ind -
nsf -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Delete

public Bookmark Delete()
                throws Exception
Delete the dataset from the server.

Throws:
Exception

Delete

public void Delete(BasicExecutorLog log)
            throws Exception
Delete the dataset from the server.

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

FindDDIVariables

public Bookmark FindDDIVariables(String keyword)
                          throws Exception
Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.* CONTAINS 'phrase'").

Get a list of the IDs of the DDI variables that contain the specified keyword.
For example: 11 12 13

Parameters:
keyword - The keyword to search for (case is ignored).
Throws:
Exception

FindDDIVariables

public String FindDDIVariables(String keyword,
                               BasicExecutorLog log)
                        throws Exception
Deprecated. Replaced by Study2.RangeQuery("GET Variable WHERE Variable.* CONTAINS 'phrase'").

Get a list of the IDs of the DDI variables that contain the specified keyword.
For example: 11 12 13

Parameters:
keyword - The keyword to search for (case is ignored).
log - the Executor of this method;if null a default one is used
Throws:
Exception

Subset

public Bookmark Subset(String cases,
                       String condition,
                       String format,
                       String keys,
                       String mergeVariables)
                throws Exception
Deprecated. Replaced by Study2 Download

Get a subset of this dataset.

Returns the URL of a zipped file containing the required datafile(s).

Parameters:
cases -
condition - The condition to be satisfied by the returned cases. <br>For example: <b>v1 =1 and v2 =3-7</b> <br>Important: SPACES are required between all VARIABLES and OPERATORS
format -
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
Throws:
Exception

Subset

public URL Subset(String cases,
                  String condition,
                  String format,
                  String keys,
                  String mergeVariables,
                  BasicExecutorLog log)
           throws Exception
Deprecated. Replaced by Study2 Download

Get a subset of this dataset.

Returns the URL of a zipped file containing the required datafile(s).

Parameters:
cases -
condition - The condition to be satisfied by the returned cases. <br>For example: <b>v1 =1 and v2 =3-7</b> <br>Important: SPACES are required between all VARIABLES and OPERATORS
format -
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
log - the Executor of this method;if null a default one is used
Throws:
Exception

Descriptive

public Bookmark Descriptive(String condition,
                            String keys,
                            String mergeVariables,
                            String polygon,
                            String variables,
                            String weights)
                     throws Exception
Deprecated. Replaced by Study2 Descriptive

The list of weighting variables.
For example: v1 v3. Calculate descriptive statistics.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v1 v3 v4 v5</b>.
polygon - Set to <b>true</b> if the <b>polygon</b> option has to be added.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
Throws:
Exception

Descriptive

public String Descriptive(String condition,
                          String keys,
                          String mergeVariables,
                          String polygon,
                          String variables,
                          String weights,
                          BasicExecutorLog log)
                   throws Exception
Deprecated. Replaced by Study2 Descriptive

The list of weighting variables.
For example: v1 v3. Calculate descriptive statistics.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v1 v3 v4 v5</b>.
polygon - Set to <b>true</b> if the <b>polygon</b> option has to be added.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Datalist

public Bookmark Datalist(String condition,
                         String keys,
                         String mergeVariables,
                         String unique,
                         String variables,
                         String weights)
                  throws Exception
Deprecated. Replaced by Study2 Datalist

The list of weighting variables.
For example: v1 v3. Calculate Datalist statistics.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
unique - Acceptable values are: UNIQUE, COMPLETE.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
Throws:
Exception

Datalist

public String Datalist(String condition,
                       String keys,
                       String mergeVariables,
                       String unique,
                       String variables,
                       String weights,
                       BasicExecutorLog log)
                throws Exception
Deprecated. Replaced by Study2 Datalist

The list of weighting variables.
For example: v1 v3. Calculate Datalist statistics.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
unique - Acceptable values are: UNIQUE, COMPLETE.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Frequency

public Bookmark Frequency(String condition,
                          String keys,
                          String mergeVariables,
                          String variables,
                          String weights)
                   throws Exception
Deprecated. Replaced by Study2 Frequency

The list of weighting variables.
For example: v1 v3. Frequencies.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
Throws:
Exception

Frequency

public String Frequency(String condition,
                        String keys,
                        String mergeVariables,
                        String variables,
                        String weights,
                        BasicExecutorLog log)
                 throws Exception
Deprecated. Replaced by Study2 Frequency

The list of weighting variables.
For example: v1 v3. Frequencies.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

GFrequency

public Bookmark GFrequency(String condition,
                           String keys,
                           String mergeVariables,
                           String variables,
                           String weights)
                    throws Exception
Deprecated. Replaced by Study2 GFrequency

The list of weighting variables.
For example: v1 v3. Gfrequencies (?).

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
Throws:
Exception

GFrequency

public String GFrequency(String condition,
                         String keys,
                         String mergeVariables,
                         String variables,
                         String weights,
                         BasicExecutorLog log)
                  throws Exception
Deprecated. Replaced by Study2 GFrequency

The list of weighting variables.
For example: v1 v3. Gfrequencies (?).

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables. <br>For example: <b>v1 v3</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Breakdown

public Bookmark Breakdown(String condition,
                          String dependent,
                          String independent,
                          String keys,
                          String mergeVariables,
                          String weights)
                   throws Exception
Deprecated. Replaced by Study2 Breakdown

The list of weighting variables.
For example: v1 v3. Breakdown.

Returns the result of the operation in a proprietary NSDSTAT format.

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
dependent - The dependent variable. <br>For example: <b>v1</b>.
independent - The independent variable. <br>For example: <b>v2</b>.
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
weights -
Throws:
Exception

Breakdown

public String Breakdown(String condition,
                        String dependent,
                        String independent,
                        String keys,
                        String mergeVariables,
                        String weights,
                        BasicExecutorLog log)
                 throws Exception
Deprecated. Replaced by Study2 Breakdown

The list of weighting variables.
For example: v1 v3. Breakdown.

Returns the result of the operation in a proprietary NSDSTAT format.

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
dependent - The dependent variable. <br>For example: <b>v1</b>.
independent - The independent variable. <br>For example: <b>v2</b>.
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

MultipleRegression

public Bookmark MultipleRegression(String condition,
                                   String dependent,
                                   String independent,
                                   String keys,
                                   String mergeVariables,
                                   String method,
                                   String missing,
                                   String weights,
                                   Double pin,
                                   Double pout)
                            throws Exception
Deprecated. Replaced by Study2 MultipleRegression

The list of weighting variables.
For example: v1 v3. MultipleRegression.

Returns the result of the operation in a proprietary NSDSTAT format.

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
dependent - The dependent variable. <br>For example: <b>v1</b>.
independent - The independent variable. <br>For example: <b>v1</b>.
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
method - The method parameter, acceptable values are: ENTER FORWARD BACKWARD or blank.
missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.
weights -
pin - The pin parameter, a value < 0 to signal is ignored.
pout -
Throws:
Exception

MultipleRegression

public String MultipleRegression(String condition,
                                 String dependent,
                                 String independent,
                                 String keys,
                                 String mergeVariables,
                                 String method,
                                 String missing,
                                 String weights,
                                 Double pin,
                                 Double pout,
                                 BasicExecutorLog log)
                          throws Exception
Deprecated. Replaced by Study2 MultipleRegression

The list of weighting variables.
For example: v1 v3. MultipleRegression.

Returns the result of the operation in a proprietary NSDSTAT format.

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
dependent - The dependent variable. <br>For example: <b>v1</b>.
independent - The independent variable. <br>For example: <b>v1</b>.
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
method - The method parameter, acceptable values are: ENTER FORWARD BACKWARD or blank.
missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.
weights -
pin - The pin parameter, a value < 0 to signal is ignored.
pout -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Tabulation

public Bookmark Tabulation(String condition,
                           String keys,
                           String mergeVariables,
                           String variables,
                           String weights)
                    throws Exception
Deprecated. Replaced by Study2 Tabulation

The list of weighting variables.
For example: v1 v3. A cross tabulation on this dataset.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables to tabulate separated by <b>BY</b>. <br>For example: <b>v1 BY v1 BY v1</b>.
weights -
Throws:
Exception

Tabulation

public String Tabulation(String condition,
                         String keys,
                         String mergeVariables,
                         String variables,
                         String weights,
                         BasicExecutorLog log)
                  throws Exception
Deprecated. Replaced by Study2 Tabulation

The list of weighting variables.
For example: v1 v3. A cross tabulation on this dataset.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables to tabulate separated by <b>BY</b>. <br>For example: <b>v1 BY v1 BY v1</b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

XBreak

public Bookmark XBreak(String condition,
                       String keys,
                       String mergeVariables,
                       String variables,
                       String weights)
                throws Exception
Deprecated. Replaced by Study2 XBreak

The list of weighting variables.
For example: v1 v3. An xbreak (?) on this dataset.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables to tabulate separated by <b>BY</b>. <br>For example: <b>v1 BY v2 </b>.
weights -
Throws:
Exception

XBreak

public String XBreak(String condition,
                     String keys,
                     String mergeVariables,
                     String variables,
                     String weights,
                     BasicExecutorLog log)
              throws Exception
Deprecated. Replaced by Study2 XBreak

The list of weighting variables.
For example: v1 v3. An xbreak (?) on this dataset.

Returns the result of the operation in a proprietary NSDSTAT format.

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
keys - The list of key variables. <br>For example: <b>v1 v3</b>.
mergeVariables - The list of variables to use for merging. <br>For example: <b>v2 v3 v4 v5</b>.
variables - The list of variables to tabulate separated by <b>BY</b>. <br>For example: <b>v1 BY v2 </b>.
weights -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved