org.axiondb.engine.tables
Class BaseTableOrganizationContext

java.lang.Object
  extended by org.axiondb.engine.tables.BaseTableOrganizationContext
All Implemented Interfaces:
TableOrganizationContext
Direct Known Subclasses:
BaseFlatfileTable.BaseFlatfileTableOrganizationContext

public abstract class BaseTableOrganizationContext
extends java.lang.Object
implements TableOrganizationContext

Table Organization Context.

Version:
$Revision: 1.3 $ $Date: 2005/06/18 01:03:45 $

Field Summary
protected  java.util.Properties _props
           
 
Constructor Summary
BaseTableOrganizationContext()
           
 
Method Summary
 void assertValidPropertyKeys(java.util.Properties props)
          Asserts that all property keys referenced in the given Properties instance are valid for the specific external table type.
 java.util.Set getBasePropertyKeys()
          Gets a Set of Strings representing property key names that all ExternalTable instances should accept.
 java.util.Set getBaseRequiredPropertyKeys()
          Gets a Set of Strings representing property key names that all ExternalTable instances must require.
abstract  java.util.Set getPropertyKeys()
          Gets a Set of Strings representing valid property key names.
abstract  java.util.Set getRequiredPropertyKeys()
           
 java.util.Properties getTableProperties()
          Gets table properties for this external table instance.
abstract  void readOrSetDefaultProperties(java.util.Properties props)
           
 void setProperty(java.lang.String key, java.lang.String value)
           
 void updateProperties()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_props

protected java.util.Properties _props
Constructor Detail

BaseTableOrganizationContext

public BaseTableOrganizationContext()
Method Detail

getTableProperties

public java.util.Properties getTableProperties()
Description copied from interface: TableOrganizationContext
Gets table properties for this external table instance.

Specified by:
getTableProperties in interface TableOrganizationContext
Returns:
Properties instance containing current table properties

getPropertyKeys

public abstract java.util.Set getPropertyKeys()
Description copied from interface: TableOrganizationContext
Gets a Set of Strings representing valid property key names.

Specified by:
getPropertyKeys in interface TableOrganizationContext
Returns:
Set of valid property key names

getRequiredPropertyKeys

public abstract java.util.Set getRequiredPropertyKeys()
Specified by:
getRequiredPropertyKeys in interface TableOrganizationContext

readOrSetDefaultProperties

public abstract void readOrSetDefaultProperties(java.util.Properties props)
                                         throws AxionException
Specified by:
readOrSetDefaultProperties in interface TableOrganizationContext
Throws:
AxionException

updateProperties

public void updateProperties()
Specified by:
updateProperties in interface TableOrganizationContext

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
Specified by:
setProperty in interface TableOrganizationContext

getBasePropertyKeys

public java.util.Set getBasePropertyKeys()
Description copied from interface: TableOrganizationContext
Gets a Set of Strings representing property key names that all ExternalTable instances should accept.

Specified by:
getBasePropertyKeys in interface TableOrganizationContext
Returns:
Set of basic valid property key names

getBaseRequiredPropertyKeys

public java.util.Set getBaseRequiredPropertyKeys()
Description copied from interface: TableOrganizationContext
Gets a Set of Strings representing property key names that all ExternalTable instances must require.

Specified by:
getBaseRequiredPropertyKeys in interface TableOrganizationContext
Returns:
Set of basic required property key names

assertValidPropertyKeys

public void assertValidPropertyKeys(java.util.Properties props)
                             throws AxionException
Description copied from interface: TableOrganizationContext
Asserts that all property keys referenced in the given Properties instance are valid for the specific external table type.

Specified by:
assertValidPropertyKeys in interface TableOrganizationContext
Parameters:
props - Properties instance whose keys are to be checked
Throws:
AxionException