nesstar.api.faster
Class Study2

java.lang.Object
  java.util.Observable
      nesstar.rdf.RDFObject
          nesstar.api.Dataset
              nesstar.api.DatasetEx
                  nesstar.api.faster.Study
                      nesstar.api.faster.Study2

All Implemented Interfaces:

Comparable, RDFObj

Direct Known Subclasses:

Study3

public class Study2
extends Study

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

Study2(RDFDB db, URL id)
Create an object with the indicated id in the indicated db

Method Summary

Bookmark	Breakdown(String condition, Variable dependent, Variable independent, Collection weights, String format, String filter)
String	Breakdown(String condition, Variable dependent, Variable independent, Collection weights, String format, String filter, BasicExecutorLog log)
void	clear() Clear all properties of this object
Bookmark	Datalist(String condition, String unique, Collection variables, Collection weights, String format, String filter)
String	Datalist(String condition, String unique, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log)
Bookmark	Descriptive(String condition, Boolean polygon, Collection variables, Collection weights, String format, String filter)
String	Descriptive(String condition, Boolean polygon, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log)
Bookmark	Download(String variables, String cases, String format)
URL	Download(String variables, String cases, String format, BasicExecutorLog log)
Bookmark	Frequency(String condition, Variable variable, Collection weights, String format, String filter, Boolean addEmptyCategories)
String	Frequency(String condition, Variable variable, Collection weights, String format, String filter, Boolean addEmptyCategories, BasicExecutorLog log)
RDFRef	get_relatedMaterials()
RDFRef	get_studyDistributors()
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 Dataset	getInstance(RDFDB db, URL id) If an object of type Study2 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()
List	getRelatedMaterials()
List	getStudyDistributors()
Bookmark	GFrequency(String condition, Collection variables, Collection weights, String format, String filter)
String	GFrequency(String condition, Collection variables, Collection weights, String format, String filter, 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.
Bookmark	MultipleRegression(String condition, Variable dependent, Collection independent, String method, String missing, Collection weights, Double pin, Double pout, String format, String filter)
String	MultipleRegression(String condition, Variable dependent, Collection independent, String method, String missing, Collection weights, Double pin, Double pout, String format, String filter, BasicExecutorLog log)
static Dataset	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 study to the 'to' object.
String	PathsTo(RDFObject to, BasicExecutorLog log) Return a list of paths that lead from the study to the 'to' object.
static Dataset	retrieve(URL id) If an object of type Study2 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_relatedMaterials(RDFRef relatedMaterials)
void	set_studyDistributors(RDFRef studyDistributors)
void	setRelatedMaterials(List relatedMaterials)
void	setStudyDistributors(List studyDistributors)
Bookmark	Tabulation(String condition, Collection variables, Collection weights, String format, String filter)
String	Tabulation(String condition, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log)
Bookmark	XBreak(String condition, Collection variables, Collection weights, String format, String filter)
String	XBreak(String condition, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log)

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

Study2

public Study2(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_relatedMaterials

public void set_relatedMaterials(RDFRef relatedMaterials)

Parameters:

relatedMaterials -

setRelatedMaterials

public void setRelatedMaterials(List relatedMaterials)
                         throws Exception

Parameters:

relatedMaterials -

Throws:

Exception

set_studyDistributors

public void set_studyDistributors(RDFRef studyDistributors)

Parameters:

studyDistributors -

setStudyDistributors

public void setStudyDistributors(List studyDistributors)
                          throws Exception

Parameters:

studyDistributors -

Throws:

Exception

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

get_relatedMaterials

public RDFRef get_relatedMaterials()
                            throws Exception

Throws:

Exception

getRelatedMaterials

public List getRelatedMaterials()
                         throws Exception

Returns:

Throws:

Exception

get_studyDistributors

public RDFRef get_studyDistributors()
                             throws Exception

Throws:

Exception

getStudyDistributors

public List getStudyDistributors()
                          throws Exception

Returns:

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 Study

retrieve

public static Dataset retrieve(URL id)
                        throws Exception

If an object of type Study2 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 Study2 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 Study

Descriptive

public Bookmark Descriptive(String condition,
                            Boolean polygon,
                            Collection variables,
                            Collection weights,
                            String format,
                            String filter)
                     throws Exception

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

polygon - Set to <b>true</b> if the <b>polygon</b> option has to be added

variables - The list of variables.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

Throws:

Exception

Descriptive

public String Descriptive(String condition,
                          Boolean polygon,
                          Collection variables,
                          Collection weights,
                          String format,
                          String filter,
                          BasicExecutorLog log)
                   throws Exception

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

polygon - Set to <b>true</b> if the <b>polygon</b> option has to be added

variables - The list of variables.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

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

Throws:

Exception

Datalist

public Bookmark Datalist(String condition,
                         String unique,
                         Collection variables,
                         Collection weights,
                         String format,
                         String filter)
                  throws Exception

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

unique - Acceptable values are: UNIQUE, COMPLETE.

variables - The list of variables.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

Throws:

Exception

Datalist

public String Datalist(String condition,
                       String unique,
                       Collection variables,
                       Collection weights,
                       String format,
                       String filter,
                       BasicExecutorLog log)
                throws Exception

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

unique - Acceptable values are: UNIQUE, COMPLETE.

variables - The list of variables.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

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

Throws:

Exception

Frequency

public Bookmark Frequency(String condition,
                          Variable variable,
                          Collection weights,
                          String format,
                          String filter,
                          Boolean addEmptyCategories)
                   throws Exception

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

variable - The variable whose frequency is calculated.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

addEmptyCategories - if <b>true</b> it includes empty categories in the statistics

Throws:

Exception

Frequency

public String Frequency(String condition,
                        Variable variable,
                        Collection weights,
                        String format,
                        String filter,
                        Boolean addEmptyCategories,
                        BasicExecutorLog log)
                 throws Exception

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

variable - The variable whose frequency is calculated.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

addEmptyCategories - if <b>true</b> it includes empty categories in the statistics

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

Throws:

Exception

GFrequency

public Bookmark GFrequency(String condition,
                           Collection variables,
                           Collection weights,
                           String format,
                           String filter)
                    throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

Throws:

Exception

GFrequency

public String GFrequency(String condition,
                         Collection variables,
                         Collection weights,
                         String format,
                         String filter,
                         BasicExecutorLog log)
                  throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

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

Throws:

Exception

Breakdown

public Bookmark Breakdown(String condition,
                          Variable dependent,
                          Variable independent,
                          Collection weights,
                          String format,
                          String filter)
                   throws Exception

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.

independent - The independent variable.

weights -

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

filter -

Throws:

Exception

Breakdown

public String Breakdown(String condition,
                        Variable dependent,
                        Variable independent,
                        Collection weights,
                        String format,
                        String filter,
                        BasicExecutorLog log)
                 throws Exception

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.

independent - The independent variable.

weights -

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

filter -

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

Throws:

Exception

MultipleRegression

public Bookmark MultipleRegression(String condition,
                                   Variable dependent,
                                   Collection independent,
                                   String method,
                                   String missing,
                                   Collection weights,
                                   Double pin,
                                   Double pout,
                                   String format,
                                   String filter)
                            throws Exception

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.

independent - The independent variable.

method - The method parameter, acceptable values are: ENTER FORWARD BACKWARD or blank.

missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.

weights - The output format.<br/>It can be NESSTAR or XML

pin - The pin parameter, a value < 0 to signal is ignored.

pout - The pout parameter, a value < 0 is ignored.

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

filter -

Throws:

Exception

MultipleRegression

public String MultipleRegression(String condition,
                                 Variable dependent,
                                 Collection independent,
                                 String method,
                                 String missing,
                                 Collection weights,
                                 Double pin,
                                 Double pout,
                                 String format,
                                 String filter,
                                 BasicExecutorLog log)
                          throws Exception

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.

independent - The independent variable.

method - The method parameter, acceptable values are: ENTER FORWARD BACKWARD or blank.

missing - The missing parameter, acceptable values are: PAIRWISE LISTWISE or blank.

weights - The output format.<br/>It can be NESSTAR or XML

pin - The pin parameter, a value < 0 to signal is ignored.

pout - The pout parameter, a value < 0 is ignored.

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

filter -

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

Throws:

Exception

Tabulation

public Bookmark Tabulation(String condition,
                           Collection variables,
                           Collection weights,
                           String format,
                           String filter)
                    throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

Throws:

Exception

Tabulation

public String Tabulation(String condition,
                         Collection variables,
                         Collection weights,
                         String format,
                         String filter,
                         BasicExecutorLog log)
                  throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

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

Throws:

Exception

XBreak

public Bookmark XBreak(String condition,
                       Collection variables,
                       Collection weights,
                       String format,
                       String filter)
                throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

Throws:

Exception

XBreak

public String XBreak(String condition,
                     Collection variables,
                     Collection weights,
                     String format,
                     String filter,
                     BasicExecutorLog log)
              throws Exception

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.

weights - The output format.<br/>It can be NESSTAR or XML

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

filter -

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

Throws:

Exception

PathsTo

public Bookmark PathsTo(RDFObject to)
                 throws Exception

Return a list of paths that lead from the study to the 'to' object. A path is a sequence of property traversals. For example .sections[2].variables[3] is a path that leads from the study to the third variable of the second study's section.

Parameters:

to - The object to which the paths lead.

Returns:

A String containing a list of ; separated paths.

Throws:

Exception

PathsTo

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

Return a list of paths that lead from the study to the 'to' object. A path is a sequence of property traversals. For example .sections[2].variables[3] is a path that leads from the study to the third variable of the second study's section.

Parameters:

to - The object to which the paths lead.

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

Returns:

A String containing a list of ; separated paths.

Throws:

Exception

Download

public Bookmark Download(String variables,
                         String cases,
                         String format)
                  throws Exception

Parameters:

variables - List of variables to be stored in returned datafile.<br/> For example: <B>v1 , v3 , v5 - v7 , v9 , v10 - v21 , v23</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS

cases -

format -

Throws:

Exception

This property replaces:

Replaces Subset

Download

public URL Download(String variables,
                    String cases,
                    String format,
                    BasicExecutorLog log)
             throws Exception

Parameters:

variables - List of variables to be stored in returned datafile.<br/> For example: <B>v1 , v3 , v5 - v7 , v9 , v10 - v21 , v23</B> <br/>Important: SPACES are required between all VARIABLES and OPERATORS

cases -

format -

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

Throws:

Exception

This property replaces:

Replaces Subset