nesstar.api.faster
Class Section

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.faster.Section
All Implemented Interfaces:
Comparable, RDFObj

public class Section
extends RDFObject

The 'comment' property is derived from the DDI field:
<codeBook><dataDscr><varGrp name>
The 'label' property is derived from the DDI field:
<codeBook><dataDscr><varGrp><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
Section(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_concept()
           
 String get_definition()
           
 String get_name()
           
 String get_notes()
           
 RDFRef get_section()
           
 RDFRef get_study()
           
 RDFRef get_subSections()
           
 String get_universe()
           
 RDFRef get_variables()
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 String getComment()
           Lengthier description of variable group.
 String[] getConcept()
           List of Concepts.
 String getConceptAsString()
           
 String getDefinition()
           Rationale for why the variables are grouped in this way.
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 Section getInstance(RDFDB db, URL id)
          If an object of type Section with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Section getInstance(String rdf)
           
 String getName()
           The unique ID for the group.
 String getNotes()
           For clarifying information/annotation regarding the variable groups.
static Collection getPartsDescriptor()
           
 Section getSection()
           
 Study getStudy()
           
 List getSubSections()
           
 String getUniverse()
           A description of the population covered by the data in the file
 List getVariables()
           
 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 Section newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
static Section retrieve(URL id)
          If an object of type Section 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_concept(String concept)
           
 void set_definition(String definition)
           
 void set_name(String name)
           
 void set_notes(String notes)
           
 void set_section(RDFRef section)
           
 void set_study(RDFRef study)
           
 void set_subSections(RDFRef subSections)
           
 void set_universe(String universe)
           
 void set_variables(RDFRef variables)
           
 void setConcept(String[] concept)
           List of Concepts.
 void setDefinition(String definition)
           Rationale for why the variables are grouped in this way.
 void setName(String name)
           The unique ID for the group.
 void setNotes(String notes)
           For clarifying information/annotation regarding the variable groups.
 void setSection(Section section)
           
 void setStudy(Study study)
           
 void setSubSections(List subSections)
           
 void setUniverse(String universe)
           A description of the population covered by the data in the file
 void setVariables(List variables)
           
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, 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, 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

Section

public Section(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_variables

public void set_variables(RDFRef variables)
Parameters:
variables -

setVariables

public void setVariables(List variables)
                  throws Exception
Parameters:
variables -
Throws:
Exception

set_section

public void set_section(RDFRef section)
Parameters:
section -

setSection

public void setSection(Section section)
                throws Exception
Parameters:
section -
Throws:
Exception

set_subSections

public void set_subSections(RDFRef subSections)
Parameters:
subSections -

setSubSections

public void setSubSections(List subSections)
                    throws Exception
Parameters:
subSections -
Throws:
Exception

set_study

public void set_study(RDFRef study)
Parameters:
study -

setStudy

public void setStudy(Study study)
              throws Exception
Parameters:
study -
Throws:
Exception

setUniverse

public void setUniverse(String universe)

A description of the population covered by the data in the file

Parameters:
universe -
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><universe>

set_universe

public void set_universe(String universe)
Parameters:
universe -

setName

public void setName(String name)

The unique ID for the group.

Parameters:
name -
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp name>

set_name

public void set_name(String name)
Parameters:
name -

setDefinition

public void setDefinition(String definition)

Rationale for why the variables are grouped in this way.

Parameters:
definition -
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><defntn>

set_definition

public void set_definition(String definition)
Parameters:
definition -

setNotes

public void setNotes(String notes)

For clarifying information/annotation regarding the variable groups.

Parameters:
notes -
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><notes>

set_notes

public void set_notes(String notes)
Parameters:
notes -

setConcept

public void setConcept(String[] concept)

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

Parameters:
concept -
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><concept>

set_concept

public void set_concept(String concept)
Parameters:
concept -

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 Section getInstance(RDFDB db,
                                  URL id)
                           throws Exception
If an object of type Section 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 Section 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_variables

public RDFRef get_variables()
                     throws Exception
Throws:
Exception

getVariables

public List getVariables()
                  throws Exception
Returns:
Throws:
Exception

get_section

public RDFRef get_section()
                   throws Exception
Throws:
Exception

getSection

public Section getSection()
Returns:

get_subSections

public RDFRef get_subSections()
                       throws Exception
Throws:
Exception

getSubSections

public List getSubSections()
                    throws Exception
Returns:
Throws:
Exception

get_study

public RDFRef get_study()
                 throws Exception
Throws:
Exception

getStudy

public Study getStudy()
Returns:

getComment

public String getComment()

Lengthier description of variable group.

Overrides:
getComment in class RDFObject
Returns:
the comment
This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><txt>

getUniverse

public String getUniverse()

A description of the population covered by the data in the file

This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><universe>

get_universe

public String get_universe()
                    throws Exception
Throws:
Exception

getName

public String getName()

The unique ID for the group.

This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp name>

get_name

public String get_name()
                throws Exception
Throws:
Exception

getDefinition

public String getDefinition()

Rationale for why the variables are grouped in this way.

This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><defntn>

get_definition

public String get_definition()
                      throws Exception
Throws:
Exception

getNotes

public String getNotes()

For clarifying information/annotation regarding the variable groups.

This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><notes>

get_notes

public String get_notes()
                 throws Exception
Throws:
Exception

getConcept

public String[] getConcept()

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

This property stores the contents of the DDI field:
<codeBook><dataDscr><varGrp><concept>

getConceptAsString

public String getConceptAsString()

get_concept

public String get_concept()
                   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 Section newInstance(RDFDB db)
                           throws Exception
Create a new object of this type with a locally unique id and returns it

Parameters:
db - the db where the object is to be found or created
Returns:
an object of this type
Throws:
Exception

listenForNewObj

public static void listenForNewObj(NewObjListener listener)
Register to be notified when new objects are added.

Parameters:
listener - the listener

initialised

public void initialised()
Notify that the object has been created and its properties setup for the first time. This is NOT called when the object is simply reloaded.

Overrides:
initialised in class RDFObject

retrieve

public static Section retrieve(URL id)
                        throws Exception
If an object of type Section 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 Section with the indicated id
Throws:
Exception

clear

public void clear()
Description copied from class: RDFObject
Clear all properties of this object

Overrides:
clear in class RDFObject

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved