org.axiondb
Interface ExternalTable

All Superinterfaces:

RowSource, Table

All Known Implementing Classes:

BaseFlatfileTable, DelimitedFlatfileTable, ExternalAxionDBTable, ExternalDatabaseTable, FixedWidthFlatfileTable, TaggedEBCDICTable

public interface ExternalTable
extends Table

Extends Table interface to accept configuration parameters associated with connecting a table to an external resource, such as a flatfile or external JDBC-compatible database.

Typically the external tables or data file are pre-existing so, we need to get more meta information about the data organization so that it can load those existing data file as Axion table.

Version:

$Revision: 1.11 $ $Date: 2005/08/24 00:34:52 $

Field Summary

static java.lang.String	COLUMNS_ARE_CASE_SENSITIVE
static java.lang.String	DELIMITED_TABLE_TYPE
static java.lang.String	EXTERNAL_DB_TABLE_TYPE
static java.lang.String	FW_TABLE_TYPE
static java.lang.String	PROP_CATALOG Property key name for catalog name
static java.lang.String	PROP_CREATE_IF_NOT_EXIST
static java.lang.String	PROP_DB Property key name for database link
static java.lang.String	PROP_LOADTYPE Property key representing specific table type to be built
static java.lang.String	PROP_ORDERBY Property key name for where filter
static java.lang.String	PROP_REMOTETABLE Property key name for remote table name
static java.lang.String	PROP_SCHEMA Property key name for schema name
static java.lang.String	PROP_VENDOR Property key representing (optional) DB vendor name for remote table
static java.lang.String	PROP_WHERE Property key name for where filter
static java.lang.String	TAGGED_EBCDIC_TABLE_TYPE

Fields inherited from interface org.axiondb.Table

REGULAR_TABLE_TYPE, SYSTEM_TABLE_TYPE

Method Summary

java.util.Properties	getTableProperties() Gets Organization Property.
boolean	loadExternalTable(java.util.Properties prop) Loads external data using the given properties table - should be called only once by the table factory.
void	remount()

Methods inherited from interface org.axiondb.Table

addColumn, addConstraint, addIndex, addRow, addTableModificationListener, applyDeletes, applyInserts, applyUpdates, checkpoint, deleteRow, drop, freeRowId, getColumn, getColumn, getColumnCount, getColumnIdentifiers, getColumnIndex, getConstraint, getConstraints, getIndexedRows, getIndexedRows, getIndexForColumn, getIndices, getMatchingRows, getName, getNextRowId, getRowCount, getRowIterator, getSequence, getTableModificationListeners, getType, hasColumn, hasIndex, isColumnIndexed, isPrimaryKeyConstraintExists, isUniqueConstraintExists, makeRowDecorator, makeTransactableTable, migrate, populateIndex, remount, removeConstraint, removeIndex, removeTableModificationListener, rename, setDeferAllConstraints, setSequence, shutdown, truncate, updateRow

Methods inherited from interface org.axiondb.RowSource

getRow

Field Detail

DELIMITED_TABLE_TYPE

static final java.lang.String DELIMITED_TABLE_TYPE

See Also:

Constant Field Values

FW_TABLE_TYPE

static final java.lang.String FW_TABLE_TYPE

See Also:

Constant Field Values

TAGGED_EBCDIC_TABLE_TYPE

static final java.lang.String TAGGED_EBCDIC_TABLE_TYPE

See Also:

Constant Field Values

EXTERNAL_DB_TABLE_TYPE

static final java.lang.String EXTERNAL_DB_TABLE_TYPE

See Also:

Constant Field Values

PROP_CATALOG

static final java.lang.String PROP_CATALOG

Property key name for catalog name

See Also:

Constant Field Values

PROP_DB

static final java.lang.String PROP_DB

Property key name for database link

See Also:

Constant Field Values

PROP_ORDERBY

static final java.lang.String PROP_ORDERBY

Property key name for where filter

See Also:

Constant Field Values

PROP_REMOTETABLE

static final java.lang.String PROP_REMOTETABLE

Property key name for remote table name

See Also:

Constant Field Values

PROP_SCHEMA

static final java.lang.String PROP_SCHEMA

Property key name for schema name

See Also:

Constant Field Values

PROP_WHERE

static final java.lang.String PROP_WHERE

Property key name for where filter

See Also:

Constant Field Values

PROP_LOADTYPE

static final java.lang.String PROP_LOADTYPE

Property key representing specific table type to be built

See Also:

Constant Field Values

PROP_VENDOR

static final java.lang.String PROP_VENDOR

Property key representing (optional) DB vendor name for remote table

See Also:

Constant Field Values

COLUMNS_ARE_CASE_SENSITIVE

static final java.lang.String COLUMNS_ARE_CASE_SENSITIVE

See Also:

Constant Field Values

PROP_CREATE_IF_NOT_EXIST

static final java.lang.String PROP_CREATE_IF_NOT_EXIST

See Also:

Constant Field Values

Method Detail

loadExternalTable

boolean loadExternalTable(java.util.Properties prop)
                          throws AxionException

Loads external data using the given properties table - should be called only once by the table factory.

Parameters:

prop - configuration properties for this external table

Throws:

AxionException

getTableProperties

java.util.Properties getTableProperties()

Gets Organization Property.

Returns:

Set of organization property key names;

remount

void remount()
             throws AxionException

Throws:

AxionException