be.SIRAPRISE.client.jsba
Class Index

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

public final class Index
extends AbstractUpdatableDBObject
implements DBObjectToIndex, IndexToDBObject, DBObjectToTupleindex, TupleindexToDBObject

Author:
Erwin Smout

Constructor Summary
Index()
           
Index(java.lang.String relvarName, java.lang.String indexName, java.lang.String recordTypeName, java.lang.String fileName, int storageSpaceID)
           
 
Method Summary
 java.lang.String getFileName()
           
 java.lang.String getIndexFilename()
          Gets the filename for index
 java.lang.String getIndexIndexname()
          Gets the indexname for index
 java.lang.String getIndexRecordtypename()
          Gets the recordtypename for index
 java.lang.String getIndexRelvarname()
          Gets the relvarname for index
 java.lang.String getIndexStoragespaceid()
          Gets the storagespaceid for index
 java.lang.String getName()
           
 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()
           
 java.lang.String getRelvarName()
           
 int getStorageSpaceID()
           
 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 setFileName(java.lang.String fileName)
           
 void setFilenameFromDB(java.lang.String filename)
          Sets filename from the DB
 void setIndexnameFromDB(java.lang.String indexname)
          Sets indexname from the DB
 void setName(java.lang.String indexName)
           
 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)
           
 void setRecordtypenameFromDB(java.lang.String recordtypename)
          Sets recordtypename from the DB
 void setRelvarName(java.lang.String relvarName)
           
 void setRelvarnameFromDB(java.lang.String relvarname)
          Sets relvarname from the DB
 void setStorageSpaceID(int storageSpaceID)
           
 void setStoragespaceidFromDB(java.lang.String storagespaceid)
          Sets storagespaceid 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

Index

public Index()

Index

public Index(java.lang.String relvarName,
             java.lang.String indexName,
             java.lang.String recordTypeName,
             java.lang.String fileName,
             int storageSpaceID)
Parameters:
relvarName -
indexName -
recordTypeName -
fileName -
storageSpaceID -
Method Detail

getFileName

public final java.lang.String getFileName()
Returns:
Returns the fileName.

getIndexFilename

public java.lang.String getIndexFilename()
Description copied from interface: DBObjectToIndex
Gets the filename for index

Specified by:
getIndexFilename in interface DBObjectToIndex
Returns:
The filename for index

getIndexIndexname

public java.lang.String getIndexIndexname()
Description copied from interface: DBObjectToIndex
Gets the indexname for index

Specified by:
getIndexIndexname in interface DBObjectToIndex
Returns:
The indexname for index

getIndexRecordtypename

public java.lang.String getIndexRecordtypename()
Description copied from interface: DBObjectToIndex
Gets the recordtypename for index

Specified by:
getIndexRecordtypename in interface DBObjectToIndex
Returns:
The recordtypename for index

getIndexRelvarname

public java.lang.String getIndexRelvarname()
Description copied from interface: DBObjectToIndex
Gets the relvarname for index

Specified by:
getIndexRelvarname in interface DBObjectToIndex
Returns:
The relvarname for index

getIndexStoragespaceid

public java.lang.String getIndexStoragespaceid()
Description copied from interface: DBObjectToIndex
Gets the storagespaceid for index

Specified by:
getIndexStoragespaceid in interface DBObjectToIndex
Returns:
The storagespaceid for index

getName

public final java.lang.String getName()
Returns:
Returns the 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()
Returns:
Returns the recordTypeName.

getRelvarName

public final java.lang.String getRelvarName()
Returns:
Returns the relvarName.

getStorageSpaceID

public final int getStorageSpaceID()
Returns:
Returns the storageSpaceID.

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

setFileName

public final void setFileName(java.lang.String fileName)
Parameters:
fileName - The fileName to set.

setFilenameFromDB

public final void setFilenameFromDB(java.lang.String filename)
Description copied from interface: IndexToDBObject
Sets filename from the DB

Specified by:
setFilenameFromDB in interface IndexToDBObject
Parameters:
filename - The DB value for filename

setIndexnameFromDB

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

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

setName

public final void setName(java.lang.String indexName)
Parameters:
indexName - The indexName to set.

setPreUpdateState

public final 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)
Parameters:
recordTypeName - The recordTypeName to set.

setRecordtypenameFromDB

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

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

setRelvarName

public final void setRelvarName(java.lang.String relvarName)
Parameters:
relvarName - The relvarName to set.

setRelvarnameFromDB

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

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

setStorageSpaceID

public final void setStorageSpaceID(int storageSpaceID)
Parameters:
storageSpaceID - The storageSpaceID to set.

setStoragespaceidFromDB

public final void setStoragespaceidFromDB(java.lang.String storagespaceid)
Description copied from interface: IndexToDBObject
Sets storagespaceid from the DB

Specified by:
setStoragespaceidFromDB in interface IndexToDBObject
Parameters:
storagespaceid - The DB value for storagespaceid