org.axiondb.engine.tables
Class BaseTable

java.lang.Object
  extended by org.axiondb.event.BaseTableModificationPublisher
      extended by org.axiondb.engine.tables.BaseTable
All Implemented Interfaces:
RowSource, Table
Direct Known Subclasses:
BaseDiskTable, ExternalDatabaseTable, MemoryTable

public abstract class BaseTable
extends BaseTableModificationPublisher
implements Table

An abstract base implementation of Table.

Version:
$Revision: 1.13 $ $Date: 2004/09/09 23:47:44 $

Field Summary
 
Fields inherited from interface org.axiondb.Table
REGULAR_TABLE_TYPE, SYSTEM_TABLE_TYPE
 
Constructor Summary
BaseTable(String name)
           
 
Method Summary
 void addColumn(Column col)
          Add the given Columnto this table.
 void addConstraint(Constraint constraint)
           
 void addIndex(Index index)
          Add an index, associating it with a Column, and adding it as a org.axiondb.TableModificationListenerto the table.
 void addRow(Row row)
          Insert the given Row.
abstract  void applyDeletes(org.apache.commons.collections.primitives.IntCollection rowids)
          Remove the specified rows from this table and any associated indices.
protected  void applyDeletesToIndices(org.apache.commons.collections.primitives.IntCollection rowIds)
           
abstract  void applyInserts(Collection rows)
          Insert the given rows into this table and any associated indices.
protected  void applyInsertsToIndices(Collection rows)
           
abstract  void applyUpdates(Collection rows)
          Update the given rows in this table and any associated indices.
protected  void applyUpdatesToIndices(Collection rows)
           
protected  void checkConstraints(RowEvent event)
           
protected  void checkConstraints(RowEvent event, boolean deferred)
           
protected  void deleteRow(Row row)
           
 void drop()
          Drop this table from the database.
abstract  void freeRowId(int id)
          Un-reserve a row id.
 Column getColumn(int index)
          Return the Columncorresponding to the given zero-based index .
 Column getColumn(String name)
          Return the Columnfor the given name .
 int getColumnCount()
          Return the number of Columns I contain.
 Iterator getColumnIdentifiers()
          Return an Iteratorover the ColumnIdentifiersfor my Columns.
 int getColumnIndex(String name)
          Return the zero-based index of the Columnwith the given name .
 Iterator getConstraints()
           
 RowIterator getIndexedRows(Selectable node, boolean readOnly)
           
 Index getIndexForColumn(Column column)
          Return the first Indexthat pertains to the given Column, or null if no such Indexexists.
 Iterator getIndices()
          Obtain an Iteratorover my indices.
 RowIterator getMatchingRows(List selectables, List values)
          Obtain an iteratorover my Rows where each Selectablein the selectable list evaluatesto the corresponding value in the value list.
 String getName()
          Get the name of this table.
abstract  int getNextRowId()
          Reserve a row id.
abstract  Row getRow(int id)
           
abstract  int getRowCount()
          Return the number of Rows I contain.
protected abstract  RowIterator getRowIterator()
           
 RowIterator getRowIterator(boolean readOnly)
          Obtain an iteratorover my Rows.
 String getType()
          Get the type of this table.
 boolean hasColumn(ColumnIdentifier id)
          Indicate whether the ColumnIdentifierreferences a column in this table
protected  boolean hasDeferredConstraint()
           
 boolean hasIndex(String name)
           
 boolean isColumnIndexed(Column column)
          Check to see if an Indexexists for the given Column
 boolean isPrimaryKeyConstraintExists(String columnName)
          check if primary constraint exists on a column
 boolean isUniqueConstraintExists(String columnName)
          check if unique constraint exists on a column
 RowDecorator makeRowDecorator()
           
 TransactableTable makeTransactableTable()
          Create a TransactableTablefor this table.
protected  void notifyColumnsOfNewLobDir(File directory)
           
abstract  void populateIndex(Index index)
          Populate an Index, adding my current rows to it.
protected  void readColumns(ObjectInputStream in)
           
protected  void readConstraints(ObjectInputStream in)
           
 void remount(File dir, boolean datafilesonly)
          Notify this table that its disk-location has moved.
 void removeConstraint(String name)
           
 void removeIndex(Index index)
          Remove an index, both from the indices and as a TableModificationListener
 void rename(String oldName, String newName)
           
protected  void setName(String name)
           
protected  void setType(String type)
           
 void shutdown()
          The database is shutting down, shutdown this table also.
 String toString()
           
protected  void truncateIndices()
           
 void updateRow(Row oldrow, Row newrow)
          Update the given Row.
protected  void writeColumns(ObjectOutputStream out)
           
protected  void writeConstraints(ObjectOutputStream out)
           
 
Methods inherited from class org.axiondb.event.BaseTableModificationPublisher
addTableModificationListener, getTableModificationListeners, publishEvent, removeTableModificationListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.axiondb.Table
addTableModificationListener, removeTableModificationListener, truncate
 

Constructor Detail

BaseTable

public BaseTable(String name)
Method Detail

applyDeletes

public abstract void applyDeletes(org.apache.commons.collections.primitives.IntCollection rowids)
                           throws AxionException
Description copied from interface: Table
Remove the specified rows from this table and any associated indices. This process is allowed to be destructive, the table my delete values from the given list.

Specified by:
applyDeletes in interface Table
Throws:
AxionException

applyInserts

public abstract void applyInserts(Collection rows)
                           throws AxionException
Description copied from interface: Table
Insert the given rows into this table and any associated indices. This process is allowed to be destructive, the table my delete rows from the given list.

Specified by:
applyInserts in interface Table
Parameters:
rows - a collection of Rows
Throws:
AxionException

applyUpdates

public abstract void applyUpdates(Collection rows)
                           throws AxionException
Description copied from interface: Table
Update the given rows in this table and any associated indices. This process is allowed to be destructive, the table my delete rows from the given list.

Specified by:
applyUpdates in interface Table
Throws:
AxionException

freeRowId

public abstract void freeRowId(int id)
Description copied from interface: Table
Un-reserve a row id.

Specified by:
freeRowId in interface Table

getNextRowId

public abstract int getNextRowId()
Description copied from interface: Table
Reserve a row id.

Specified by:
getNextRowId in interface Table

getRowCount

public abstract int getRowCount()
Description copied from interface: Table
Return the number of Rows I contain.

Specified by:
getRowCount in interface Table

populateIndex

public abstract void populateIndex(Index index)
                            throws AxionException
Description copied from interface: Table
Populate an Index, adding my current rows to it. Does not addthe index.

Specified by:
populateIndex in interface Table
Throws:
AxionException
See Also:
Table.addIndex(org.axiondb.Index)

getRow

public abstract Row getRow(int id)
                    throws AxionException
Specified by:
getRow in interface RowSource
Throws:
AxionException

getRowIterator

protected abstract RowIterator getRowIterator()
                                       throws AxionException
Throws:
AxionException

getRowIterator

public RowIterator getRowIterator(boolean readOnly)
                           throws AxionException
Description copied from interface: Table
Obtain an iteratorover my Rows.

Specified by:
getRowIterator in interface Table
Parameters:
readOnly - when true, the caller does not expect to be able to modify (i.e., call RowIterator.set(org.axiondb.Row)or RowIterator.remove()on) the returned RowIterator, the returned iterator may be unmodifiable.
Throws:
AxionException

addRow

public void addRow(Row row)
            throws AxionException
Description copied from interface: Table
Insert the given Row.

Specified by:
addRow in interface Table
Throws:
AxionException

deleteRow

protected void deleteRow(Row row)
                  throws AxionException
Throws:
AxionException

updateRow

public void updateRow(Row oldrow,
                      Row newrow)
               throws AxionException
Description copied from interface: Table
Update the given Row.

Specified by:
updateRow in interface Table
Throws:
AxionException

truncateIndices

protected void truncateIndices()
                        throws AxionException
Throws:
AxionException

toString

public String toString()
Overrides:
toString in class Object

getName

public String getName()
Description copied from interface: Table
Get the name of this table.

Specified by:
getName in interface Table

getType

public String getType()
Description copied from interface: Table
Get the type of this table.

Specified by:
getType in interface Table

setType

protected void setType(String type)

setName

protected void setName(String name)

addConstraint

public void addConstraint(Constraint constraint)
                   throws AxionException
Specified by:
addConstraint in interface Table
Throws:
AxionException

removeConstraint

public void removeConstraint(String name)
Specified by:
removeConstraint in interface Table

isUniqueConstraintExists

public boolean isUniqueConstraintExists(String columnName)
check if unique constraint exists on a column

Specified by:
isUniqueConstraintExists in interface Table
Parameters:
columnName - name of the columm
Returns:
true if uniqueConstraint exists on the column

isPrimaryKeyConstraintExists

public boolean isPrimaryKeyConstraintExists(String columnName)
check if primary constraint exists on a column

Specified by:
isPrimaryKeyConstraintExists in interface Table
Parameters:
ColumnName - name of the column
Returns:
if PrimaryKeyConstraint exists on the column

getConstraints

public Iterator getConstraints()
Specified by:
getConstraints in interface Table

addIndex

public void addIndex(Index index)
              throws AxionException
Description copied from interface: Table
Add an index, associating it with a Column, and adding it as a org.axiondb.TableModificationListenerto the table.

Specified by:
addIndex in interface Table
Throws:
AxionException
See Also:
Table.addIndex(org.axiondb.Index), Table.addTableModificationListener(org.axiondb.event.TableModificationListener), Table.getIndexForColumn(org.axiondb.Column), Table.isColumnIndexed(org.axiondb.Column), Table.populateIndex(org.axiondb.Index)

removeIndex

public void removeIndex(Index index)
                 throws AxionException
Description copied from interface: Table
Remove an index, both from the indices and as a TableModificationListener

Specified by:
removeIndex in interface Table
Throws:
AxionException

getIndexForColumn

public Index getIndexForColumn(Column column)
Description copied from interface: Table
Return the first Indexthat pertains to the given Column, or null if no such Indexexists.

Specified by:
getIndexForColumn in interface Table
Returns:
the pertinent Column, or null if no such Indexexists

isColumnIndexed

public boolean isColumnIndexed(Column column)
Description copied from interface: Table
Check to see if an Indexexists for the given Column

Specified by:
isColumnIndexed in interface Table
Parameters:
column - Columnto check
Returns:
true iff there is an existing Indexfor the given Column

getMatchingRows

public RowIterator getMatchingRows(List selectables,
                                   List values)
                            throws AxionException
Description copied from interface: Table
Obtain an iteratorover my Rows where each Selectablein the selectable list evaluatesto the corresponding value in the value list.

This is functionally similiar to executing a SELECT over this table where selectable[i] = value[i] for each value of i . The return RowIterator is not modifiable.

Specified by:
getMatchingRows in interface Table
Throws:
AxionException

getIndexedRows

public RowIterator getIndexedRows(Selectable node,
                                  boolean readOnly)
                           throws AxionException
Specified by:
getIndexedRows in interface Table
readOnly - when true, the caller does not expect to be able to modify (i.e., call RowIterator.set(org.axiondb.Row)or RowIterator.remove()on) the returned RowIterator, the returned iterator may be unmodifiable.
Throws:
AxionException

addColumn

public void addColumn(Column col)
               throws AxionException
Add the given Columnto this table. This implementation throws an AxionExceptionif rows have already been added to the table.

Specified by:
addColumn in interface Table
Throws:
AxionException

hasColumn

public boolean hasColumn(ColumnIdentifier id)
Description copied from interface: Table
Indicate whether the ColumnIdentifierreferences a column in this table

Specified by:
hasColumn in interface Table

getColumn

public Column getColumn(int index)
Description copied from interface: Table
Return the Columncorresponding to the given zero-based index .

Specified by:
getColumn in interface Table

getColumn

public Column getColumn(String name)
Description copied from interface: Table
Return the Columnfor the given name .

Specified by:
getColumn in interface Table

getColumnIndex

public int getColumnIndex(String name)
                   throws AxionException
Description copied from interface: Table
Return the zero-based index of the Columnwith the given name .

Specified by:
getColumnIndex in interface RowSource
Specified by:
getColumnIndex in interface Table
Throws:
AxionException

getColumnIdentifiers

public Iterator getColumnIdentifiers()
Description copied from interface: Table
Return an Iteratorover the ColumnIdentifiersfor my Columns.

Specified by:
getColumnIdentifiers in interface Table

getColumnCount

public int getColumnCount()
Description copied from interface: Table
Return the number of Columns I contain.

Specified by:
getColumnCount in interface RowSource
Specified by:
getColumnCount in interface Table

drop

public void drop()
          throws AxionException
Description copied from interface: Table
Drop this table from the database.

Specified by:
drop in interface Table
Throws:
AxionException

remount

public void remount(File dir,
                    boolean datafilesonly)
             throws AxionException
Description copied from interface: Table
Notify this table that its disk-location has moved.

Specified by:
remount in interface Table
Throws:
AxionException

rename

public void rename(String oldName,
                   String newName)
            throws AxionException
Specified by:
rename in interface Table
Throws:
AxionException

shutdown

public void shutdown()
              throws AxionException
Description copied from interface: Table
The database is shutting down, shutdown this table also.

Specified by:
shutdown in interface Table
Throws:
AxionException

makeRowDecorator

public RowDecorator makeRowDecorator()
Specified by:
makeRowDecorator in interface RowSource
Specified by:
makeRowDecorator in interface Table

makeTransactableTable

public TransactableTable makeTransactableTable()
Description copied from interface: Table
Create a TransactableTablefor this table.

Specified by:
makeTransactableTable in interface Table

getIndices

public Iterator getIndices()
Description copied from interface: Table
Obtain an Iteratorover my indices.

Specified by:
getIndices in interface Table

hasIndex

public boolean hasIndex(String name)
Specified by:
hasIndex in interface Table

checkConstraints

protected void checkConstraints(RowEvent event)
                         throws AxionException
Throws:
AxionException

checkConstraints

protected void checkConstraints(RowEvent event,
                                boolean deferred)
                         throws AxionException
Throws:
AxionException

hasDeferredConstraint

protected boolean hasDeferredConstraint()

notifyColumnsOfNewLobDir

protected void notifyColumnsOfNewLobDir(File directory)

writeColumns

protected void writeColumns(ObjectOutputStream out)
                     throws IOException
Throws:
IOException

readColumns

protected void readColumns(ObjectInputStream in)
                    throws IOException,
                           ClassNotFoundException
Throws:
IOException
ClassNotFoundException

writeConstraints

protected void writeConstraints(ObjectOutputStream out)
                         throws IOException
Throws:
IOException

readConstraints

protected void readConstraints(ObjectInputStream in)
                        throws IOException,
                               ClassNotFoundException
Throws:
IOException
ClassNotFoundException

applyDeletesToIndices

protected void applyDeletesToIndices(org.apache.commons.collections.primitives.IntCollection rowIds)
                              throws AxionException
Throws:
AxionException

applyUpdatesToIndices

protected void applyUpdatesToIndices(Collection rows)
                              throws AxionException
Throws:
AxionException

applyInsertsToIndices

protected void applyInsertsToIndices(Collection rows)
                              throws AxionException
Throws:
AxionException