|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.Observable
nesstar.rdf.RDFObject
nesstar.api.Dataset
nesstar.api.DatasetEx
nesstar.api.faster.Study
nesstar.api.faster.Study2
public class 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 | |
---|---|
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.DatasetEx |
---|
dbg, getDataset, getDatasetURL, getDDI, getId, getProvider, getProviderURL, hasData, setDDI |
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 |
---|
public static String CLASS_ID
Constructor Detail |
---|
public Study2(RDFDB db, URL id) throws Exception
db
- the db where the object is to be createdid
- the id of the object to create
Exception
Method Detail |
---|
public void set_relatedMaterials(RDFRef relatedMaterials)
relatedMaterials
- public void setRelatedMaterials(List relatedMaterials) throws Exception
relatedMaterials
-
Exception
public void set_studyDistributors(RDFRef studyDistributors)
studyDistributors
- public void setStudyDistributors(List studyDistributors) throws Exception
studyDistributors
-
Exception
public static Vector getAllInstances(RDFDB db) throws Exception
db
- the db where the instances are to be found
Exception
public static Vector getAllInstances() throws Exception
Exception
public static Dataset getInstance(RDFDB db, URL id) throws Exception
db
- the db where the object is to be found or createdid
- the id of the object to retrieve or create
Exception
public static Dataset getInstance(String rdf) throws Exception
rdf
- some rdf code that contains a description of an object of this kind
Exception
public RDFRef get_relatedMaterials() throws Exception
Exception
public List getRelatedMaterials() throws Exception
Exception
public RDFRef get_studyDistributors() throws Exception
Exception
public List getStudyDistributors() throws Exception
Exception
public static FeatureDescriptor getDescriptor(String featureName)
featureName
- public static Collection getPartsDescriptor()
public static Collection getGetterMethods()
public static Dataset newInstance(RDFDB db) throws Exception
db
- the db where the object is to be found or created
Exception
public static void listenForNewObj(NewObjListener listener)
listener
- the listenerpublic void initialised()
initialised
in class Study
public static Dataset retrieve(URL id) throws Exception
id
- the id of the object to retrieve
Exception
public void clear()
RDFObject
clear
in class Study
public Bookmark Descriptive(String condition, Boolean polygon, Collection variables, Collection weights, String format, String filter) throws Exception
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 OPERATORSpolygon
- Set to <b>true</b> if the <b>polygon</b> option has to be addedvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
-
Exception
public String Descriptive(String condition, Boolean polygon, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSpolygon
- Set to <b>true</b> if the <b>polygon</b> option has to be addedvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
public Bookmark Datalist(String condition, String unique, Collection variables, Collection weights, String format, String filter) throws Exception
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 OPERATORSunique
- Acceptable values are: UNIQUE, COMPLETE.variables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
-
Exception
public String Datalist(String condition, String unique, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSunique
- Acceptable values are: UNIQUE, COMPLETE.variables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
public Bookmark Frequency(String condition, Variable variable, Collection weights, String format, String filter, Boolean addEmptyCategories) throws Exception
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 OPERATORSvariable
- The variable whose frequency is calculated.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
public String Frequency(String condition, Variable variable, Collection weights, String format, String filter, Boolean addEmptyCategories, BasicExecutorLog log) throws Exception
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 OPERATORSvariable
- The variable whose frequency is calculated.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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 statisticslog
- the Executor of this method;if null a default one is used
Exception
public Bookmark GFrequency(String condition, Collection variables, Collection weights, String format, String filter) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
-
Exception
public String GFrequency(String condition, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
public Bookmark Breakdown(String condition, Variable dependent, Variable independent, Collection weights, String format, String filter) throws Exception
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 OPERATORSdependent
- 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
-
Exception
public String Breakdown(String condition, Variable dependent, Variable independent, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSdependent
- 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
Exception
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
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 OPERATORSdependent
- 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 XMLpin
- 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
-
Exception
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
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 OPERATORSdependent
- 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 XMLpin
- 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
Exception
public Bookmark Tabulation(String condition, Collection variables, Collection weights, String format, String filter) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
-
Exception
public String Tabulation(String condition, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
public Bookmark XBreak(String condition, Collection variables, Collection weights, String format, String filter) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
-
Exception
public String XBreak(String condition, Collection variables, Collection weights, String format, String filter, BasicExecutorLog log) throws Exception
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 OPERATORSvariables
- The list of variables.weights
- The output format.<br/>It can be NESSTAR or XMLformat
- 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
Exception
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.
to
- The object to which the paths lead.
Exception
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.
to
- The object to which the paths lead.log
- the Executor of this method;if null a default one is used
Exception
public Bookmark Download(String variables, String cases, String format) throws Exception
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 OPERATORScases
- format
-
Exception
public URL Download(String variables, String cases, String format, BasicExecutorLog log) throws Exception
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 OPERATORScases
- format
- log
- the Executor of this method;if null a default one is used
Exception
|
Nesstar SDK | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |