nesstar.api.cosmos
Class CodeList

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

public class CodeList
extends RDFObject

A Cosmos CodeList. Used to group value domains belonging to a value hierarchy. For example: an international classification.

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
CodeList(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_codingType()
           
 RDFRef get_domains()
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
 String getCodingType()
           The type of the code list, e.g.: European Standard
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 getDomains()
           
static Collection getGetterMethods()
           
static CodeList getInstance(RDFDB db, URL id)
          If an object of type CodeList with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static CodeList getInstance(String rdf)
           
static Collection getPartsDescriptor()
           
 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 CodeList newInstance(RDFDB db)
          Create a new object of this type with a locally unique id and returns it
static CodeList retrieve(URL id)
          If an object of type CodeList 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_codingType(String codingType)
           
 void set_domains(RDFRef domains)
           
 void setCodingType(String codingType)
           The type of the code list, e.g.: European Standard
 void setDomains(List domains)
           
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDomain, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, getPartsDescriptor, getPath, getProperties, GetProperties, GetProperty, GetPropertyStatement, GetPropertyStatements, getRange, getRangeType, getRef, getRef, getServer, getShortId, getShortID, getStatementHome, GetStringProperties, GetStringProperty, getTimeoutInSecs, getType, init, init, isComplete, isLocal, isMeta, isStale, loaded, neededCollectionReload, neededReload, neededReload, neededReload, neededReload, needsReload, reload, remove, set_comment, set_complete, set_creationDate, set_label, 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

CodeList

public CodeList(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_domains

public void set_domains(RDFRef domains)
Parameters:
domains -

setDomains

public void setDomains(List domains)
                throws Exception
Parameters:
domains -
Throws:
Exception

setCodingType

public void setCodingType(String codingType)

The type of the code list, e.g.: European Standard

Parameters:
codingType -

set_codingType

public void set_codingType(String codingType)
Parameters:
codingType -

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

public RDFRef get_domains()
                   throws Exception
Throws:
Exception

getDomains

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

getCodingType

public String getCodingType()

The type of the code list, e.g.: European Standard


get_codingType

public String get_codingType()
                      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 CodeList 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 CodeList retrieve(URL id)
                         throws Exception
If an object of type CodeList 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 CodeList 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