nesstar.api.faster
Class CategoryStatistic

java.lang.Object
  java.util.Observable
      nesstar.rdf.RDFObject
          nesstar.api.faster.CategoryStatistic

All Implemented Interfaces:

Comparable, RDFObj

public class CategoryStatistic
extends RDFObject

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

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

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

<codeBook><dataDscr><var><catgry><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

CategoryStatistic(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_catValue()
String	get_crossTab()
String	get_frequency()
String	get_isMissing()
String	get_percent()
String	get_percentage()
RDFRef	get_variable()
String	get_weightedFrequency()
static Vector	getAllInstances()
static Vector	getAllInstances(RDFDB db)
String	getCatValue() The explicit response.
String	getComment() A fuller description of the response or an elaboration on the response.
Double	getCrossTab() A crosstab which defines the category; often appears in a table.
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	getFrequency() A frequency which defines the category; often appears in a table.
static Collection	getGetterMethods()
static CategoryStatistic	getInstance(RDFDB db, URL id) If an object of type CategoryStatistic with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static CategoryStatistic	getInstance(String rdf)
Boolean	getIsMissing() Indicates whether this category group contains missing data or not.
static Collection	getPartsDescriptor()
Double	getPercent() Deprecated*
Double	getPercentage() A percentage which defines the category; often appears in a table.
Variable	getVariable()
Double	getWeightedFrequency() A weighted frequency which defines the category; often appears in a table.
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 CategoryStatistic	newInstance(RDFDB db) Create a new object of this type with a locally unique id and returns it
static CategoryStatistic	retrieve(URL id) If an object of type CategoryStatistic 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_catValue(String catValue)
void	set_crossTab(String crossTab)
void	set_frequency(String frequency)
void	set_isMissing(String isMissing)
void	set_percent(String percent)
void	set_percentage(String percentage)
void	set_variable(RDFRef variable)
void	set_weightedFrequency(String weightedFrequency)
void	setCatValue(String catValue) The explicit response.
void	setCrossTab(Double crossTab) A crosstab which defines the category; often appears in a table.
void	setFrequency(Integer frequency) A frequency which defines the category; often appears in a table.
void	setIsMissing(Boolean isMissing) Indicates whether this category group contains missing data or not.
void	setPercent(Double percent) Deprecated*
void	setPercentage(Double percentage) A percentage which defines the category; often appears in a table.
void	setVariable(Variable variable)
void	setWeightedFrequency(Double weightedFrequency) A weighted frequency which defines the category; often appears in a table.

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

CategoryStatistic

public CategoryStatistic(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_variable

public void set_variable(RDFRef variable)

Parameters:

variable -

setVariable

public void setVariable(Variable variable)
                 throws Exception

Parameters:

variable -

Throws:

Exception

setFrequency

public void setFrequency(Integer frequency)

A frequency which defines the category; often appears in a table.

Parameters:

frequency -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=freq wgtd=not-wgtd>

set_frequency

public void set_frequency(String frequency)

Parameters:

frequency -

setWeightedFrequency

public void setWeightedFrequency(Double weightedFrequency)

A weighted frequency which defines the category; often appears in a table.

Parameters:

weightedFrequency -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=freq wgtd=wgtd>

set_weightedFrequency

public void set_weightedFrequency(String weightedFrequency)

Parameters:

weightedFrequency -

setPercentage

public void setPercentage(Double percentage)

A percentage which defines the category; often appears in a table.

Parameters:

percentage -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=percent>

set_percentage

public void set_percentage(String percentage)

Parameters:

percentage -

setCrossTab

public void setCrossTab(Double crossTab)

A crosstab which defines the category; often appears in a table.

Parameters:

crossTab -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=crosstab>

set_crossTab

public void set_crossTab(String crossTab)

Parameters:

crossTab -

setIsMissing

public void setIsMissing(Boolean isMissing)

Indicates whether this category group contains missing data or not.

Parameters:

isMissing -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry missing>

set_isMissing

public void set_isMissing(String isMissing)

Parameters:

isMissing -

setPercent

public void setPercent(Double percent)

Deprecated*

Parameters:

percent -

set_percent

public void set_percent(String percent)

Parameters:

percent -

setCatValue

public void setCatValue(String catValue)

The explicit response.

Parameters:

catValue -

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catValu>

set_catValue

public void set_catValue(String catValue)

Parameters:

catValue -

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

If an object of type CategoryStatistic 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 CategoryStatistic 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_variable

public RDFRef get_variable()
                    throws Exception

Throws:

Exception

getVariable

public Variable getVariable()

Returns:

getFrequency

public Integer getFrequency()

A frequency which defines the category; often appears in a table.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=freq wgtd=not-wgtd>

get_frequency

public String get_frequency()
                     throws Exception

Throws:

Exception

getWeightedFrequency

public Double getWeightedFrequency()

A weighted frequency which defines the category; often appears in a table.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=freq wgtd=wgtd>

get_weightedFrequency

public String get_weightedFrequency()
                             throws Exception

Throws:

Exception

getPercentage

public Double getPercentage()

A percentage which defines the category; often appears in a table.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=percent>

get_percentage

public String get_percentage()
                      throws Exception

Throws:

Exception

getCrossTab

public Double getCrossTab()

A crosstab which defines the category; often appears in a table.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catStat type=crosstab>

get_crossTab

public String get_crossTab()
                    throws Exception

Throws:

Exception

getIsMissing

public Boolean getIsMissing()

Indicates whether this category group contains missing data or not.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry missing>

get_isMissing

public String get_isMissing()
                     throws Exception

Throws:

Exception

getPercent

public Double getPercent()

Deprecated*

get_percent

public String get_percent()
                   throws Exception

Throws:

Exception

getCatValue

public String getCatValue()

The explicit response.

This property stores the contents of the DDI field:

<codeBook><dataDscr><var><catgry><catValu>

get_catValue

public String get_catValue()
                    throws Exception

Throws:

Exception

getComment

public String getComment()

A fuller description of the response or an elaboration on the response.

Overrides:

getComment in class RDFObject

Returns:

the comment

This property stores the contents of the DDI field:

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

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 CategoryStatistic 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 CategoryStatistic retrieve(URL id)
                                  throws Exception

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