org.jplate.tabular
Interface TableIfc

All Known Implementing Classes:

DefaultTable

public interface TableIfc

Defines the concept of a table. A table is a collection of RecordIfc's.

Modifications:
    $Date: 2008-12-02 12:32:45 -0500 (Tue, 02 Dec 2008) $
    $Revision: 479 $
    $Author: sfloess $
    $HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/src/dev/java/org/jplate/tabular/TableIfc.java $
    

Method Summary

void	addRecord(RecordIfc record) Add a record.
void	close() This method will close a table.
RecordIfc	createRecord()
java.util.List<RecordIfc>	getRecords() Return the collection of records.
java.lang.String	getTableName() Return the name of the table.
void	open() This method will open an existing table.
boolean	removeRecord(RecordIfc record) Remove record.
void	removeRecords() This method will force the removal of all records.

Method Detail

createRecord

RecordIfc createRecord()

getTableName

java.lang.String getTableName()

Return the name of the table.

Returns:

The name of the table.

open

void open()
          throws OpenException

This method will open an existing table.

Throws:

OpenException - If a problem arose opening the table.

close

void close()
           throws CloseException

This method will close a table.

Throws:

CloseException - If a problem arose closing the table.

addRecord

void addRecord(RecordIfc record)
               throws AddException

Add a record.

Parameters:

record - The record to add.

Throws:

AddException - if any issues arise adding record.

removeRecords

void removeRecords()
                   throws RemoveException

This method will force the removal of all records.

Throws:

RemoveException - if a problem arose removing all records.

removeRecord

boolean removeRecord(RecordIfc record)
                     throws RemoveException

Remove record.

Parameters:

record - The record to remove.

Returns:

true if successful or false if not.

Throws:

RemoveException - if any issues arise removing record.

getRecords

java.util.List<RecordIfc> getRecords()

Return the collection of records.

Returns:

the collection of records.