be.SIRAPRISE.client.jsba
Class TupleIndex

java.lang.Object
  extended by be.SIRAPRISE.client.jsba.AbstractDBObject
      extended by be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject
          extended by be.SIRAPRISE.client.jsba.TupleIndex
All Implemented Interfaces:
DBObject, DBObjectToTupleindex, TupleindexToDBObject, UpdatableDBObject

public final class TupleIndex
extends AbstractUpdatableDBObject
implements TupleindexToDBObject, DBObjectToTupleindex

Author:
Erwin

Constructor Summary
TupleIndex()
          Creates the TupleIndex
TupleIndex(java.lang.String relvarName, java.lang.String indexName, java.lang.String recordTypeName)
          Creates the TupleIndex
 
Method Summary
 java.lang.String getIndexName()
          Gets indexName
 UpdatableDBObject getPreUpdateState()
          Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.
 java.lang.String getRecordTypeName()
          Gets recordTypeName
 java.lang.String getRelvarName()
          Gets relvarName
 java.lang.String getTupleindexIndexname()
          Gets the indexname for tupleindex
 java.lang.String getTupleindexRecordtypename()
          Gets the recordtypename for tupleindex
 java.lang.String getTupleindexRelvarname()
          Gets the relvarname for tupleindex
 void setIndexName(java.lang.String indexName)
          Sets indexName
 void setIndexnameFromDB(java.lang.String indexname)
          Sets indexname from the DB
 void setPreUpdateState()
          This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database.
 void setRecordTypeName(java.lang.String recordTypeName)
          Sets recordTypeName
 void setRecordtypenameFromDB(java.lang.String recordtypename)
          Sets recordtypename from the DB
 void setRelvarName(java.lang.String relvarName)
          Sets relvarName
 void setRelvarnameFromDB(java.lang.String relvarname)
          Sets relvarname from the DB
 
Methods inherited from class be.SIRAPRISE.client.jsba.AbstractUpdatableDBObject
dbUpdateCommand, dbUpdateCommand
 
Methods inherited from class be.SIRAPRISE.client.jsba.AbstractDBObject
dbAddCommand, dbAddCommand, dbAddCommand, dbAddCommandAll, dbAssertCommand, dbAssertCommand, dbAssertCommand, dbAssertCommandAll, dbDeleteCommand, dbDeleteCommand, dbDeleteCommand, dbDeleteCommandAll, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommand, dbUnAssertCommandAll
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TupleIndex

public TupleIndex()
Creates the TupleIndex


TupleIndex

public TupleIndex(java.lang.String relvarName,
                  java.lang.String indexName,
                  java.lang.String recordTypeName)
Creates the TupleIndex

Parameters:
relvarName -
indexName -
recordTypeName -
Method Detail

getIndexName

public final java.lang.String getIndexName()
Gets indexName

Returns:
indexName.

getPreUpdateState

public UpdatableDBObject getPreUpdateState()
Description copied from interface: UpdatableDBObject
Gets The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

Specified by:
getPreUpdateState in interface UpdatableDBObject
Returns:
The state of the object as it was built by the J/R bridging engine immediately after the object was created from a database tuple (and which should have been set by/using the setPreUpdateState() method.

getRecordTypeName

public final java.lang.String getRecordTypeName()
Gets recordTypeName

Returns:
recordTypeName.

getRelvarName

public final java.lang.String getRelvarName()
Gets relvarName

Returns:
relvarName.

getTupleindexIndexname

public java.lang.String getTupleindexIndexname()
Description copied from interface: DBObjectToTupleindex
Gets the indexname for tupleindex

Specified by:
getTupleindexIndexname in interface DBObjectToTupleindex
Returns:
The indexname for tupleindex

getTupleindexRecordtypename

public java.lang.String getTupleindexRecordtypename()
Description copied from interface: DBObjectToTupleindex
Gets the recordtypename for tupleindex

Specified by:
getTupleindexRecordtypename in interface DBObjectToTupleindex
Returns:
The recordtypename for tupleindex

getTupleindexRelvarname

public java.lang.String getTupleindexRelvarname()
Description copied from interface: DBObjectToTupleindex
Gets the relvarname for tupleindex

Specified by:
getTupleindexRelvarname in interface DBObjectToTupleindex
Returns:
The relvarname for tupleindex

setIndexName

public final void setIndexName(java.lang.String indexName)
Sets indexName

Parameters:
indexName - The indexName to set.

setIndexnameFromDB

public void setIndexnameFromDB(java.lang.String indexname)
Description copied from interface: TupleindexToDBObject
Sets indexname from the DB

Specified by:
setIndexnameFromDB in interface TupleindexToDBObject
Parameters:
indexname - The DB value for indexname

setPreUpdateState

public void setPreUpdateState()
Description copied from interface: UpdatableDBObject
This method is called by the J/R bridging engine after an object has been setup from some tuple retrieved from the database. The method must cause the object to save a copy (/clone) of all the fields that are pertinent to the database. This copy will be retrieved by the J/R bridging engine using the getPreUpdateState() method call, and will subsequently be used by the J/R bridging engine to determine which fields have changed value, and thus to determine which attributes need to be updated in the database.

Specified by:
setPreUpdateState in interface UpdatableDBObject

setRecordTypeName

public final void setRecordTypeName(java.lang.String recordTypeName)
Sets recordTypeName

Parameters:
recordTypeName - The recordTypeName to set.

setRecordtypenameFromDB

public void setRecordtypenameFromDB(java.lang.String recordtypename)
Description copied from interface: TupleindexToDBObject
Sets recordtypename from the DB

Specified by:
setRecordtypenameFromDB in interface TupleindexToDBObject
Parameters:
recordtypename - The DB value for recordtypename

setRelvarName

public final void setRelvarName(java.lang.String relvarName)
Sets relvarName

Parameters:
relvarName - The relvarName to set.

setRelvarnameFromDB

public void setRelvarnameFromDB(java.lang.String relvarname)
Description copied from interface: TupleindexToDBObject
Sets relvarname from the DB

Specified by:
setRelvarnameFromDB in interface TupleindexToDBObject
Parameters:
relvarname - The DB value for relvarname