nesstar.api.faster
Class Variable2

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

All Implemented Interfaces:

Comparable, RDFObj

public class Variable2
extends Variable

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

Variable2(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_endPos()
String	get_extNotesRole()
String	get_extNotesTitle()
String	get_extNotesURI()
String	get_numCats()
String	get_syntax()
String	get_width()
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
Integer	getEndPos() End position of variable in data file
String	getExtNotesRole() Role of external link containing variable notes
String[]	getExtNotesTitle() Title of external link containing variable notes
String	getExtNotesTitleAsString()
String[]	getExtNotesURI() An external link containing variable notes
String	getExtNotesURIAsString()
static Collection	getGetterMethods()
static SimpleVariable	getInstance(RDFDB db, URL id) If an object of type Variable2 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)
Integer	getNumCats() Number of category statistics belonging to this variable
static Collection	getPartsDescriptor()
String	getSyntax() Represents the sintax used for defining the expression
Integer	getWidth() Width of variable in data file
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
static SimpleVariable	retrieve(URL id) If an object of type Variable2 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_endPos(String endPos)
void	set_extNotesRole(String extNotesRole)
void	set_extNotesTitle(String extNotesTitle)
void	set_extNotesURI(String extNotesURI)
void	set_numCats(String numCats)
void	set_syntax(String syntax)
void	set_width(String width)
void	setEndPos(Integer endPos) End position of variable in data file
void	setExtNotesRole(String extNotesRole) Role of external link containing variable notes
void	setExtNotesTitle(String[] extNotesTitle) Title of external link containing variable notes
void	setExtNotesURI(String[] extNotesURI) An external link containing variable notes
void	setNumCats(Integer numCats) Number of category statistics belonging to this variable
void	setSyntax(String syntax) Represents the sintax used for defining the expression
void	setWidth(Integer width) Width of variable in data file

Methods inherited from class nesstar.api.faster.Variable

get_additivity, get_concept, get_datafile, get_decimalPlaces, get_expression, get_factsheets, get_format, get_formatSchema, get_geogr, get_groups, get_instructions, get_interviewerInstr, get_intervl, get_isKey, get_isWeight, get_max, get_maxValue, get_mean, get_meanValue, get_measures, get_median, get_medianValue, get_min, get_minValue, get_missingValues, get_mode, get_modeValue, get_name, get_nature, get_noInvalidResponses, get_noResponses, get_notes, get_noValidResponses, get_origin, get_position, get_postQuestionText, get_preQuestionText, get_questionText, get_scale, get_section, get_sections, get_source, get_startPos, get_statistics, get_std, get_stdValue, get_study, get_tables, get_universe, get_valRangeMax, get_valRangeMin, get_varID, get_weightVariable, get_weightVariables, getAdditivity, getConcept, getConceptAsString, getDatafile, getDecimalPlaces, getExpression, getFactsheets, getFormat, getFormatSchema, getGeogr, getGroups, getInstructions, getInterviewerInstr, getIntervl, getIsKey, getIsWeight, getMax, getMaxValue, getMean, getMeanValue, getMeasures, getMedian, getMedianValue, getMin, getMinValue, getMissingValues, getMode, getModeValue, getName, getNature, getNoInvalidResponses, getNoResponses, getNotes, getNoValidResponses, getOrigin, getPosition, getPostQuestionText, getPreQuestionText, getQuestionText, getScale, getSection, getSections, getSource, getStartPos, getStatistics, getStd, getStdValue, getStudy, getTables, getUniverse, getValRangeMax, getValRangeMin, getVarID, getWeightVariable, getWeightVariables, Remove, Remove, set_additivity, set_concept, set_datafile, set_decimalPlaces, set_expression, set_factsheets, set_format, set_formatSchema, set_geogr, set_groups, set_instructions, set_interviewerInstr, set_intervl, set_isKey, set_isWeight, set_max, set_maxValue, set_mean, set_meanValue, set_measures, set_median, set_medianValue, set_min, set_minValue, set_missingValues, set_mode, set_modeValue, set_name, set_nature, set_noInvalidResponses, set_noResponses, set_notes, set_noValidResponses, set_origin, set_position, set_postQuestionText, set_preQuestionText, set_questionText, set_scale, set_section, set_sections, set_source, set_startPos, set_statistics, set_std, set_stdValue, set_study, set_tables, set_universe, set_valRangeMax, set_valRangeMin, set_varID, set_weightVariable, set_weightVariables, setAdditivity, setConcept, setDatafile, setDecimalPlaces, setExpression, setFactsheets, setFormat, setFormatSchema, setGeogr, setGroups, setInstructions, setInterviewerInstr, setIntervl, setIsKey, setIsWeight, setMax, setMaxValue, setMean, setMeanValue, setMeasures, setMedian, setMedianValue, setMin, setMinValue, setMissingValues, setMode, setModeValue, setName, setNature, setNoInvalidResponses, setNoResponses, setNotes, setNoValidResponses, setOrigin, setPosition, setPostQuestionText, setPreQuestionText, setQuestionText, setScale, setSection, setSections, setSource, setStartPos, setStatistics, setStd, setStdValue, setStudy, setTables, setUniverse, setValRangeMax, setValRangeMin, setVarID, setWeightVariable, setWeightVariables

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

Variable2

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

setEndPos

public void setEndPos(Integer endPos)

End position of variable in data file

Parameters:

endPos -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location EndPos>

set_endPos

public void set_endPos(String endPos)

Parameters:

endPos -

setWidth

public void setWidth(Integer width)

Width of variable in data file

Parameters:

width -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location width>

set_width

public void set_width(String width)

Parameters:

width -

setSyntax

public void setSyntax(String syntax)

Represents the sintax used for defining the expression

Parameters:

syntax -

This property stores the contents of the DDI field:

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

set_syntax

public void set_syntax(String syntax)

Parameters:

syntax -

setNumCats

public void setNumCats(Integer numCats)

Number of category statistics belonging to this variable

Parameters:

numCats -

set_numCats

public void set_numCats(String numCats)

Parameters:

numCats -

setExtNotesURI

public void setExtNotesURI(String[] extNotesURI)

An external link containing variable notes

Parameters:

extNotesURI -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink URI>

set_extNotesURI

public void set_extNotesURI(String extNotesURI)

Parameters:

extNotesURI -

setExtNotesTitle

public void setExtNotesTitle(String[] extNotesTitle)

Title of external link containing variable notes

Parameters:

extNotesTitle -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink title>

set_extNotesTitle

public void set_extNotesTitle(String extNotesTitle)

Parameters:

extNotesTitle -

setExtNotesRole

public void setExtNotesRole(String extNotesRole)

Role of external link containing variable notes

Parameters:

extNotesRole -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink role>

set_extNotesRole

public void set_extNotesRole(String extNotesRole)

Parameters:

extNotesRole -

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

getEndPos

public Integer getEndPos()

End position of variable in data file

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location EndPos>

get_endPos

public String get_endPos()
                  throws Exception

Throws:

Exception

getWidth

public Integer getWidth()

Width of variable in data file

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><location width>

get_width

public String get_width()
                 throws Exception

Throws:

Exception

getSyntax

public String getSyntax()

Represents the sintax used for defining the expression

This property stores the contents of the DDI field:

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

get_syntax

public String get_syntax()
                  throws Exception

Throws:

Exception

getNumCats

public Integer getNumCats()

Number of category statistics belonging to this variable

get_numCats

public String get_numCats()
                   throws Exception

Throws:

Exception

getExtNotesURI

public String[] getExtNotesURI()

An external link containing variable notes

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink URI>

getExtNotesURIAsString

public String getExtNotesURIAsString()

get_extNotesURI

public String get_extNotesURI()
                       throws Exception

Throws:

Exception

getExtNotesTitle

public String[] getExtNotesTitle()

Title of external link containing variable notes

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink title>

getExtNotesTitleAsString

public String getExtNotesTitleAsString()

get_extNotesTitle

public String get_extNotesTitle()
                         throws Exception

Throws:

Exception

getExtNotesRole

public String getExtNotesRole()

Role of external link containing variable notes

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><notes><ExtLink role>

get_extNotesRole

public String get_extNotesRole()
                        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 Variable

retrieve

public static SimpleVariable retrieve(URL id)
                               throws Exception

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