DeveelDB  20151217
complete SQL database system, primarly developed for .NET/Mono frameworks
Public Member Functions | Properties | List of all members
Deveel.Data.Sql.Tables.ITable Interface Reference

Defines the contract to access the data contained into a table of a database. More...

Inheritance diagram for Deveel.Data.Sql.Tables.ITable:
Deveel.Data.Sql.IDbObject Deveel.Data.Sql.Tables.GeneratedTable Deveel.Data.Sql.Tables.IMutableTable Deveel.Data.Sql.Tables.IQueryTable Deveel.Data.Sql.Tables.IRootTable Deveel.Data.Sql.Tables.TableSource.MinimalTable Deveel.Data.Routines.RoutineManager.RoutinesTableContainer.RoutineTable Deveel.Data.Sql.Sequences.SequenceManager.SequenceTable Deveel.Data.Sql.Triggers.TriggerManager.TriggersTableContainer.TriggerTable Deveel.Data.SystemSchema.OpenSessionsTable Deveel.Data.SystemSchema.PrivilegesTable Deveel.Data.SystemSchema.ProductInfoTable Deveel.Data.SystemSchema.SessionInfoTable Deveel.Data.SystemSchema.SqlTypesTable Deveel.Data.SystemSchema.StatisticsTable Deveel.Data.SystemSchema.TableColumnsTable Deveel.Data.SystemSchema.TableInfoTable Deveel.Data.SystemSchema.VariablesTable Deveel.Data.Transactions.Transaction.OldAndNewTableContainer.TriggeredOldNew Deveel.Data.Sql.Tables.UserContextTable Deveel.Data.Transactions.Transaction.OldAndNewTableContainer.TriggeredOldNew Deveel.Data.Transactions.TransactionTable Deveel.Data.Sql.Tables.Table Deveel.Data.Sql.Tables.CompositeTable Deveel.Data.Sql.Tables.ReferenceTable Deveel.Data.Sql.Tables.RootTable Deveel.Data.Sql.Tables.SubsetColumnTable

Public Member Functions

DataObject GetValue (long rowNumber, int columnOffset)
 Gets a single cell within the table that is located at the given column offset and row. More...
 
ColumnIndex GetIndex (int columnOffset)
 Gets an index for given column that can be used to select values from this table. More...
 

Properties

IContext Context [get]
 
TableInfo TableInfo [get]
 Gets the metadata information of the table, used to resolve the column sources. More...
 
int RowCount [get]
 Gets the total number of rows in the table. More...
 
- Properties inherited from Deveel.Data.Sql.IDbObject
ObjectName FullName [get]
 Gets the fully qualified name of the object used to resolve it uniquely within the database. More...
 
DbObjectType ObjectType [get]
 Gets the type of database object that the implementation is for More...
 

Detailed Description

Defines the contract to access the data contained into a table of a database.

Default implementations of this interface are set to be read-only: to make the table accessible in write-mode, tables will implement IMutableTable.

A table rows can be enumerated in a sequence mode by using the IEnumerable<Row>, but if the table is altered the enumeration will throw an exception.

Definition at line 40 of file ITable.cs.

Member Function Documentation

ColumnIndex Deveel.Data.Sql.Tables.ITable.GetIndex ( int  columnOffset)

Gets an index for given column that can be used to select values from this table.

Parameters
columnOffsetThe zero-based offset of the column which to get the index.
Returns
Returns an instance of ColumnIndex that is used to select a subset of rows from the table.

Implemented in Deveel.Data.Sql.Tables.TableSource.MinimalTable, Deveel.Data.Transactions.TransactionTable, Deveel.Data.Sql.Tables.Table, and Deveel.Data.Sql.Tables.GeneratedTable.

DataObject Deveel.Data.Sql.Tables.ITable.GetValue ( long  rowNumber,
int  columnOffset 
)

Gets a single cell within the table that is located at the given column offset and row.

Parameters
rowNumberThe unique number of the row where the cell is located.
columnOffsetThe zero-based offset of the column of the cell to return.
Returns
Returns an instance of DataObject that is contained in the cell located by the row and column coordinates provided.
Exceptions
ArgumentOutOfRangeExceptionIf the given columnOffset is less than zero or greater or equal than the number of columns defined in the table metadata.
See also
Tables.TableInfo.IndexOfColumn(string)

Implemented in Deveel.Data.Sql.Tables.TableSource.MinimalTable, Deveel.Data.SystemSchema.StatisticsTable, Deveel.Data.SystemSchema.SessionInfoTable, Deveel.Data.SystemSchema.PrivilegesTable, Deveel.Data.SystemSchema.VariablesTable, Deveel.Data.SystemSchema.ProductInfoTable, Deveel.Data.SystemSchema.OpenSessionsTable, Deveel.Data.SystemSchema.SqlTypesTable, Deveel.Data.SystemSchema.TableColumnsTable, Deveel.Data.SystemSchema.TableInfoTable, Deveel.Data.Transactions.Transaction.OldAndNewTableContainer.TriggeredOldNew, Deveel.Data.Sql.Triggers.TriggerManager.TriggersTableContainer.TriggerTable, Deveel.Data.Routines.RoutineManager.RoutinesTableContainer.RoutineTable, Deveel.Data.Sql.Sequences.SequenceManager.SequenceTable, Deveel.Data.Sql.Tables.JoinedTable, Deveel.Data.Transactions.TransactionTable, Deveel.Data.Sql.Tables.FunctionTable, Deveel.Data.Sql.Tables.Table, Deveel.Data.Sql.Tables.CompositeTable, Deveel.Data.Sql.Tables.SubsetColumnTable, Deveel.Data.Sql.Tables.FilterTable, Deveel.Data.Sql.Tables.OuterTable, Deveel.Data.Sql.Tables.TemporaryTable, Deveel.Data.Sql.Tables.UserContextTable, Deveel.Data.Sql.Tables.GeneratedTable, and Deveel.Data.Sql.Tables.LimitedTable.

Property Documentation

IContext Deveel.Data.Sql.Tables.ITable.Context
get

Definition at line 41 of file ITable.cs.

int Deveel.Data.Sql.Tables.ITable.RowCount
get

Gets the total number of rows in the table.

Definition at line 52 of file ITable.cs.

TableInfo Deveel.Data.Sql.Tables.ITable.TableInfo
get

Gets the metadata information of the table, used to resolve the column sources.

Definition at line 47 of file ITable.cs.


The documentation for this interface was generated from the following file: