nesstar.api.faster
Class Variable

java.lang.Object
  java.util.Observable
      nesstar.rdf.RDFObject
          nesstar.api.faster.SimpleVariable
              nesstar.api.faster.Variable

All Implemented Interfaces:

Comparable, RDFObj

Direct Known Subclasses:

Variable2

public class Variable
extends SimpleVariable

A variable in a study, either a primary variable or a derived variable.

A primary variable is created when a study is published on the server by providing its DDI description and possibly its data.

Primary variables are always part of a Section (DDI variable group). If the variable group is not specified in the DDI the variable is added to a default Section (with ID="...").

Derived variables are added by users after the study has been published.

Derived variables are calculated on the base of a formula, specified in the "expression" attribute, that can contain references to other primary or derived variables from the same study.

Derived variables are not part of any section.

Derived variables can be used in any statistical operation that accept variables (except Subset/Download).

Note that derived variable will have only their label, expression and possibly comment fields set. All other fields are set to null.

The 'label' property is derived from the DDI field:

<codeBook><dataDscr><var><labl>

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

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

Method Summary

void	clear() Clear all properties of this object
String	get_additivity()
String	get_concept()
RDFRef	get_datafile()
String	get_decimalPlaces()
String	get_expression()
RDFRef	get_factsheets()
String	get_format()
String	get_formatSchema()
String	get_geogr()
RDFRef	get_groups()
String	get_instructions()
String	get_interviewerInstr()
String	get_intervl()
String	get_isKey()
String	get_isWeight()
String	get_max()
String	get_maxValue()
String	get_mean()
String	get_meanValue()
RDFRef	get_measures()
String	get_median()
String	get_medianValue()
String	get_min()
String	get_minValue()
String	get_missingValues()
String	get_mode()
String	get_modeValue()
String	get_name()
String	get_nature()
String	get_noInvalidResponses()
String	get_noResponses()
String	get_notes()
String	get_noValidResponses()
String	get_origin()
String	get_position()
String	get_postQuestionText()
String	get_preQuestionText()
String	get_questionText()
String	get_scale()
RDFRef	get_section()
RDFRef	get_sections()
String	get_source()
String	get_startPos()
RDFRef	get_statistics()
String	get_std()
String	get_stdValue()
RDFRef	get_study()
RDFRef	get_tables()
String	get_universe()
String	get_valRangeMax()
String	get_valRangeMin()
String	get_varID()
RDFRef	get_weightVariable()
RDFRef	get_weightVariables()
String	getAdditivity()
static Vector	getAllInstances()
static Vector	getAllInstances(RDFDB db)
String[]	getConcept() List of Concepts.
String	getConceptAsString()
Datafile	getDatafile()
Integer	getDecimalPlaces() Number of decimal places
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
String	getExpression() If this variable is derived from other variables this field contains the expression used to calculate the variable.
List	getFactsheets()
String	getFormat() eg Float, Integer
String	getFormatSchema() eg SPSS, SAS
String	getGeogr()
static Collection	getGetterMethods()
List	getGroups()
static SimpleVariable	getInstance(RDFDB db, URL id) If an object of type Variable with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static SimpleVariable	getInstance(String rdf)
String	getInstructions() Instructions to Interviewer
String	getInterviewerInstr() Specific instructions to the individual conducting an interview.
String	getIntervl() discrete/continuous
Boolean	getIsKey() Is this variable a key in a hierarchy?
Boolean	getIsWeight() Whether the variable is a weight.
Double	getMax() Deprecated. replaced by MaxValue
Double	getMaxValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
Double	getMean() Deprecated. replaced by MeanValue
Double	getMeanValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
List	getMeasures()
Double	getMedian() Deprecated. replaced by MedianValue
Double	getMedianValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
Double	getMin() Deprecated. replaced by MinValue
Double	getMinValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
String	getMissingValues() List of missing/invalid values
Double	getMode() Deprecated. replaced by ModeValue
Double	getModeValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
String	getName() Name of variable
String	getNature()
Integer	getNoInvalidResponses() Number of invalid responses
String	getNoResponses() Total Number of Responses
String	getNotes() Brief notes on variable
Integer	getNoValidResponses() Number of Valid Responses
String	getOrigin()
static Collection	getPartsDescriptor()
Integer	getPosition() Represents the ordinal position of a variable in the ddi xml.
String	getPostQuestionText() Text describing what occurs after the literal question has been asked.
String	getPreQuestionText() Text describing a set of conditions under which a question might be asked.
String	getQuestionText() Text of the actual, literal question asked.
String	getScale()
Section	getSection()
List	getSections()
String	getSource() Source for this variable
Integer	getStartPos() Start position of variable in data file
List	getStatistics()
Double	getStd() Deprecated. replaced by stdValue
Double	getStdValue() Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
Study	getStudy()
List	getTables()
String	getUniverse() Population for this variable
Double	getValRangeMax() Maximum value in range
Double	getValRangeMin() Minimum value in range
String	getVarID() Position of variable in dataset (local ID)
Variable	getWeightVariable()
List	getWeightVariables()
void	initialised() Notify that the object has been created and its properties setup for the first time.
static void	listenForNewObj(NewObjListener listener) Register to be notified when new objects are added.
static SimpleVariable	newInstance(RDFDB db) Create a new object of this type with a locally unique id and returns it
Bookmark	Remove() Remove this derived variable.
void	Remove(BasicExecutorLog log) Remove this derived variable.
static SimpleVariable	retrieve(URL id) If an object of type Variable 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_additivity(String additivity)
void	set_concept(String concept)
void	set_datafile(RDFRef datafile)
void	set_decimalPlaces(String decimalPlaces)
void	set_expression(String expression)
void	set_factsheets(RDFRef factsheets)
void	set_format(String format)
void	set_formatSchema(String formatSchema)
void	set_geogr(String geogr)
void	set_groups(RDFRef groups)
void	set_instructions(String instructions)
void	set_interviewerInstr(String interviewerInstr)
void	set_intervl(String intervl)
void	set_isKey(String isKey)
void	set_isWeight(String isWeight)
void	set_max(String max)
void	set_maxValue(String maxValue)
void	set_mean(String mean)
void	set_meanValue(String meanValue)
void	set_measures(RDFRef measures)
void	set_median(String median)
void	set_medianValue(String medianValue)
void	set_min(String min)
void	set_minValue(String minValue)
void	set_missingValues(String missingValues)
void	set_mode(String mode)
void	set_modeValue(String modeValue)
void	set_name(String name)
void	set_nature(String nature)
void	set_noInvalidResponses(String noInvalidResponses)
void	set_noResponses(String noResponses)
void	set_notes(String notes)
void	set_noValidResponses(String noValidResponses)
void	set_origin(String origin)
void	set_position(String position)
void	set_postQuestionText(String postQuestionText)
void	set_preQuestionText(String preQuestionText)
void	set_questionText(String questionText)
void	set_scale(String scale)
void	set_section(RDFRef section)
void	set_sections(RDFRef sections)
void	set_source(String source)
void	set_startPos(String startPos)
void	set_statistics(RDFRef statistics)
void	set_std(String std)
void	set_stdValue(String stdValue)
void	set_study(RDFRef study)
void	set_tables(RDFRef tables)
void	set_universe(String universe)
void	set_valRangeMax(String valRangeMax)
void	set_valRangeMin(String valRangeMin)
void	set_varID(String varID)
void	set_weightVariable(RDFRef weightVariable)
void	set_weightVariables(RDFRef weightVariables)
void	setAdditivity(String additivity)
void	setConcept(String[] concept) List of Concepts.
void	setDatafile(Datafile datafile)
void	setDecimalPlaces(Integer decimalPlaces) Number of decimal places
void	setExpression(String expression) If this variable is derived from other variables this field contains the expression used to calculate the variable.
void	setFactsheets(List factsheets)
void	setFormat(String format) eg Float, Integer
void	setFormatSchema(String formatSchema) eg SPSS, SAS
void	setGeogr(String geogr)
void	setGroups(List groups)
void	setInstructions(String instructions) Instructions to Interviewer
void	setInterviewerInstr(String interviewerInstr) Specific instructions to the individual conducting an interview.
void	setIntervl(String intervl) discrete/continuous
void	setIsKey(Boolean isKey) Is this variable a key in a hierarchy?
void	setIsWeight(Boolean isWeight) Whether the variable is a weight.
void	setMax(Double max) Deprecated. replaced by MaxValue
void	setMaxValue(Double maxValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setMean(Double mean) Deprecated. replaced by MeanValue
void	setMeanValue(Double meanValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setMeasures(List measures)
void	setMedian(Double median) Deprecated. replaced by MedianValue
void	setMedianValue(Double medianValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setMin(Double min) Deprecated. replaced by MinValue
void	setMinValue(Double minValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setMissingValues(String missingValues) List of missing/invalid values
void	setMode(Double mode) Deprecated. replaced by ModeValue
void	setModeValue(Double modeValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setName(String name) Name of variable
void	setNature(String nature)
void	setNoInvalidResponses(Integer noInvalidResponses) Number of invalid responses
void	setNoResponses(String noResponses) Total Number of Responses
void	setNotes(String notes) Brief notes on variable
void	setNoValidResponses(Integer noValidResponses) Number of Valid Responses
void	setOrigin(String origin)
void	setPosition(Integer position) Represents the ordinal position of a variable in the ddi xml.
void	setPostQuestionText(String postQuestionText) Text describing what occurs after the literal question has been asked.
void	setPreQuestionText(String preQuestionText) Text describing a set of conditions under which a question might be asked.
void	setQuestionText(String questionText) Text of the actual, literal question asked.
void	setScale(String scale)
void	setSection(Section section)
void	setSections(List sections)
void	setSource(String source) Source for this variable
void	setStartPos(Integer startPos) Start position of variable in data file
void	setStatistics(List statistics)
void	setStd(Double std) Deprecated. replaced by stdValue
void	setStdValue(Double stdValue) Statistical measures which describe the responses to a particular variable and may include one or more standard summaries
void	setStudy(Study study)
void	setTables(List tables)
void	setUniverse(String universe) Population for this variable
void	setValRangeMax(Double valRangeMax) Maximum value in range
void	setValRangeMin(Double valRangeMin) Minimum value in range
void	setVarID(String varID) Position of variable in dataset (local ID)
void	setWeightVariable(Variable weightVariable)
void	setWeightVariables(List weightVariables)

Methods inherited from class nesstar.api.faster.SimpleVariable

set

Methods inherited from class nesstar.rdf.RDFObject

AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, 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

Variable

public Variable(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_sections

public void set_sections(RDFRef sections)

Parameters:

sections -

setSections

public void setSections(List sections)
                 throws Exception

Parameters:

sections -

Throws:

Exception

set_measures

public void set_measures(RDFRef measures)

Parameters:

measures -

setMeasures

public void setMeasures(List measures)
                 throws Exception

Parameters:

measures -

Throws:

Exception

set_statistics

public void set_statistics(RDFRef statistics)

Parameters:

statistics -

setStatistics

public void setStatistics(List statistics)
                   throws Exception

Parameters:

statistics -

Throws:

Exception

set_study

public void set_study(RDFRef study)

Overrides:

set_study in class SimpleVariable

Parameters:

study -

setStudy

public void setStudy(Study study)
              throws Exception

Overrides:

setStudy in class SimpleVariable

Parameters:

study -

Throws:

Exception

set_datafile

public void set_datafile(RDFRef datafile)

Parameters:

datafile -

setDatafile

public void setDatafile(Datafile datafile)
                 throws Exception

Parameters:

datafile -

Throws:

Exception

set_groups

public void set_groups(RDFRef groups)

Parameters:

groups -

setGroups

public void setGroups(List groups)
               throws Exception

Parameters:

groups -

Throws:

Exception

set_factsheets

public void set_factsheets(RDFRef factsheets)

Parameters:

factsheets -

setFactsheets

public void setFactsheets(List factsheets)
                   throws Exception

Parameters:

factsheets -

Throws:

Exception

set_tables

public void set_tables(RDFRef tables)

Parameters:

tables -

setTables

public void setTables(List tables)
               throws Exception

Parameters:

tables -

Throws:

Exception

set_weightVariables

public void set_weightVariables(RDFRef weightVariables)

Parameters:

weightVariables -

setWeightVariables

public void setWeightVariables(List weightVariables)
                        throws Exception

Parameters:

weightVariables -

Throws:

Exception

set_section

public void set_section(RDFRef section)

Overrides:

set_section in class SimpleVariable

Parameters:

section -

setSection

public void setSection(Section section)
                throws Exception

Overrides:

setSection in class SimpleVariable

Parameters:

section -

Throws:

Exception

set_weightVariable

public void set_weightVariable(RDFRef weightVariable)

Parameters:

weightVariable -

setWeightVariable

public void setWeightVariable(Variable weightVariable)
                       throws Exception

Parameters:

weightVariable -

Throws:

Exception

setIsKey

public void setIsKey(Boolean isKey)

Is this variable a key in a hierarchy?

Parameters:

isKey -

set_isKey

public void set_isKey(String isKey)

Parameters:

isKey -

setIsWeight

public void setIsWeight(Boolean isWeight)

Whether the variable is a weight.

Parameters:

isWeight -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var wgt>

set_isWeight

public void set_isWeight(String isWeight)

Parameters:

isWeight -

setNoInvalidResponses

public void setNoInvalidResponses(Integer noInvalidResponses)

Number of invalid responses

Parameters:

noInvalidResponses -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=invd>

set_noInvalidResponses

public void set_noInvalidResponses(String noInvalidResponses)

Parameters:

noInvalidResponses -

setDecimalPlaces

public void setDecimalPlaces(Integer decimalPlaces)

Number of decimal places

Parameters:

decimalPlaces -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var dcml>

set_decimalPlaces

public void set_decimalPlaces(String decimalPlaces)

Parameters:

decimalPlaces -

setStartPos

public void setStartPos(Integer startPos)

Start position of variable in data file

Parameters:

startPos -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location StartPos>

set_startPos

public void set_startPos(String startPos)

Parameters:

startPos -

setName

public void setName(String name)

Name of variable

Parameters:

name -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var name>

set_name

public void set_name(String name)

Parameters:

name -

setMax

public void setMax(Double max)

Deprecated. replaced by MaxValue

Parameters:

max -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=max>

set_max

public void set_max(String max)

Parameters:

max -

setMean

public void setMean(Double mean)

Deprecated. replaced by MeanValue

Parameters:

mean -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mean>

set_mean

public void set_mean(String mean)

Parameters:

mean -

setMedian

public void setMedian(Double median)

Deprecated. replaced by MedianValue

Parameters:

median -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=medn>

set_median

public void set_median(String median)

Parameters:

median -

setMin

public void setMin(Double min)

Deprecated. replaced by MinValue

Parameters:

min -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=min>

set_min

public void set_min(String min)

Parameters:

min -

setMode

public void setMode(Double mode)

Deprecated. replaced by ModeValue

Parameters:

mode -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mode>

set_mode

public void set_mode(String mode)

Parameters:

mode -

setStd

public void setStd(Double std)

Deprecated. replaced by stdValue

Parameters:

std -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=stdev>

set_std

public void set_std(String std)

Parameters:

std -

setValRangeMax

public void setValRangeMax(Double valRangeMax)

Maximum value in range

Parameters:

valRangeMax -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><valrng><range max>

set_valRangeMax

public void set_valRangeMax(String valRangeMax)

Parameters:

valRangeMax -

setValRangeMin

public void setValRangeMin(Double valRangeMin)

Minimum value in range

Parameters:

valRangeMin -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><valrng><range min>

set_valRangeMin

public void set_valRangeMin(String valRangeMin)

Parameters:

valRangeMin -

setNotes

public void setNotes(String notes)

Brief notes on variable

Overrides:

setNotes in class SimpleVariable

Parameters:

notes -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes>

set_notes

public void set_notes(String notes)

Overrides:

set_notes in class SimpleVariable

Parameters:

notes -

setQuestionText

public void setQuestionText(String questionText)

Text of the actual, literal question asked.

Overrides:

setQuestionText in class SimpleVariable

Parameters:

questionText -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><qstnLit>

set_questionText

public void set_questionText(String questionText)

Overrides:

set_questionText in class SimpleVariable

Parameters:

questionText -

setNoResponses

public void setNoResponses(String noResponses)

Total Number of Responses

Parameters:

noResponses -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><TotlResp>

set_noResponses

public void set_noResponses(String noResponses)

Parameters:

noResponses -

setInstructions

public void setInstructions(String instructions)

Instructions to Interviewer

Parameters:

instructions -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><ivuInstr>

set_instructions

public void set_instructions(String instructions)

Parameters:

instructions -

setUniverse

public void setUniverse(String universe)

Population for this variable

Parameters:

universe -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><universe>

set_universe

public void set_universe(String universe)

Parameters:

universe -

setAdditivity

public void setAdditivity(String additivity)

Parameters:

additivity -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var additivity>

set_additivity

public void set_additivity(String additivity)

Parameters:

additivity -

setNature

public void setNature(String nature)

Parameters:

nature -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var nature>

set_nature

public void set_nature(String nature)

Parameters:

nature -

setScale

public void setScale(String scale)

Parameters:

scale -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var scale>

set_scale

public void set_scale(String scale)

Parameters:

scale -

setOrigin

public void setOrigin(String origin)

Parameters:

origin -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var origin>

set_origin

public void set_origin(String origin)

Parameters:

origin -

setGeogr

public void setGeogr(String geogr)

Parameters:

geogr -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var geogr>

set_geogr

public void set_geogr(String geogr)

Parameters:

geogr -

setMissingValues

public void setMissingValues(String missingValues)

List of missing/invalid values

Parameters:

missingValues -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><invalrng><item VALUE>

set_missingValues

public void set_missingValues(String missingValues)

Parameters:

missingValues -

setIntervl

public void setIntervl(String intervl)

discrete/continuous

Parameters:

intervl -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var intrvl>

set_intervl

public void set_intervl(String intervl)

Parameters:

intervl -

setFormat

public void setFormat(String format)

eg Float, Integer

Parameters:

format -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><varFormat type>

set_format

public void set_format(String format)

Parameters:

format -

setFormatSchema

public void setFormatSchema(String formatSchema)

eg SPSS, SAS

Parameters:

formatSchema -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><varFormat schema>

set_formatSchema

public void set_formatSchema(String formatSchema)

Parameters:

formatSchema -

setVarID

public void setVarID(String varID)

Position of variable in dataset (local ID)

Parameters:

varID -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var ID>

set_varID

public void set_varID(String varID)

Parameters:

varID -

setSource

public void setSource(String source)

Source for this variable

Parameters:

source -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><txt>

set_source

public void set_source(String source)

Parameters:

source -

setNoValidResponses

public void setNoValidResponses(Integer noValidResponses)

Number of Valid Responses

Parameters:

noValidResponses -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=vald wgtd=not-wgtd>

set_noValidResponses

public void set_noValidResponses(String noValidResponses)

Parameters:

noValidResponses -

setMeanValue

public void setMeanValue(Double meanValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

meanValue -

This property replaces:

Mean

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mean>

set_meanValue

public void set_meanValue(String meanValue)

Parameters:

meanValue -

setMaxValue

public void setMaxValue(Double maxValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

maxValue -

This property replaces:

Max

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=max>

set_maxValue

public void set_maxValue(String maxValue)

Parameters:

maxValue -

setModeValue

public void setModeValue(Double modeValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

modeValue -

This property replaces:

Mode

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mode>

set_modeValue

public void set_modeValue(String modeValue)

Parameters:

modeValue -

setMedianValue

public void setMedianValue(Double medianValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

medianValue -

This property replaces:

Median

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=medn>

set_medianValue

public void set_medianValue(String medianValue)

Parameters:

medianValue -

setMinValue

public void setMinValue(Double minValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

minValue -

This property replaces:

Min

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=min>

set_minValue

public void set_minValue(String minValue)

Parameters:

minValue -

setStdValue

public void setStdValue(Double stdValue)

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

Parameters:

stdValue -

This property replaces:

std

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=stdev>

set_stdValue

public void set_stdValue(String stdValue)

Parameters:

stdValue -

setPosition

public void setPosition(Integer position)

Represents the ordinal position of a variable in the ddi xml. Starts from position 1.

Parameters:

position -

set_position

public void set_position(String position)

Parameters:

position -

setPreQuestionText

public void setPreQuestionText(String preQuestionText)

Text describing a set of conditions under which a question might be asked.

Parameters:

preQuestionText -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><preQTxt>

set_preQuestionText

public void set_preQuestionText(String preQuestionText)

Parameters:

preQuestionText -

setPostQuestionText

public void setPostQuestionText(String postQuestionText)

Text describing what occurs after the literal question has been asked.

Parameters:

postQuestionText -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><postQTxt>

set_postQuestionText

public void set_postQuestionText(String postQuestionText)

Parameters:

postQuestionText -

setInterviewerInstr

public void setInterviewerInstr(String interviewerInstr)

Specific instructions to the individual conducting an interview.

Parameters:

interviewerInstr -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><ivuInstr>

set_interviewerInstr

public void set_interviewerInstr(String interviewerInstr)

Parameters:

interviewerInstr -

setConcept

public void setConcept(String[] concept)

List of Concepts. The general subject to which this variable may be seen as pertaining.

Overrides:

setConcept in class SimpleVariable

Parameters:

concept -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><concept>

set_concept

public void set_concept(String concept)

Overrides:

set_concept in class SimpleVariable

Parameters:

concept -

setExpression

public void setExpression(String expression)

If this variable is derived from other variables this field contains the expression used to calculate the variable.

Parameters:

expression -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><derivation><drvcmd>

set_expression

public void set_expression(String expression)

Parameters:

expression -

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 SimpleVariable getInstance(RDFDB db,
                                         URL id)
                                  throws Exception

If an object of type Variable 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 SimpleVariable 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_sections

public RDFRef get_sections()
                    throws Exception

Throws:

Exception

getSections

public List getSections()
                 throws Exception

Returns:

Throws:

Exception

get_measures

public RDFRef get_measures()
                    throws Exception

Throws:

Exception

getMeasures

public List getMeasures()
                 throws Exception

Returns:

Throws:

Exception

get_statistics

public RDFRef get_statistics()
                      throws Exception

Throws:

Exception

getStatistics

public List getStatistics()
                   throws Exception

Returns:

Throws:

Exception

get_study

public RDFRef get_study()
                 throws Exception

Overrides:

get_study in class SimpleVariable

Throws:

Exception

getStudy

public Study getStudy()

Overrides:

getStudy in class SimpleVariable

Returns:

get_datafile

public RDFRef get_datafile()
                    throws Exception

Throws:

Exception

getDatafile

public Datafile getDatafile()

Returns:

get_groups

public RDFRef get_groups()
                  throws Exception

Throws:

Exception

getGroups

public List getGroups()
               throws Exception

Returns:

Throws:

Exception

get_factsheets

public RDFRef get_factsheets()
                      throws Exception

Throws:

Exception

getFactsheets

public List getFactsheets()
                   throws Exception

Returns:

Throws:

Exception

get_tables

public RDFRef get_tables()
                  throws Exception

Throws:

Exception

getTables

public List getTables()
               throws Exception

Returns:

Throws:

Exception

get_weightVariables

public RDFRef get_weightVariables()
                           throws Exception

Throws:

Exception

getWeightVariables

public List getWeightVariables()
                        throws Exception

Returns:

Throws:

Exception

get_section

public RDFRef get_section()
                   throws Exception

Overrides:

get_section in class SimpleVariable

Throws:

Exception

getSection

public Section getSection()

Overrides:

getSection in class SimpleVariable

Returns:

get_weightVariable

public RDFRef get_weightVariable()
                          throws Exception

Throws:

Exception

getWeightVariable

public Variable getWeightVariable()

Returns:

getIsKey

public Boolean getIsKey()

Is this variable a key in a hierarchy?

get_isKey

public String get_isKey()
                 throws Exception

Throws:

Exception

getIsWeight

public Boolean getIsWeight()

Whether the variable is a weight.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var wgt>

get_isWeight

public String get_isWeight()
                    throws Exception

Throws:

Exception

getNoInvalidResponses

public Integer getNoInvalidResponses()

Number of invalid responses

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=invd>

get_noInvalidResponses

public String get_noInvalidResponses()
                              throws Exception

Throws:

Exception

getDecimalPlaces

public Integer getDecimalPlaces()

Number of decimal places

This property stores the contents of the DDI field:

<codeBook><dataDscr><var dcml>

get_decimalPlaces

public String get_decimalPlaces()
                         throws Exception

Throws:

Exception

getStartPos

public Integer getStartPos()

Start position of variable in data file

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location StartPos>

get_startPos

public String get_startPos()
                    throws Exception

Throws:

Exception

getName

public String getName()

Name of variable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var name>

get_name

public String get_name()
                throws Exception

Throws:

Exception

getMax

public Double getMax()

Deprecated. replaced by MaxValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=max>

get_max

public String get_max()
               throws Exception

Throws:

Exception

getMean

public Double getMean()

Deprecated. replaced by MeanValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mean>

get_mean

public String get_mean()
                throws Exception

Throws:

Exception

getMedian

public Double getMedian()

Deprecated. replaced by MedianValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=medn>

get_median

public String get_median()
                  throws Exception

Throws:

Exception

getMin

public Double getMin()

Deprecated. replaced by MinValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=min>

get_min

public String get_min()
               throws Exception

Throws:

Exception

getMode

public Double getMode()

Deprecated. replaced by ModeValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mode>

get_mode

public String get_mode()
                throws Exception

Throws:

Exception

getStd

public Double getStd()

Deprecated. replaced by stdValue

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=stdev>

get_std

public String get_std()
               throws Exception

Throws:

Exception

getValRangeMax

public Double getValRangeMax()

Maximum value in range

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><valrng><range max>

get_valRangeMax

public String get_valRangeMax()
                       throws Exception

Throws:

Exception

getValRangeMin

public Double getValRangeMin()

Minimum value in range

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><valrng><range min>

get_valRangeMin

public String get_valRangeMin()
                       throws Exception

Throws:

Exception

getNotes

public String getNotes()

Brief notes on variable

Overrides:

getNotes in class SimpleVariable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes>

get_notes

public String get_notes()
                 throws Exception

Overrides:

get_notes in class SimpleVariable

Throws:

Exception

getQuestionText

public String getQuestionText()

Text of the actual, literal question asked.

Overrides:

getQuestionText in class SimpleVariable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><qstnLit>

get_questionText

public String get_questionText()
                        throws Exception

Overrides:

get_questionText in class SimpleVariable

Throws:

Exception

getNoResponses

public String getNoResponses()

Total Number of Responses

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><TotlResp>

get_noResponses

public String get_noResponses()
                       throws Exception

Throws:

Exception

getInstructions

public String getInstructions()

Instructions to Interviewer

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><ivuInstr>

get_instructions

public String get_instructions()
                        throws Exception

Throws:

Exception

getUniverse

public String getUniverse()

Population for this variable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><universe>

get_universe

public String get_universe()
                    throws Exception

Throws:

Exception

getAdditivity

public String getAdditivity()

This property stores the contents of the DDI field:

<codeBook><dataDscr><var additivity>

get_additivity

public String get_additivity()
                      throws Exception

Throws:

Exception

getNature

public String getNature()

This property stores the contents of the DDI field:

<codeBook><dataDscr><var nature>

get_nature

public String get_nature()
                  throws Exception

Throws:

Exception

getScale

public String getScale()

This property stores the contents of the DDI field:

<codeBook><dataDscr><var scale>

get_scale

public String get_scale()
                 throws Exception

Throws:

Exception

getOrigin

public String getOrigin()

This property stores the contents of the DDI field:

<codeBook><dataDscr><var origin>

get_origin

public String get_origin()
                  throws Exception

Throws:

Exception

getGeogr

public String getGeogr()

This property stores the contents of the DDI field:

<codeBook><dataDscr><var geogr>

get_geogr

public String get_geogr()
                 throws Exception

Throws:

Exception

getMissingValues

public String getMissingValues()

List of missing/invalid values

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><invalrng><item VALUE>

get_missingValues

public String get_missingValues()
                         throws Exception

Throws:

Exception

getIntervl

public String getIntervl()

discrete/continuous

This property stores the contents of the DDI field:

<codeBook><dataDscr><var intrvl>

get_intervl

public String get_intervl()
                   throws Exception

Throws:

Exception

getFormat

public String getFormat()

eg Float, Integer

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><varFormat type>

get_format

public String get_format()
                  throws Exception

Throws:

Exception

getFormatSchema

public String getFormatSchema()

eg SPSS, SAS

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><varFormat schema>

get_formatSchema

public String get_formatSchema()
                        throws Exception

Throws:

Exception

getVarID

public String getVarID()

Position of variable in dataset (local ID)

This property stores the contents of the DDI field:

<codeBook><dataDscr><var ID>

get_varID

public String get_varID()
                 throws Exception

Throws:

Exception

getSource

public String getSource()

Source for this variable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><txt>

get_source

public String get_source()
                  throws Exception

Throws:

Exception

getNoValidResponses

public Integer getNoValidResponses()

Number of Valid Responses

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=vald wgtd=not-wgtd>

get_noValidResponses

public String get_noValidResponses()
                            throws Exception

Throws:

Exception

getMeanValue

public Double getMeanValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

Mean

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mean>

get_meanValue

public String get_meanValue()
                     throws Exception

Throws:

Exception

getMaxValue

public Double getMaxValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

Max

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=max>

get_maxValue

public String get_maxValue()
                    throws Exception

Throws:

Exception

getModeValue

public Double getModeValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

Mode

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=mode>

get_modeValue

public String get_modeValue()
                     throws Exception

Throws:

Exception

getMedianValue

public Double getMedianValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

Median

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=medn>

get_medianValue

public String get_medianValue()
                       throws Exception

Throws:

Exception

getMinValue

public Double getMinValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

Min

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=min>

get_minValue

public String get_minValue()
                    throws Exception

Throws:

Exception

getStdValue

public Double getStdValue()

Statistical measures which describe the responses to a particular variable and may include one or more standard summaries

This property replaces:

std

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><sumStat type=stdev>

get_stdValue

public String get_stdValue()
                    throws Exception

Throws:

Exception

getPosition

public Integer getPosition()

Represents the ordinal position of a variable in the ddi xml. Starts from position 1.

get_position

public String get_position()
                    throws Exception

Throws:

Exception

getPreQuestionText

public String getPreQuestionText()

Text describing a set of conditions under which a question might be asked.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><preQTxt>

get_preQuestionText

public String get_preQuestionText()
                           throws Exception

Throws:

Exception

getPostQuestionText

public String getPostQuestionText()

Text describing what occurs after the literal question has been asked.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><postQTxt>

get_postQuestionText

public String get_postQuestionText()
                            throws Exception

Throws:

Exception

getInterviewerInstr

public String getInterviewerInstr()

Specific instructions to the individual conducting an interview.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><qstn><ivuInstr>

get_interviewerInstr

public String get_interviewerInstr()
                            throws Exception

Throws:

Exception

getConcept

public String[] getConcept()

List of Concepts. The general subject to which this variable may be seen as pertaining.

Overrides:

getConcept in class SimpleVariable

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><concept>

getConceptAsString

public String getConceptAsString()

Overrides:

getConceptAsString in class SimpleVariable

get_concept

public String get_concept()
                   throws Exception

Overrides:

get_concept in class SimpleVariable

Throws:

Exception

getExpression

public String getExpression()

If this variable is derived from other variables this field contains the expression used to calculate the variable.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><derivation><drvcmd>

get_expression

public String get_expression()
                      throws Exception

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

retrieve

public static SimpleVariable retrieve(URL id)
                               throws Exception

If an object of type Variable 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 Variable 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 SimpleVariable

Remove

public Bookmark Remove()
                throws Exception

Remove this derived variable.

Throws:

if - the variable is not derived or if there are other derived variables that depend on it.

Exception

Remove

public void Remove(BasicExecutorLog log)
            throws Exception

Remove this derived variable.

Parameters:

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

Throws:

if - the variable is not derived or if there are other derived variables that depend on it.

Exception