be.SIRAPRISE.client.jsba
Class AbstractDBObject

java.lang.Object
  be.SIRAPRISE.client.jsba.AbstractDBObject

All Implemented Interfaces:

DBObject

Direct Known Subclasses:

AbstractUpdatableDBObject

public abstract class AbstractDBObject
extends java.lang.Object
implements DBObject

An abstract class that can be inherited from by classes that need to implement DBObject, providing default implementations for the Java/SIRA_PRISE bridge methods

Author:

Erwin Smout

Constructor Summary

AbstractDBObject()

Method Summary

DmlAddCommand	dbAddCommand() Gets the command for adding (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.
DmlAddCommand	dbAddCommand(java.lang.String relvarName) Gets the command for adding an entry in the named relvar (in the database the transaction is connected to), for the given object.
static DmlAddCommand	dbAddCommand(java.lang.String relvarName, DBObject o) Gets the command for adding an entry in the named relvar (in the database the transaction is connected to), for the given object.
DmlAssignmentCommand	dbAddCommandAll() Gets the command for adding (in the database the transaction is connected to) an entry in all the relvars named in this object's class' @forrelvar annotation, for the given object.
DmlAssertCommand	dbAssertCommand() Gets the Assert command for asserting (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.
DmlAssertCommand	dbAssertCommand(java.lang.String relvarName) Gets the Assert command for asserting an entry in the named relvar (in the database the transaction is connected to), for the given object.
static DmlAssertCommand	dbAssertCommand(java.lang.String relvarName, DBObject o) Gets the Assert command for asserting an entry in the named relvar (in the database the transaction is connected to), for the given object.
DmlAssignmentCommand	dbAssertCommandAll() Gets the Assert command for asserting (in the database the transaction is connected to) an entry in the all relvars named in this object's class' @forrelvar annotation, for the given object.
DmlDeleteCommand	dbDeleteCommand() Gets the command for deleting (in the database the transaction is connected to) the tuple in the relvar named in the @forrelvar annotation of this object's class, for the given object.
DmlDeleteCommand	dbDeleteCommand(java.lang.String relvarName) Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.
static DmlDeleteCommand	dbDeleteCommand(java.lang.String relvarName, DBObject o) Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.
DmlAssignmentCommand	dbDeleteCommandAll() Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.
DmlUnassertCommand	dbUnAssertCommand() Gets the command for unasserting the tuple in the relvar named in the @forrelvar annotation of this class.
DmlUnassertCommand	dbUnAssertCommand(java.lang.String relvarName) Gets the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object.
static DmlUnassertCommand	dbUnAssertCommand(java.lang.String relvarName, DBObject o) Gets the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object.
DmlAssignmentCommand	dbUnAssertCommandAll() Gets the command for unasserting the tuple in all the relvars named in the @forrelvar annotation of this class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDBObject

public AbstractDBObject()

Method Detail

dbAddCommand

public static DmlAddCommand dbAddCommand(java.lang.String relvarName,
                                         DBObject o)

Gets the command for adding an entry in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

o - The object from which the tuple to be registered in the named relvar is to be drawn.

Returns:

The add command to be issued for adding an entry in the named relvar with attribute values drawn from the given object

dbAssertCommand

public static DmlAssertCommand dbAssertCommand(java.lang.String relvarName,
                                               DBObject o)

Gets the Assert command for asserting an entry in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

o - The object from which the tuple to be registered in the named relvar is to be drawn.

Returns:

The assert command to be issued for adding an entry in the named relvar with attribute values drawn from the given object

dbDeleteCommand

public static DmlDeleteCommand dbDeleteCommand(java.lang.String relvarName,
                                               DBObject o)

Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

o - The object from which the tuple to be registered in the named relvar is to be drawn.

Returns:

the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbUnAssertCommand

public static DmlUnassertCommand dbUnAssertCommand(java.lang.String relvarName,
                                                   DBObject o)

Gets the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

o - The object from which the tuple to be registered in the named relvar is to be drawn.

Returns:

the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbAddCommand

public final DmlAddCommand dbAddCommand()

Gets the command for adding (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.

Returns:

the command for adding (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.

dbAddCommand

public final DmlAddCommand dbAddCommand(java.lang.String relvarName)

Gets the command for adding an entry in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

Returns:

The add command to be issued for adding an entry in the named relvar with attribute values drawn from the given object

dbAddCommandAll

public final DmlAssignmentCommand dbAddCommandAll()

Gets the command for adding (in the database the transaction is connected to) an entry in all the relvars named in this object's class' @forrelvar annotation, for the given object.

Returns:

the command for adding (in the database the transaction is connected to) an entry in all the relvars named in this object's class' @forrelvar annotation, for the given object.

dbAssertCommand

public final DmlAssertCommand dbAssertCommand()

Gets the Assert command for asserting (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.

Returns:

the Assert command for asserting (in the database the transaction is connected to) an entry in the single relvar named in this object's class' @forrelvar annotation, for the given object.

dbAssertCommand

public final DmlAssertCommand dbAssertCommand(java.lang.String relvarName)

Gets the Assert command for asserting an entry in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

Returns:

The assert command to be issued for adding an entry in the named relvar with attribute values drawn from the given object

dbAssertCommandAll

public final DmlAssignmentCommand dbAssertCommandAll()

Gets the Assert command for asserting (in the database the transaction is connected to) an entry in the all relvars named in this object's class' @forrelvar annotation, for the given object.

Returns:

the Assert command for asserting (in the database the transaction is connected to) an entry in the all relvars named in this object's class' @forrelvar annotation, for the given object.

dbDeleteCommand

public final DmlDeleteCommand dbDeleteCommand()

Gets the command for deleting (in the database the transaction is connected to) the tuple in the relvar named in the @forrelvar annotation of this object's class, for the given object.

Returns:

the command for deleting (in the database the transaction is connected to) the tuple in the relvar named in the @forrelvar annotation of this object's class, for the given object.

dbDeleteCommand

public final DmlDeleteCommand dbDeleteCommand(java.lang.String relvarName)

Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

Returns:

the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbDeleteCommandAll

public final DmlAssignmentCommand dbDeleteCommandAll()

Gets the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

Returns:

the command for deleting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbUnAssertCommand

public final DmlUnassertCommand dbUnAssertCommand()

Gets the command for unasserting the tuple in the relvar named in the @forrelvar annotation of this class.

Returns:

the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbUnAssertCommand

public final DmlUnassertCommand dbUnAssertCommand(java.lang.String relvarName)

Gets the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object. The tuple that is registered in the database is constructed by invoking all the object's methods that satisfy the following properties :

• The name of the method is the word "get" (all lowercase), followed by the capitalized relvar name (i.e. first character of the relvar name uppercase, all remaining characters of the relvar name lowercase), followed by a capitalized attribute name (i.e. the first character of the remaining part of the method name must be uppercase and all the other remaining characters must be lowercase)
• The method is a public method that takes no arguments
• The return type of the method is java.lang.String

Parameters:

relvarName - The name of the relvar into which a tuple is to be added for the given object

Returns:

the command for unasserting the tuple in the named relvar (in the database the transaction is connected to), for the given object.

dbUnAssertCommandAll

public final DmlAssignmentCommand dbUnAssertCommandAll()

Gets the command for unasserting the tuple in all the relvars named in the @forrelvar annotation of this class.

Returns:

the command for unasserting the tuple in all the named relvar (in the database the transaction is connected to), for the given object.