nesstar.api.faster
Class Study

java.lang.Object
  extended by java.util.Observable
      extended by nesstar.rdf.RDFObject
          extended by nesstar.api.Dataset
              extended by nesstar.api.DatasetEx
                  extended by nesstar.api.faster.Study
All Implemented Interfaces:
Comparable, RDFObj
Direct Known Subclasses:
Study2

public class Study
extends DatasetEx

A Study as described by the DDI standard. It extends Dataset and is extended by Study2.

To publish a Study (using the Java API):

- Create the Study object using StudyHome.AddStudy (this will also create all the objects that are parts of the study: Datafile, Section, Variable, etc.)

- Get the Study's Datafiles using getFiles() and add the data to the corresponding datafile using Datafile.AddDataFile(java.io.File)

For an example check NesstarTestCase.loadStudy(java.lang.String).

The last part of the 'ID' property is derived from the DDI field:
<codeBook ID>, <codeBook><stdyDscr><citation><titlStmt><IDNo> 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
Study(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_accessPlace()
           
 String get_analyticUnit()
           
 String get_collectionEnd()
           
 String get_collectionStart()
           
 String get_countryCode()
           
 RDFRef get_cubes()
           
 String get_dataCollector()
           
 String get_docAltTitl()
           
 String get_docAuthEntity()
           
 String get_docBiblCit()
           
 String get_docCopyright()
           
 String get_docEngTitle()
           
 String get_docProdDate()
           
 String get_docProducer()
           
 String get_docTitle()
           
 String get_engWeight()
           
 RDFRef get_factsheets()
           
 RDFRef get_files()
           
 String get_keywords()
           
 String get_nation()
           
 String get_numCubes()
           
 String get_periodEnd()
           
 String get_periodStart()
           
 String get_related()
           
 RDFRef get_sections()
           
 RDFRef get_series()
           
 String get_seriesName()
           
 String get_stdyAltTitl()
           
 String get_stdyAuthEntity()
           
 String get_stdyContact()
           
 String get_stdyContactAffiliation()
           
 String get_stdyContactEmail()
           
 String get_stdyContributor()
           
 String get_stdyCopyright()
           
 String get_stdyDataAppraisal()
           
 String get_stdyDataCollFreq()
           
 String get_stdyDepDate()
           
 String get_stdyID()
           
 String get_stdyParTitl()
           
 String get_stdyProdAgency()
           
 String get_stdyProdDate()
           
 String get_stdyProducer()
           
 String get_stdyProducerAbbr()
           
 String get_stdyStatus()
           
 String get_stdyVersion()
           
 String get_stdyVersionDate()
           
 String get_stdyVersionNotes()
           
 String get_stdyVersionResponsibility()
           
 String get_stdyVersionType()
           
 RDFRef get_tables()
           
 String get_topics()
           
 String get_universe()
           
 RDFRef get_variables()
           
 String get_weight()
           
 String getAccessPlace()
           Represents ...
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 String getAnalyticUnit()
          Analytic Unit eg household, family, individual
 Date getCollectionEnd()
           Contains the end date of when the data was collected.
 Date getCollectionStart()
           Contains the start date of when the data was collected.
 String getCountryCode()
          ISO 3166 Code of the country
 List getCubes()
           
 String getDataCollector()
           Collector of data
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 getDocAltTitl()
           The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
 String getDocAuthEntity()
           Author
 String getDocBiblCit()
           Bibliographic citation for document
 String getDocCopyright()
           Copyright statement for document
 String getDocEngTitle()
           English translation of title
 Date getDocProdDate()
           Date the data/documentation was produced (not archived).
 String getDocProducer()
           Producer of Document
 String getDocTitle()
           Title of document (original language)
 String getEngWeight()
           English translation of Weight.
 List getFactsheets()
           
 List getFiles()
           
static Collection getGetterMethods()
           
static Dataset getInstance(RDFDB db, URL id)
          If an object of type Study 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)
           
 String[] getKeywords()
           list of keywords
 String getKeywordsAsString()
           
 String getNation()
           Indicates the country or countries covered in the file.
 Integer getNumCubes()
           Number of cubes
static Collection getPartsDescriptor()
           
 Date getPeriodEnd()
           The end date of the time period to which the data refer.
 Date getPeriodStart()
           The start date of the time period to which the data refer.
 String getRelated()
          Deprecated. replaced by relatedTitle
 List getSections()
           
 Series getSeries()
           
 String getSeriesName()
           Name of series, if applicable
 String getStdyAltTitl()
           The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
 String getStdyAuthEntity()
           Author of study
 String[] getStdyContact()
           
 String[] getStdyContactAffiliation()
           
 String getStdyContactAffiliationAsString()
           
 String getStdyContactAsString()
           
 String[] getStdyContactEmail()
           
 String getStdyContactEmailAsString()
           
 String getStdyContributor()
           Give statements of responsibility not recorded in the title and statement of responsibility area.
 String getStdyCopyright()
           Copyright Statement of Study
 String getStdyDataAppraisal()
           
 String getStdyDataCollFreq()
           
 Date getStdyDepDate()
           Date that the data/documentation was deposited with the archive that originally received it.
 String getStdyID()
           ID of the study
 String getStdyParTitl()
           Parallel Title: Title translated into another language.
 String getStdyProdAgency()
           Producer Code
 Date getStdyProdDate()
           Date of production of study
 String getStdyProducer()
           producer
 String getStdyProducerAbbr()
           
 String getStdyStatus()
           Generally used to give the data archive's class or study status number, which indicates the processing status of the study.
 String getStdyVersion()
          File History information
 Date getStdyVersionDate()
           
 String getStdyVersionNotes()
           Also known as release or edition.
 String getStdyVersionResponsibility()
           
 String getStdyVersionType()
           
 List getTables()
           
 String getTopics()
          Deprecated. use subcat instead
 String[] getUniverse()
           Description of population
 String getUniverseAsString()
           
 List getVariables()
           
 String getWeight()
           Full description of use of weights in study
 Bookmark GetWeightVariables()
           
 List GetWeightVariables(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.
static Dataset newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
 Bookmark RangeQuery(String query, Integer startFrom, Integer maxHits, Boolean withPath)
           
 List RangeQuery(String query, Integer startFrom, Integer maxHits, Boolean withPath, BasicExecutorLog log)
           
static Dataset retrieve(URL id)
          If an object of type Study 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_accessPlace(String accessPlace)
           
 void set_analyticUnit(String analyticUnit)
           
 void set_collectionEnd(String collectionEnd)
           
 void set_collectionStart(String collectionStart)
           
 void set_countryCode(String countryCode)
           
 void set_cubes(RDFRef cubes)
           
 void set_dataCollector(String dataCollector)
           
 void set_docAltTitl(String docAltTitl)
           
 void set_docAuthEntity(String docAuthEntity)
           
 void set_docBiblCit(String docBiblCit)
           
 void set_docCopyright(String docCopyright)
           
 void set_docEngTitle(String docEngTitle)
           
 void set_docProdDate(String docProdDate)
           
 void set_docProducer(String docProducer)
           
 void set_docTitle(String docTitle)
           
 void set_engWeight(String engWeight)
           
 void set_factsheets(RDFRef factsheets)
           
 void set_files(RDFRef files)
           
 void set_keywords(String keywords)
           
 void set_nation(String nation)
           
 void set_numCubes(String numCubes)
           
 void set_periodEnd(String periodEnd)
           
 void set_periodStart(String periodStart)
           
 void set_related(String related)
           
 void set_sections(RDFRef sections)
           
 void set_series(RDFRef series)
           
 void set_seriesName(String seriesName)
           
 void set_stdyAltTitl(String stdyAltTitl)
           
 void set_stdyAuthEntity(String stdyAuthEntity)
           
 void set_stdyContact(String stdyContact)
           
 void set_stdyContactAffiliation(String stdyContactAffiliation)
           
 void set_stdyContactEmail(String stdyContactEmail)
           
 void set_stdyContributor(String stdyContributor)
           
 void set_stdyCopyright(String stdyCopyright)
           
 void set_stdyDataAppraisal(String stdyDataAppraisal)
           
 void set_stdyDataCollFreq(String stdyDataCollFreq)
           
 void set_stdyDepDate(String stdyDepDate)
           
 void set_stdyID(String stdyID)
           
 void set_stdyParTitl(String stdyParTitl)
           
 void set_stdyProdAgency(String stdyProdAgency)
           
 void set_stdyProdDate(String stdyProdDate)
           
 void set_stdyProducer(String stdyProducer)
           
 void set_stdyProducerAbbr(String stdyProducerAbbr)
           
 void set_stdyStatus(String stdyStatus)
           
 void set_stdyVersion(String stdyVersion)
           
 void set_stdyVersionDate(String stdyVersionDate)
           
 void set_stdyVersionNotes(String stdyVersionNotes)
           
 void set_stdyVersionResponsibility(String stdyVersionResponsibility)
           
 void set_stdyVersionType(String stdyVersionType)
           
 void set_tables(RDFRef tables)
           
 void set_topics(String topics)
           
 void set_universe(String universe)
           
 void set_variables(RDFRef variables)
           
 void set_weight(String weight)
           
 void setAccessPlace(String accessPlace)
           Represents ...
 void setAnalyticUnit(String analyticUnit)
          Analytic Unit eg household, family, individual
 void setCollectionEnd(Date collectionEnd)
           Contains the end date of when the data was collected.
 void setCollectionStart(Date collectionStart)
           Contains the start date of when the data was collected.
 void setCountryCode(String countryCode)
          ISO 3166 Code of the country
 void setCubes(List cubes)
           
 void setDataCollector(String dataCollector)
           Collector of data
 void setDocAltTitl(String docAltTitl)
           The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
 void setDocAuthEntity(String docAuthEntity)
           Author
 void setDocBiblCit(String docBiblCit)
           Bibliographic citation for document
 void setDocCopyright(String docCopyright)
           Copyright statement for document
 void setDocEngTitle(String docEngTitle)
           English translation of title
 void setDocProdDate(Date docProdDate)
           Date the data/documentation was produced (not archived).
 void setDocProducer(String docProducer)
           Producer of Document
 void setDocTitle(String docTitle)
           Title of document (original language)
 void setEngWeight(String engWeight)
           English translation of Weight.
 void setFactsheets(List factsheets)
           
 void setFiles(List files)
           
 void setKeywords(String[] keywords)
           list of keywords
 void setNation(String nation)
           Indicates the country or countries covered in the file.
 void setNumCubes(Integer numCubes)
           Number of cubes
 void setPeriodEnd(Date periodEnd)
           The end date of the time period to which the data refer.
 void setPeriodStart(Date periodStart)
           The start date of the time period to which the data refer.
 void setRelated(String related)
          Deprecated. replaced by relatedTitle
 void setSections(List sections)
           
 void setSeries(Series series)
           
 void setSeriesName(String seriesName)
           Name of series, if applicable
 void setStdyAltTitl(String stdyAltTitl)
           The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.
 void setStdyAuthEntity(String stdyAuthEntity)
           Author of study
 void setStdyContact(String[] stdyContact)
           
 void setStdyContactAffiliation(String[] stdyContactAffiliation)
           
 void setStdyContactEmail(String[] stdyContactEmail)
           
 void setStdyContributor(String stdyContributor)
           Give statements of responsibility not recorded in the title and statement of responsibility area.
 void setStdyCopyright(String stdyCopyright)
           Copyright Statement of Study
 void setStdyDataAppraisal(String stdyDataAppraisal)
           
 void setStdyDataCollFreq(String stdyDataCollFreq)
           
 void setStdyDepDate(Date stdyDepDate)
           Date that the data/documentation was deposited with the archive that originally received it.
 void setStdyID(String stdyID)
           ID of the study
 void setStdyParTitl(String stdyParTitl)
           Parallel Title: Title translated into another language.
 void setStdyProdAgency(String stdyProdAgency)
           Producer Code
 void setStdyProdDate(Date stdyProdDate)
           Date of production of study
 void setStdyProducer(String stdyProducer)
           producer
 void setStdyProducerAbbr(String stdyProducerAbbr)
           
 void setStdyStatus(String stdyStatus)
           Generally used to give the data archive's class or study status number, which indicates the processing status of the study.
 void setStdyVersion(String stdyVersion)
          File History information
 void setStdyVersionDate(Date stdyVersionDate)
           
 void setStdyVersionNotes(String stdyVersionNotes)
           Also known as release or edition.
 void setStdyVersionResponsibility(String stdyVersionResponsibility)
           
 void setStdyVersionType(String stdyVersionType)
           
 void setTables(List tables)
           
 void setTopics(String topics)
          Deprecated. use subcat instead
 void setUniverse(String[] universe)
           Description of population
 void setVariables(List variables)
           
 void setWeight(String weight)
           Full description of use of weights in study
 
Methods inherited from class nesstar.api.DatasetEx
dbg, getDataset, getDatasetURL, getDDI, getId, getProvider, getProviderURL, hasData, setDDI
 
Methods inherited from class nesstar.api.Dataset
AddDataFile, AddDataFile, Breakdown, Breakdown, Datalist, Datalist, Delete, Delete, Descriptive, Descriptive, FindDDIVariables, FindDDIVariables, Frequency, Frequency, get_abstractText, get_accessConditions, get_accessStatus, get_collMode, get_dataKind, get_distributionDate, get_distributor, get_geographicalCover, get_geographicalUnit, get_hasData, get_sampling, get_source, get_subcat, get_timeMeth, get_timePeriod, get_title, getAbstractText, getAccessConditions, getAccessStatus, getCollMode, getComment, getDataKind, GetDDI, GetDDI, GetDDISkeleton, GetDDISkeleton, GetDDIVariable, GetDDIVariable, getDistributionDate, getDistributor, getGeographicalCover, getGeographicalCoverAsString, getGeographicalUnit, getGeographicalUnitAsString, getHasData, getLabel, getSampling, getSamplingAsString, getSource, getSubcat, getSubcatAsString, getTimeMeth, getTimePeriod, getTitle, GFrequency, GFrequency, MultipleRegression, MultipleRegression, set_abstractText, set_accessConditions, set_accessStatus, set_collMode, set_dataKind, set_distributionDate, set_distributor, set_geographicalCover, set_geographicalUnit, set_hasData, set_sampling, set_source, set_subcat, set_timeMeth, set_timePeriod, set_title, setAbstractText, setAccessConditions, setAccessStatus, setCollMode, setDataKind, setDistributionDate, setDistributor, setGeographicalCover, setGeographicalUnit, setHasData, setSampling, setSource, setSubcat, setTimeMeth, setTimePeriod, setTitle, Subset, Subset, Tabulation, Tabulation, XBreak, XBreak
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, set, setComment, setComplete, setCreationDate, setDB, setHardOrSoft, setID, setLabel, setLastClear, SetProperty, setServer, SetStringProperty, setTimeoutInSecs, setTimestamp, setType, setTypeID, stale, toRDF, toRDFWrapped, toString, update
 
Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_ID

public static String CLASS_ID
Constructor Detail

Study

public Study(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_series

public void set_series(RDFRef series)
Parameters:
series -

setSeries

public void setSeries(Series series)
               throws Exception
Parameters:
series -
Throws:
Exception

set_files

public void set_files(RDFRef files)
Parameters:
files -

setFiles

public void setFiles(List files)
              throws Exception
Parameters:
files -
Throws:
Exception

set_cubes

public void set_cubes(RDFRef cubes)
Parameters:
cubes -

setCubes

public void setCubes(List cubes)
              throws Exception
Parameters:
cubes -
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_variables

public void set_variables(RDFRef variables)
Parameters:
variables -

setVariables

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

set_sections

public void set_sections(RDFRef sections)
Parameters:
sections -

setSections

public void setSections(List sections)
                 throws Exception
Parameters:
sections -
Throws:
Exception

setCollectionEnd

public void setCollectionEnd(Date collectionEnd)

Contains the end date of when the data was collected.

Parameters:
collectionEnd -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><collDate date event=end>

set_collectionEnd

public void set_collectionEnd(String collectionEnd)
Parameters:
collectionEnd -

setCollectionStart

public void setCollectionStart(Date collectionStart)

Contains the start date of when the data was collected.

Parameters:
collectionStart -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><collDate date event=start>

set_collectionStart

public void set_collectionStart(String collectionStart)
Parameters:
collectionStart -

setDocProdDate

public void setDocProdDate(Date docProdDate)

Date the data/documentation was produced (not archived).

Parameters:
docProdDate -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><prodDate date>

set_docProdDate

public void set_docProdDate(String docProdDate)
Parameters:
docProdDate -

setPeriodEnd

public void setPeriodEnd(Date periodEnd)

The end date of the time period to which the data refer.

Parameters:
periodEnd -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=end>

set_periodEnd

public void set_periodEnd(String periodEnd)
Parameters:
periodEnd -

setPeriodStart

public void setPeriodStart(Date periodStart)

The start date of the time period to which the data refer.

Parameters:
periodStart -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=start>

set_periodStart

public void set_periodStart(String periodStart)
Parameters:
periodStart -

setStdyDepDate

public void setStdyDepDate(Date stdyDepDate)

Date that the data/documentation was deposited with the archive that originally received it.

Parameters:
stdyDepDate -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><depDate date>

set_stdyDepDate

public void set_stdyDepDate(String stdyDepDate)
Parameters:
stdyDepDate -

setStdyProdDate

public void setStdyProdDate(Date stdyProdDate)

Date of production of study

Parameters:
stdyProdDate -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><prodDate date>

set_stdyProdDate

public void set_stdyProdDate(String stdyProdDate)
Parameters:
stdyProdDate -

setAccessPlace

public void setAccessPlace(String accessPlace)

Represents ...

Parameters:
accessPlace -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><dataAccs><setAvail><accsPlac>

set_accessPlace

public void set_accessPlace(String accessPlace)
Parameters:
accessPlace -

setAnalyticUnit

public void setAnalyticUnit(String analyticUnit)

Analytic Unit eg household, family, individual

Parameters:
analyticUnit -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><anlyUnit>

set_analyticUnit

public void set_analyticUnit(String analyticUnit)
Parameters:
analyticUnit -

setCountryCode

public void setCountryCode(String countryCode)

ISO 3166 Code of the country

Parameters:
countryCode -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><nation>

set_countryCode

public void set_countryCode(String countryCode)
Parameters:
countryCode -

setDataCollector

public void setDataCollector(String dataCollector)

Collector of data

Parameters:
dataCollector -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><dataCollector>

set_dataCollector

public void set_dataCollector(String dataCollector)
Parameters:
dataCollector -

setDocAuthEntity

public void setDocAuthEntity(String docAuthEntity)

Author

Parameters:
docAuthEntity -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><rspStmt><AuthEnty>

set_docAuthEntity

public void set_docAuthEntity(String docAuthEntity)
Parameters:
docAuthEntity -

setDocBiblCit

public void setDocBiblCit(String docBiblCit)

Bibliographic citation for document

Parameters:
docBiblCit -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><biblCit>

set_docBiblCit

public void set_docBiblCit(String docBiblCit)
Parameters:
docBiblCit -

setDocCopyright

public void setDocCopyright(String docCopyright)

Copyright statement for document

Parameters:
docCopyright -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><copyright>

set_docCopyright

public void set_docCopyright(String docCopyright)
Parameters:
docCopyright -

setDocEngTitle

public void setDocEngTitle(String docEngTitle)

English translation of title

Parameters:
docEngTitle -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><parTitl>

set_docEngTitle

public void set_docEngTitle(String docEngTitle)
Parameters:
docEngTitle -

setDocProducer

public void setDocProducer(String docProducer)

Producer of Document

Parameters:
docProducer -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><producer>

set_docProducer

public void set_docProducer(String docProducer)
Parameters:
docProducer -

setDocTitle

public void setDocTitle(String docTitle)

Title of document (original language)

Parameters:
docTitle -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><titl>

set_docTitle

public void set_docTitle(String docTitle)
Parameters:
docTitle -

setEngWeight

public void setEngWeight(String engWeight)

English translation of Weight.

Parameters:
engWeight -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><weight>

set_engWeight

public void set_engWeight(String engWeight)
Parameters:
engWeight -

setKeywords

public void setKeywords(String[] keywords)

list of keywords

Parameters:
keywords -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><subject><keyword>

set_keywords

public void set_keywords(String keywords)
Parameters:
keywords -

setRelated

public void setRelated(String related)
Deprecated. replaced by relatedTitle

Related material

Parameters:
related -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><titlStmt><titl>

set_related

public void set_related(String related)
Parameters:
related -

setSeriesName

public void setSeriesName(String seriesName)

Name of series, if applicable

Parameters:
seriesName -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><serStmt><serName>

set_seriesName

public void set_seriesName(String seriesName)
Parameters:
seriesName -

setStdyAuthEntity

public void setStdyAuthEntity(String stdyAuthEntity)

Author of study

Parameters:
stdyAuthEntity -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><rspStmt><AuthEnty>

set_stdyAuthEntity

public void set_stdyAuthEntity(String stdyAuthEntity)
Parameters:
stdyAuthEntity -

setStdyCopyright

public void setStdyCopyright(String stdyCopyright)

Copyright Statement of Study

Parameters:
stdyCopyright -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><copyright>

set_stdyCopyright

public void set_stdyCopyright(String stdyCopyright)
Parameters:
stdyCopyright -

setStdyID

public void setStdyID(String stdyID)

ID of the study

Parameters:
stdyID -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><IDNo>

set_stdyID

public void set_stdyID(String stdyID)
Parameters:
stdyID -

setStdyProdAgency

public void setStdyProdAgency(String stdyProdAgency)

Producer Code

Parameters:
stdyProdAgency -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer agency>

set_stdyProdAgency

public void set_stdyProdAgency(String stdyProdAgency)
Parameters:
stdyProdAgency -

setStdyProducer

public void setStdyProducer(String stdyProducer)

producer

Parameters:
stdyProducer -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer>

set_stdyProducer

public void set_stdyProducer(String stdyProducer)
Parameters:
stdyProducer -

setStdyVersion

public void setStdyVersion(String stdyVersion)

File History information

Parameters:
stdyVersion -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version>

set_stdyVersion

public void set_stdyVersion(String stdyVersion)
Parameters:
stdyVersion -

setTopics

public void setTopics(String topics)
Deprecated. use subcat instead

Topics covered

Parameters:
topics -

set_topics

public void set_topics(String topics)
Parameters:
topics -

setUniverse

public void setUniverse(String[] universe)

Description of population

Parameters:
universe -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><universe>

set_universe

public void set_universe(String universe)
Parameters:
universe -

setWeight

public void setWeight(String weight)

Full description of use of weights in study

Parameters:
weight -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><weight>

set_weight

public void set_weight(String weight)
Parameters:
weight -

setNumCubes

public void setNumCubes(Integer numCubes)

Number of cubes

Parameters:
numCubes -

set_numCubes

public void set_numCubes(String numCubes)
Parameters:
numCubes -

setStdyParTitl

public void setStdyParTitl(String stdyParTitl)

Parallel Title: Title translated into another language.

Parameters:
stdyParTitl -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><parTitl>

set_stdyParTitl

public void set_stdyParTitl(String stdyParTitl)
Parameters:
stdyParTitl -

setNation

public void setNation(String nation)

Indicates the country or countries covered in the file.

Parameters:
nation -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><nation>

set_nation

public void set_nation(String nation)
Parameters:
nation -

setStdyVersionNotes

public void setStdyVersionNotes(String stdyVersionNotes)

Also known as release or edition. If there have been substantive changes to the data/documentation/variable since its creation, this statement should be used.

Parameters:
stdyVersionNotes -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><notes>

set_stdyVersionNotes

public void set_stdyVersionNotes(String stdyVersionNotes)
Parameters:
stdyVersionNotes -

setStdyContributor

public void setStdyContributor(String stdyContributor)

Give statements of responsibility not recorded in the title and statement of responsibility area.

Parameters:
stdyContributor -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><rspStmt><othId><p>

set_stdyContributor

public void set_stdyContributor(String stdyContributor)
Parameters:
stdyContributor -

setStdyStatus

public void setStdyStatus(String stdyStatus)

Generally used to give the data archive's class or study status number, which indicates the processing status of the study.

Parameters:
stdyStatus -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><stdyClas>

set_stdyStatus

public void set_stdyStatus(String stdyStatus)
Parameters:
stdyStatus -

setStdyProducerAbbr

public void setStdyProducerAbbr(String stdyProducerAbbr)
Parameters:
stdyProducerAbbr -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer abbr>

set_stdyProducerAbbr

public void set_stdyProducerAbbr(String stdyProducerAbbr)
Parameters:
stdyProducerAbbr -

setStdyDataAppraisal

public void setStdyDataAppraisal(String stdyDataAppraisal)
Parameters:
stdyDataAppraisal -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><anlyInfo><dataAppr>

set_stdyDataAppraisal

public void set_stdyDataAppraisal(String stdyDataAppraisal)
Parameters:
stdyDataAppraisal -

setStdyContactAffiliation

public void setStdyContactAffiliation(String[] stdyContactAffiliation)
Parameters:
stdyContactAffiliation -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact affiliation>

set_stdyContactAffiliation

public void set_stdyContactAffiliation(String stdyContactAffiliation)
Parameters:
stdyContactAffiliation -

setStdyContactEmail

public void setStdyContactEmail(String[] stdyContactEmail)
Parameters:
stdyContactEmail -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact email>

set_stdyContactEmail

public void set_stdyContactEmail(String stdyContactEmail)
Parameters:
stdyContactEmail -

setStdyDataCollFreq

public void setStdyDataCollFreq(String stdyDataCollFreq)
Parameters:
stdyDataCollFreq -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><frequenc>

set_stdyDataCollFreq

public void set_stdyDataCollFreq(String stdyDataCollFreq)
Parameters:
stdyDataCollFreq -

setStdyVersionDate

public void setStdyVersionDate(Date stdyVersionDate)
Parameters:
stdyVersionDate -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version date>

set_stdyVersionDate

public void set_stdyVersionDate(String stdyVersionDate)
Parameters:
stdyVersionDate -

setStdyVersionType

public void setStdyVersionType(String stdyVersionType)
Parameters:
stdyVersionType -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version type>

set_stdyVersionType

public void set_stdyVersionType(String stdyVersionType)
Parameters:
stdyVersionType -

setStdyVersionResponsibility

public void setStdyVersionResponsibility(String stdyVersionResponsibility)
Parameters:
stdyVersionResponsibility -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><verResp>

set_stdyVersionResponsibility

public void set_stdyVersionResponsibility(String stdyVersionResponsibility)
Parameters:
stdyVersionResponsibility -

setStdyContact

public void setStdyContact(String[] stdyContact)
Parameters:
stdyContact -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact>

set_stdyContact

public void set_stdyContact(String stdyContact)
Parameters:
stdyContact -

setStdyAltTitl

public void setStdyAltTitl(String stdyAltTitl)

The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.

Parameters:
stdyAltTitl -
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><altTitl>

set_stdyAltTitl

public void set_stdyAltTitl(String stdyAltTitl)
Parameters:
stdyAltTitl -

setDocAltTitl

public void setDocAltTitl(String docAltTitl)

The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.

Parameters:
docAltTitl -
This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><altTitl>

set_docAltTitl

public void set_docAltTitl(String docAltTitl)
Parameters:
docAltTitl -

getAllInstances

public static Vector getAllInstances(RDFDB db)
                              throws Exception
Parameters:
db - the db where the instances are to be found
Returns:
all the instances of this class in the database
Throws:
Exception

getAllInstances

public static Vector getAllInstances()
                              throws Exception
Returns:
get all the instances of this class from the default database
Throws:
Exception

getInstance

public static Dataset getInstance(RDFDB db,
                                  URL id)
                           throws Exception
If an object of type Study with the indicated id exists in the db returns it otherwise create a new object in the db and returns it

Parameters:
db - the db where the object is to be found or created
id - the id of the object to retrieve or create
Returns:
an object of type Server with the indicated id and existing in the indicated db
Throws:
Exception

getInstance

public static Dataset getInstance(String rdf)
                           throws Exception
Parameters:
rdf - some rdf code that contains a description of an object of this kind
Returns:
the single instance of this class described in the passed RDF code
Throws:
Exception

get_series

public RDFRef get_series()
                  throws Exception
Throws:
Exception

getSeries

public Series getSeries()
Returns:

get_files

public RDFRef get_files()
                 throws Exception
Throws:
Exception

getFiles

public List getFiles()
              throws Exception
Returns:
the datafiles associated with this Study.
Throws:
Exception

get_cubes

public RDFRef get_cubes()
                 throws Exception
Throws:
Exception

getCubes

public List getCubes()
              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_variables

public RDFRef get_variables()
                     throws Exception
Throws:
Exception

getVariables

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

get_sections

public RDFRef get_sections()
                    throws Exception
Throws:
Exception

getSections

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

getCollectionEnd

public Date getCollectionEnd()

Contains the end date of when the data was collected.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><collDate date event=end>

get_collectionEnd

public String get_collectionEnd()
                         throws Exception
Throws:
Exception

getCollectionStart

public Date getCollectionStart()

Contains the start date of when the data was collected.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><collDate date event=start>

get_collectionStart

public String get_collectionStart()
                           throws Exception
Throws:
Exception

getDocProdDate

public Date getDocProdDate()

Date the data/documentation was produced (not archived).

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><prodDate date>

get_docProdDate

public String get_docProdDate()
                       throws Exception
Throws:
Exception

getPeriodEnd

public Date getPeriodEnd()

The end date of the time period to which the data refer.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=end>

get_periodEnd

public String get_periodEnd()
                     throws Exception
Throws:
Exception

getPeriodStart

public Date getPeriodStart()

The start date of the time period to which the data refer.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><timePrd date event=start>

get_periodStart

public String get_periodStart()
                       throws Exception
Throws:
Exception

getStdyDepDate

public Date getStdyDepDate()

Date that the data/documentation was deposited with the archive that originally received it.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><depDate date>

get_stdyDepDate

public String get_stdyDepDate()
                       throws Exception
Throws:
Exception

getStdyProdDate

public Date getStdyProdDate()

Date of production of study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><prodDate date>

get_stdyProdDate

public String get_stdyProdDate()
                        throws Exception
Throws:
Exception

getAccessPlace

public String getAccessPlace()

Represents ...

This property stores the contents of the DDI field:
<codeBook><stdyDscr><dataAccs><setAvail><accsPlac>

get_accessPlace

public String get_accessPlace()
                       throws Exception
Throws:
Exception

getAnalyticUnit

public String getAnalyticUnit()

Analytic Unit eg household, family, individual

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><anlyUnit>

get_analyticUnit

public String get_analyticUnit()
                        throws Exception
Throws:
Exception

getCountryCode

public String getCountryCode()

ISO 3166 Code of the country

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><nation>

get_countryCode

public String get_countryCode()
                       throws Exception
Throws:
Exception

getDataCollector

public String getDataCollector()

Collector of data

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><dataCollector>

get_dataCollector

public String get_dataCollector()
                         throws Exception
Throws:
Exception

getDocAuthEntity

public String getDocAuthEntity()

Author

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><rspStmt><AuthEnty>

get_docAuthEntity

public String get_docAuthEntity()
                         throws Exception
Throws:
Exception

getDocBiblCit

public String getDocBiblCit()

Bibliographic citation for document

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><biblCit>

get_docBiblCit

public String get_docBiblCit()
                      throws Exception
Throws:
Exception

getDocCopyright

public String getDocCopyright()

Copyright statement for document

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><copyright>

get_docCopyright

public String get_docCopyright()
                        throws Exception
Throws:
Exception

getDocEngTitle

public String getDocEngTitle()

English translation of title

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><parTitl>

get_docEngTitle

public String get_docEngTitle()
                       throws Exception
Throws:
Exception

getDocProducer

public String getDocProducer()

Producer of Document

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><prodStmt><producer>

get_docProducer

public String get_docProducer()
                       throws Exception
Throws:
Exception

getDocTitle

public String getDocTitle()

Title of document (original language)

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><titl>

get_docTitle

public String get_docTitle()
                    throws Exception
Throws:
Exception

getEngWeight

public String getEngWeight()

English translation of Weight.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><weight>

get_engWeight

public String get_engWeight()
                     throws Exception
Throws:
Exception

getKeywords

public String[] getKeywords()

list of keywords

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><subject><keyword>

getKeywordsAsString

public String getKeywordsAsString()

get_keywords

public String get_keywords()
                    throws Exception
Throws:
Exception

getRelated

public String getRelated()
Deprecated. replaced by relatedTitle

Related material

This property stores the contents of the DDI field:
<codeBook><stdyDscr><othrStdyMat><relMat><citation><titlStmt><titl>

get_related

public String get_related()
                   throws Exception
Throws:
Exception

getSeriesName

public String getSeriesName()

Name of series, if applicable

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><serStmt><serName>

get_seriesName

public String get_seriesName()
                      throws Exception
Throws:
Exception

getStdyAuthEntity

public String getStdyAuthEntity()

Author of study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><rspStmt><AuthEnty>

get_stdyAuthEntity

public String get_stdyAuthEntity()
                          throws Exception
Throws:
Exception

getStdyCopyright

public String getStdyCopyright()

Copyright Statement of Study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><copyright>

get_stdyCopyright

public String get_stdyCopyright()
                         throws Exception
Throws:
Exception

getStdyID

public String getStdyID()

ID of the study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><IDNo>

get_stdyID

public String get_stdyID()
                  throws Exception
Throws:
Exception

getStdyProdAgency

public String getStdyProdAgency()

Producer Code

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer agency>

get_stdyProdAgency

public String get_stdyProdAgency()
                          throws Exception
Throws:
Exception

getStdyProducer

public String getStdyProducer()

producer

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer>

get_stdyProducer

public String get_stdyProducer()
                        throws Exception
Throws:
Exception

getStdyVersion

public String getStdyVersion()

File History information

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version>

get_stdyVersion

public String get_stdyVersion()
                       throws Exception
Throws:
Exception

getTopics

public String getTopics()
Deprecated. use subcat instead

Topics covered


get_topics

public String get_topics()
                  throws Exception
Throws:
Exception

getUniverse

public String[] getUniverse()

Description of population

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><universe>

getUniverseAsString

public String getUniverseAsString()

get_universe

public String get_universe()
                    throws Exception
Throws:
Exception

getWeight

public String getWeight()

Full description of use of weights in study

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><weight>

get_weight

public String get_weight()
                  throws Exception
Throws:
Exception

getNumCubes

public Integer getNumCubes()

Number of cubes


get_numCubes

public String get_numCubes()
                    throws Exception
Throws:
Exception

getStdyParTitl

public String getStdyParTitl()

Parallel Title: Title translated into another language.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><parTitl>

get_stdyParTitl

public String get_stdyParTitl()
                       throws Exception
Throws:
Exception

getNation

public String getNation()

Indicates the country or countries covered in the file.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><stdyInfo><sumDscr><nation>

get_nation

public String get_nation()
                  throws Exception
Throws:
Exception

getStdyVersionNotes

public String getStdyVersionNotes()

Also known as release or edition. If there have been substantive changes to the data/documentation/variable since its creation, this statement should be used.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><notes>

get_stdyVersionNotes

public String get_stdyVersionNotes()
                            throws Exception
Throws:
Exception

getStdyContributor

public String getStdyContributor()

Give statements of responsibility not recorded in the title and statement of responsibility area.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><rspStmt><othId><p>

get_stdyContributor

public String get_stdyContributor()
                           throws Exception
Throws:
Exception

getStdyStatus

public String getStdyStatus()

Generally used to give the data archive's class or study status number, which indicates the processing status of the study.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><stdyClas>

get_stdyStatus

public String get_stdyStatus()
                      throws Exception
Throws:
Exception

getStdyProducerAbbr

public String getStdyProducerAbbr()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><prodStmt><producer abbr>

get_stdyProducerAbbr

public String get_stdyProducerAbbr()
                            throws Exception
Throws:
Exception

getStdyDataAppraisal

public String getStdyDataAppraisal()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><anlyInfo><dataAppr>

get_stdyDataAppraisal

public String get_stdyDataAppraisal()
                             throws Exception
Throws:
Exception

getStdyContactAffiliation

public String[] getStdyContactAffiliation()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact affiliation>

getStdyContactAffiliationAsString

public String getStdyContactAffiliationAsString()

get_stdyContactAffiliation

public String get_stdyContactAffiliation()
                                  throws Exception
Throws:
Exception

getStdyContactEmail

public String[] getStdyContactEmail()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact email>

getStdyContactEmailAsString

public String getStdyContactEmailAsString()

get_stdyContactEmail

public String get_stdyContactEmail()
                            throws Exception
Throws:
Exception

getStdyDataCollFreq

public String getStdyDataCollFreq()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><method><dataColl><frequenc>

get_stdyDataCollFreq

public String get_stdyDataCollFreq()
                            throws Exception
Throws:
Exception

getStdyVersionDate

public Date getStdyVersionDate()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version date>

get_stdyVersionDate

public String get_stdyVersionDate()
                           throws Exception
Throws:
Exception

getStdyVersionType

public String getStdyVersionType()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><version type>

get_stdyVersionType

public String get_stdyVersionType()
                           throws Exception
Throws:
Exception

getStdyVersionResponsibility

public String getStdyVersionResponsibility()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><verStmt><verResp>

get_stdyVersionResponsibility

public String get_stdyVersionResponsibility()
                                     throws Exception
Throws:
Exception

getStdyContact

public String[] getStdyContact()
This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><distStmt><contact>

getStdyContactAsString

public String getStdyContactAsString()

get_stdyContact

public String get_stdyContact()
                       throws Exception
Throws:
Exception

getStdyAltTitl

public String getStdyAltTitl()

The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.

This property stores the contents of the DDI field:
<codeBook><stdyDscr><citation><titlStmt><altTitl>

get_stdyAltTitl

public String get_stdyAltTitl()
                       throws Exception
Throws:
Exception

getDocAltTitl

public String getDocAltTitl()

The alternative title may be the title by which a data collection is commonly referred or it may be an abbreviation for the title.

This property stores the contents of the DDI field:
<codeBook><docDscr><citation><titlStmt><altTitl>

get_docAltTitl

public String get_docAltTitl()
                      throws Exception
Throws:
Exception

GetWeightVariables

public Bookmark GetWeightVariables()
                            throws Exception
Throws:
Exception

GetWeightVariables

public List GetWeightVariables(BasicExecutorLog log)
                        throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Throws:
Exception

getDescriptor

public static FeatureDescriptor getDescriptor(String featureName)
get the descriptor for a feature of the class, either method or attribute Note: the methods' feature are still not implemented

Parameters:
featureName -

getPartsDescriptor

public static Collection getPartsDescriptor()
Returns:
the descriptor of the attribute that are part of the class

getGetterMethods

public static Collection getGetterMethods()
Returns:
the descriptor of the attribute that are part of the class

newInstance

public static Dataset newInstance(RDFDB db)
                           throws Exception
Create a new object of this type with a locally unique id and returns it

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

listenForNewObj

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

Parameters:
listener - the listener

initialised

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

Overrides:
initialised in class Dataset

retrieve

public static Dataset retrieve(URL id)
                        throws Exception
If an object of type Study 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 Study 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 Dataset

RangeQuery

public Bookmark RangeQuery(String query,
                           Integer startFrom,
                           Integer maxHits,
                           Boolean withPath)
                    throws Exception
Parameters:
query -
startFrom -
maxHits -
withPath -
Throws:
Exception

RangeQuery

public List RangeQuery(String query,
                       Integer startFrom,
                       Integer maxHits,
                       Boolean withPath,
                       BasicExecutorLog log)
                throws Exception
Parameters:
query -
startFrom -
maxHits -
withPath -
log - the Executor of this method;if null a default one is used
Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved