nesstar.api.faster
Class Cube

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

All Implemented Interfaces:

Comparable, RDFObj

public class Cube
extends RDFObject

The last part of the 'ID' property is derived from the DDI field:

<codeBook><dataDscr><nCube ID> Code automatically generated from ARGO/UML

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

<codeBook><dataDscr><nCube><txt>

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

<codeBook><dataDscr><nCube><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

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

Method Summary

Bookmark	AddDataFile(File file, String format)
void	AddDataFile(File file, String format, BasicExecutorLog log)
void	clear() Clear all properties of this object
String	get_analysUnit()
RDFRef	get_dimensions()
String	get_embargo()
String	get_fileLocation()
String	get_hasData()
String	get_imputation()
String	get_location()
RDFRef	get_measures()
String	get_notes()
String	get_respUnit()
String	get_security()
RDFRef	get_study()
String	get_universe()
String	get_version()
static Vector	getAllInstances()
static Vector	getAllInstances(RDFDB db)
String	getAnalysUnit()
String	getComment() Returns a human readable comment/description of the object as an HTML string (it should contain only basic HTML markers).
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
List	getDimensions()
String	getEmbargo()
String	getFileLocation()
static Collection	getGetterMethods()
Boolean	getHasData() Does this cube have data files?.
String	getImputation()
static Cube	getInstance(RDFDB db, URL id) If an object of type Cube with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static Cube	getInstance(String rdf)
String	getLocation()
List	getMeasures()
String	getNotes()
static Collection	getPartsDescriptor()
String	getRespUnit()
String	getSecurity()
Study	getStudy()
String	getUniverse()
String	getVersion()
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 Cube	newInstance(RDFDB db) Create a new object of this type with a locally unique id and returns it
Bookmark	Query(String mdx, Boolean includeData, Boolean includeMeta)
String	Query(String mdx, Boolean includeData, Boolean includeMeta, BasicExecutorLog log)
static Cube	retrieve(URL id) If an object of type Cube 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_analysUnit(String analysUnit)
void	set_dimensions(RDFRef dimensions)
void	set_embargo(String embargo)
void	set_fileLocation(String fileLocation)
void	set_hasData(String hasData)
void	set_imputation(String imputation)
void	set_location(String location)
void	set_measures(RDFRef measures)
void	set_notes(String notes)
void	set_respUnit(String respUnit)
void	set_security(String security)
void	set_study(RDFRef study)
void	set_universe(String universe)
void	set_version(String version)
void	setAnalysUnit(String analysUnit)
void	setDimensions(List dimensions)
void	setEmbargo(String embargo)
void	setFileLocation(String fileLocation)
void	setHasData(Boolean hasData) Does this cube have data files?.
void	setImputation(String imputation)
void	setLocation(String location)
void	setMeasures(List measures)
void	setNotes(String notes)
void	setRespUnit(String respUnit)
void	setSecurity(String security)
void	setStudy(Study study)
void	setUniverse(String universe)
void	setVersion(String version)

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

Cube

public Cube(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_study

public void set_study(RDFRef study)

Parameters:

study -

setStudy

public void setStudy(Study study)
              throws Exception

Parameters:

study -

Throws:

Exception

set_measures

public void set_measures(RDFRef measures)

Parameters:

measures -

setMeasures

public void setMeasures(List measures)
                 throws Exception

Parameters:

measures -

Throws:

Exception

set_dimensions

public void set_dimensions(RDFRef dimensions)

Parameters:

dimensions -

setDimensions

public void setDimensions(List dimensions)
                   throws Exception

Parameters:

dimensions -

Throws:

Exception

setFileLocation

public void setFileLocation(String fileLocation)

Parameters:

fileLocation -

set_fileLocation

public void set_fileLocation(String fileLocation)

Parameters:

fileLocation -

setLocation

public void setLocation(String location)

Parameters:

location -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><location locMap>

set_location

public void set_location(String location)

Parameters:

location -

setImputation

public void setImputation(String imputation)

Parameters:

imputation -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><imputation>

set_imputation

public void set_imputation(String imputation)

Parameters:

imputation -

setSecurity

public void setSecurity(String security)

Parameters:

security -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><security>

set_security

public void set_security(String security)

Parameters:

security -

setEmbargo

public void setEmbargo(String embargo)

Parameters:

embargo -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><embargo>

set_embargo

public void set_embargo(String embargo)

Parameters:

embargo -

setUniverse

public void setUniverse(String universe)

Parameters:

universe -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><universe>

set_universe

public void set_universe(String universe)

Parameters:

universe -

setRespUnit

public void setRespUnit(String respUnit)

Parameters:

respUnit -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><respUnit>

set_respUnit

public void set_respUnit(String respUnit)

Parameters:

respUnit -

setAnalysUnit

public void setAnalysUnit(String analysUnit)

Parameters:

analysUnit -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><anlysUnit>

set_analysUnit

public void set_analysUnit(String analysUnit)

Parameters:

analysUnit -

setNotes

public void setNotes(String notes)

Parameters:

notes -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><notes>

set_notes

public void set_notes(String notes)

Parameters:

notes -

setVersion

public void setVersion(String version)

Parameters:

version -

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><verStmt><version>, <codeBook><dataDscr><nCube><verStmt><verResp>, <codeBook><dataDscr><nCube><verStmt><notes>

set_version

public void set_version(String version)

Parameters:

version -

setHasData

public void setHasData(Boolean hasData)

Does this cube have data files?.

Parameters:

hasData -

set_hasData

public void set_hasData(String hasData)

Parameters:

hasData -

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

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

public RDFRef get_study()
                 throws Exception

Throws:

Exception

getStudy

public Study getStudy()

Returns:

get_measures

public RDFRef get_measures()
                    throws Exception

Throws:

Exception

getMeasures

public List getMeasures()
                 throws Exception

Returns:

Throws:

Exception

get_dimensions

public RDFRef get_dimensions()
                      throws Exception

Throws:

Exception

getDimensions

public List getDimensions()
                   throws Exception

Returns:

Throws:

Exception

getFileLocation

public String getFileLocation()

get_fileLocation

public String get_fileLocation()
                        throws Exception

Throws:

Exception

getLocation

public String getLocation()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><location locMap>

get_location

public String get_location()
                    throws Exception

Throws:

Exception

getImputation

public String getImputation()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><imputation>

get_imputation

public String get_imputation()
                      throws Exception

Throws:

Exception

getSecurity

public String getSecurity()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><security>

get_security

public String get_security()
                    throws Exception

Throws:

Exception

getEmbargo

public String getEmbargo()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><embargo>

get_embargo

public String get_embargo()
                   throws Exception

Throws:

Exception

getUniverse

public String getUniverse()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><universe>

get_universe

public String get_universe()
                    throws Exception

Throws:

Exception

getRespUnit

public String getRespUnit()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><respUnit>

get_respUnit

public String get_respUnit()
                    throws Exception

Throws:

Exception

getAnalysUnit

public String getAnalysUnit()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><anlysUnit>

get_analysUnit

public String get_analysUnit()
                      throws Exception

Throws:

Exception

getNotes

public String getNotes()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><notes>

get_notes

public String get_notes()
                 throws Exception

Throws:

Exception

getVersion

public String getVersion()

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><verStmt><version>, <codeBook><dataDscr><nCube><verStmt><verResp>, <codeBook><dataDscr><nCube><verStmt><notes>

get_version

public String get_version()
                   throws Exception

Throws:

Exception

getHasData

public Boolean getHasData()

Does this cube have data files?.

get_hasData

public String get_hasData()
                   throws Exception

Throws:

Exception

getComment

public String getComment()

Description copied from class: RDFObject

Returns a human readable comment/description of the object as an HTML string (it should contain only basic HTML markers).

Overrides:

getComment in class RDFObject

Returns:

the comment

This property stores the contents of the DDI field:

<codeBook><dataDscr><nCube><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 Cube 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 Cube retrieve(URL id)
                     throws Exception

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

Query

public Bookmark Query(String mdx,
                      Boolean includeData,
                      Boolean includeMeta)
               throws Exception

Parameters:

mdx -

includeData -

includeMeta -

Throws:

Exception

Query

public String Query(String mdx,
                    Boolean includeData,
                    Boolean includeMeta,
                    BasicExecutorLog log)
             throws Exception

Parameters:

mdx -

includeData -

includeMeta -

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

Throws:

Exception

AddDataFile

public Bookmark AddDataFile(File file,
                            String format)
                     throws Exception

Parameters:

file -

format -

Throws:

Exception

AddDataFile

public void AddDataFile(File file,
                        String format,
                        BasicExecutorLog log)
                 throws Exception

Parameters:

file -

format -

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

Throws:

Exception