nesstar.api.common
Class StatementHome

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

public class StatementHome
extends RDFObject

An API class for the StatementHome 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
StatementHome(RDFDB db, URL id)
          Create an object with the indicated id in the indicated db
 
Method Summary
 Bookmark addProperty(RDFObject subject, URL property, RDFObject object, String label, String comment)
           Add an occurrance of the specified property on 'subject' with value equal to 'object'.
 Statement addProperty(RDFObject subject, URL property, RDFObject object, String label, String comment, BasicExecutorLog log)
           Add an occurrance of the specified property on 'subject' with value equal to 'object'.
 Bookmark addStringProperty(RDFObject subject, URL property, String object, String label, String comment)
           Add an occurrance of the specified property on 'subject' with value equal to 'object'.
 Statement addStringProperty(RDFObject subject, URL property, String object, String label, String comment, BasicExecutorLog log)
           Add an occurrance of the specified property on 'subject' with value equal to 'object'.
 Bookmark EJBQuery(String query)
           
 List EJBQuery(String where, BasicExecutorLog log)
           
 Bookmark find(String subjectType, String subjectId, String objectType, String objectId, String predicateType, Integer predicateIndex)
           
 List find(String subjectType, String subjectId, String objectType, String objectId, String predicateType, Integer predicateIndex, BasicExecutorLog log)
           
 Bookmark findAll()
           
 List findAll(BasicExecutorLog log)
           
 Bookmark findByKey(String id)
           
 Statement findByKey(String id, BasicExecutorLog log)
           
 Bookmark findByObject(String objectType, String objectid)
           
 List findByObject(String objectType, String objectid, BasicExecutorLog log)
           
static Vector getAllInstances()
           
static Vector getAllInstances(RDFDB db)
           
static StatementHome getInstance(RDFDB db, URL id)
          If an object of type StatementHome with the indicated id exists in the db returns it otherwise create a new object in the db and returns it
static StatementHome getInstance(String rdf)
           
 Bookmark getProperties(RDFObject subject, URL property)
           Returns a, possibly empty, collection of statements that state the given property.
 List getProperties(RDFObject subject, URL property, BasicExecutorLog log)
           Returns a, possibly empty, collection of statements that state the given property.
 Bookmark getProperty(RDFObject subject, URL property)
           A convenience method that returns getProperties.get(0) if there are properties, null otherwise.
 Statement getProperty(RDFObject subject, URL property, BasicExecutorLog log)
           A convenience method that returns getProperties.get(0) if there are properties, null otherwise.
 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 StatementHome retrieve(URL id)
          If an object of type StatementHome with the indicated id has already being retrieved from the network returns it otherwise retrieve it together with its class information (methods, properties, etc.)
 Bookmark setProperty(RDFObject subject, URL property, RDFObject object, String label, String comment)
           Set the specified property on 'subject' with value equal to 'object'.
 Statement setProperty(RDFObject subject, URL property, RDFObject object, String label, String comment, BasicExecutorLog log)
           Set the specified property on 'subject' with value equal to 'object'.
 Bookmark setStringProperty(RDFObject subject, URL property, String value, String label, String comment)
           Set the specified property on 'subject' with value equal to 'object'.
 Statement setStringProperty(RDFObject subject, URL property, String value, String label, String comment, BasicExecutorLog log)
           Set the specified property on 'subject' with value equal to 'object'.
 
Methods inherited from class nesstar.rdf.RDFObject
AddProperty, AddStringProperty, chkFinal, clear, compareTo, dbg, equals, err, err, get_comment, get_creationDate, get_label, get, getAccessCondition, getBinding, getBindings, getBookmarkLabel, getCollectionURL, getComment, getCreationDate, getDB, getDescriptor, getDescriptor, getDomain, getGetterMethods, getID, getInitialisedProperties, getInternalID, getLabel, getLastClear, getPartsDescriptor, 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

StatementHome

public StatementHome(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

setProperty

public Bookmark setProperty(RDFObject subject,
                            URL property,
                            RDFObject object,
                            String label,
                            String comment)
                     throws Exception

Set the specified property on 'subject' with value equal to 'object'.

If the same user had previously set the same property to one or more values all previous values are removed before the new value is set.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property

label -
comment -
Returns:
the Statement that states the property

Throws:
Exception

setProperty

public Statement setProperty(RDFObject subject,
                             URL property,
                             RDFObject object,
                             String label,
                             String comment,
                             BasicExecutorLog log)
                      throws Exception

Set the specified property on 'subject' with value equal to 'object'.

If the same user had previously set the same property to one or more values all previous values are removed before the new value is set.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property

label -
comment -
log - the Executor of this method;if null a default one is used
Returns:
the Statement that states the property

Throws:
Exception

setStringProperty

public Bookmark setStringProperty(RDFObject subject,
                                  URL property,
                                  String value,
                                  String label,
                                  String comment)
                           throws Exception

Set the specified property on 'subject' with value equal to 'object'.

If the same user had previously set the same property to one or more values all previous values are removed before the new value is set.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

value -
label -
comment -
Returns:
the Statement that states the property

Throws:
Exception

setStringProperty

public Statement setStringProperty(RDFObject subject,
                                   URL property,
                                   String value,
                                   String label,
                                   String comment,
                                   BasicExecutorLog log)
                            throws Exception

Set the specified property on 'subject' with value equal to 'object'.

If the same user had previously set the same property to one or more values all previous values are removed before the new value is set.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

value -
label -
comment -
log - the Executor of this method;if null a default one is used
Returns:
the Statement that states the property

Throws:
Exception

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

getProperty

public Bookmark getProperty(RDFObject subject,
                            URL property)
                     throws Exception

A convenience method that returns getProperties.get(0) if there are properties, null otherwise.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

Returns:
the Statement that states the property or null if the property is not set.

Throws:
Exception

getProperty

public Statement getProperty(RDFObject subject,
                             URL property,
                             BasicExecutorLog log)
                      throws Exception

A convenience method that returns getProperties.get(0) if there are properties, null otherwise.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

log - the Executor of this method;if null a default one is used
Returns:
the Statement that states the property or null if the property is not set.

Throws:
Exception

getProperties

public Bookmark getProperties(RDFObject subject,
                              URL property)
                       throws Exception

Returns a, possibly empty, collection of statements that state the given property.

The server might return more or less of the values assigned to the property by the current user depending on the server setup.

In particular the server might send additional statements created by another user in the same user group or by the server administrator.

The server should return the statements in order with the more specific values of the property (normally the ones set bu the user himsefl) preceding the less specific ones (e.g. a server default).

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

Returns:
a collection of Statements that state the property

Throws:
Exception

getProperties

public List getProperties(RDFObject subject,
                          URL property,
                          BasicExecutorLog log)
                   throws Exception

Returns a, possibly empty, collection of statements that state the given property.

The server might return more or less of the values assigned to the property by the current user depending on the server setup.

In particular the server might send additional statements created by another user in the same user group or by the server administrator.

The server should return the statements in order with the more specific values of the property (normally the ones set bu the user himsefl) preceding the less specific ones (e.g. a server default).

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

log - the Executor of this method;if null a default one is used
Returns:
a collection of Statements that state the property

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

EJBQuery

public Bookmark EJBQuery(String query)
                  throws Exception
Parameters:
query - An EJB-QL query that returns objects of the type created by this Home.
Throws:
Exception

EJBQuery

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

findByKey

public Bookmark findByKey(String id)
                   throws Exception
Parameters:
id - the id of the object to be found
Throws:
Exception

findByKey

public Statement findByKey(String id,
                           BasicExecutorLog log)
                    throws Exception
Parameters:
id - the id of the object to be found
log - the Executor of this method;if null a default one is used
Throws:
Exception

findAll

public Bookmark findAll()
                 throws Exception
Returns:
a list of all the object of this type
Throws:
Exception

findAll

public List findAll(BasicExecutorLog log)
             throws Exception
Parameters:
log - the Executor of this method;if null a default one is used
Returns:
a list of all the object of this type
Throws:
Exception

findByObject

public Bookmark findByObject(String objectType,
                             String objectid)
                      throws Exception
Parameters:
objectType -
objectid -
Throws:
Exception

findByObject

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

find

public Bookmark find(String subjectType,
                     String subjectId,
                     String objectType,
                     String objectId,
                     String predicateType,
                     Integer predicateIndex)
              throws Exception
Parameters:
subjectType -
subjectId -
objectType -
objectId -
predicateType -
predicateIndex -
Throws:
Exception

find

public List find(String subjectType,
                 String subjectId,
                 String objectType,
                 String objectId,
                 String predicateType,
                 Integer predicateIndex,
                 BasicExecutorLog log)
          throws Exception
Parameters:
subjectType -
subjectId -
objectType -
objectId -
predicateType -
predicateIndex -
log - the Executor of this method;if null a default one is used
Throws:
Exception

addProperty

public Bookmark addProperty(RDFObject subject,
                            URL property,
                            RDFObject object,
                            String label,
                            String comment)
                     throws Exception

Add an occurrance of the specified property on 'subject' with value equal to 'object'.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property

label -
comment -
Returns:
the Statement that states the property

Throws:
Exception

addProperty

public Statement addProperty(RDFObject subject,
                             URL property,
                             RDFObject object,
                             String label,
                             String comment,
                             BasicExecutorLog log)
                      throws Exception

Add an occurrance of the specified property on 'subject' with value equal to 'object'.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property

label -
comment -
log - the Executor of this method;if null a default one is used
Returns:
the Statement that states the property

Throws:
Exception

addStringProperty

public Bookmark addStringProperty(RDFObject subject,
                                  URL property,
                                  String object,
                                  String label,
                                  String comment)
                           throws Exception

Add an occurrance of the specified property on 'subject' with value equal to 'object'.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property, as a String

label -
comment -
Returns:
the Statement that states the property

Throws:
Exception

addStringProperty

public Statement addStringProperty(RDFObject subject,
                                   URL property,
                                   String object,
                                   String label,
                                   String comment,
                                   BasicExecutorLog log)
                            throws Exception

Add an occurrance of the specified property on 'subject' with value equal to 'object'.

Parameters:
subject - the object to which the property is associated

property - the unique URL of the property

object - the value of the property, as a String

label -
comment -
log - the Executor of this method;if null a default one is used
Returns:
the Statement that states the property

Throws:
Exception

Nesstar SDK

Copyright©2003 NSD - All Rights Reserved