oracle.owb.relational
Interface ExternalTable

All Superinterfaces:

CompilableObject, Component, Extensible, OWBNamedObject, PropertyOwner, ReconcileSource, ReconcileTarget, Snapshotable, ValidatableObject

public interface ExternalTable

extends Component, ReconcileSource, ReconcileTarget, Extensible, ValidatableObject, CompilableObject

ExternalTable interface represents an Oracle database external table.

Fields inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

MAX_DEPENDENCY_DEPTH, MIN_DEPENDENCY_DEPTH

Method Summary

ExternalTableColumn	createColumn(java.lang.String name) Creates and adds a new ExternalTableColumn to the ExternalTable.
ExternalTableColumn	createColumn(java.lang.String name, int position) Creates and adds a new ExternalTableColumn to the ExternalTable at the specified position.
Datafile	createDatafile(java.lang.String name) Create a Data File.
void	deleteDatafile(java.lang.String name) Delete a Data File.
ExternalTableColumn	findColumn(java.lang.String name) Finds an ExternalTableColumn in the ExternalTable
Datafile	findDatafile(java.lang.String name) Find a Data File.
java.lang.String	getAccessParameters() Gets the access parameters for the ExternalTable.
ExternalTableColumn[]	getColumns() Gets an ordered list of the ExternalTable's columns.
Datafile[]	getDatafiles() Get the Data Files.
Location	getDefaultLocation() Gets the default location of the ExternalTable's datafiles, log files, discard files, and bad files.
Module	getModule() Gets the owning Module of the ExternalTable
Record	getReferencedRecord() Gets the corresponding Record for the ExternalTable.
void	moveColumn(ExternalTableColumn column, int newPosition) Moves an ExternalTableColumn to a new position.
void	setAccessParameters(java.lang.String parameters) Sets the access parameters for the ExternalTable.
void	setDefaultLocation(Location location) Sets the default location of the ExternalTable's datafiles, log files, discard files, and bad files.
void	setReferencedRecord(Record record) Sets the corresponding Record for the ExternalTable.

Methods inherited from interface oracle.owb.foundation.Component

getOwningFolder, isReloadNeeded, lock, reload, unlock

Methods inherited from interface oracle.owb.foundation.OWBNamedObject

delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName

Methods inherited from interface oracle.owb.metadatamgmt.changemgmt.Snapshotable

compare, compare, compare, compare, createSnapshot, createSnapshot, createSnapshotWithDependeeComponents, createSnapshotWithDependeeComponents, getSnapshots

Methods inherited from interface oracle.owb.reconcile.ReconcileSource

getReconcileTargetTypes, getType

Methods inherited from interface oracle.owb.reconcile.ReconcileTarget

canMatchByPosition, getReconcileSourceTypes, getType

Methods inherited from interface oracle.owb.foundation.property.PropertyOwner

getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString

Methods inherited from interface oracle.owb.compile.ValidatableObject

validate

Methods inherited from interface oracle.owb.compile.CompilableObject

compile

Method Detail

getModule

public Module getModule()

Gets the owning Module of the ExternalTable

Returns:

the Module object which contains this ExternalTable

setReferencedRecord

public void setReferencedRecord(Record record)

Sets the corresponding Record for the ExternalTable. The ExternalTable will use this Record to generate its access parameters. After calling this method a set of ExternalTableColumns will be created which will correspond to the referenced Record's Fields. Once set, the referenced Record cannot be changed.

Parameters:

record - the Record from which this ExternalTable is derived

getReferencedRecord

public Record getReferencedRecord()

Gets the corresponding Record for the ExternalTable. The ExternalTable will use this Record to generate its access parameters.

Returns:

the Record from which this ExternalTable is derived

setDefaultLocation

public void setDefaultLocation(Location location)

Sets the default location of the ExternalTable's datafiles, log files, discard files, and bad files.

Parameters:

location - the Location to be used as default.

getDefaultLocation

public Location getDefaultLocation()

Gets the default location of the ExternalTable's datafiles, log files, discard files, and bad files.

Returns:

the Location used as default.

setAccessParameters

public void setAccessParameters(java.lang.String parameters)

Sets the access parameters for the ExternalTable. Use this method if you want to set the access parameters as a String instead of letting OWB generate them from the referenced Record.

Parameters:

parameters - a String containing the file access parameters of this ExternalTable

getAccessParameters

public java.lang.String getAccessParameters()

Gets the access parameters for the ExternalTable. Use this method if you set the access parameters as a String instead of letting OWB generate them from the referenced Record.

Returns:

a String containing the file access parameters of this ExternalTable

createColumn

public ExternalTableColumn createColumn(java.lang.String name)
                                 throws NameSpaceException,
                                        InvalidFormatException

Creates and adds a new ExternalTableColumn to the ExternalTable.

Parameters:

name - a String which will be the name of the new ExternalTableColumn. The name will be converted to all uppercase characters if it is not already.

Returns:

the ExternalTableColumn created by this method

Throws:

NameSpaceException - If the name has already been used by an ExternalTableColumn in this ExternalTable

InvalidFormatException - If the name is not a valid name for an ExternalTableColumn object. For example, it is too long or contains invalid characters.

createColumn

public ExternalTableColumn createColumn(java.lang.String name,
                                        int position)
                                 throws NameSpaceException,
                                        InvalidFormatException

Creates and adds a new ExternalTableColumn to the ExternalTable at the specified position.

Parameters:

name - a String which will be the name of the new ExternalTableColumn. The name will be converted to all uppercase characters if it is not already.

position - where this newly created ExternalTableColumn will be located in this ExternalTable.

Returns:

the ExternalTableColumn created by this method

Throws:

NameSpaceException - If the name has already been used by an ExternalTableColumn in this ExternalTable

InvalidFormatException - If the name is not a valid name for an ExternalTableColumn object. For example, it is too long or contains invalid characters.

getColumns

public ExternalTableColumn[] getColumns()

Gets an ordered list of the ExternalTable's columns.

Returns:

the array of ExternalTableColumns owned by this ExternalTable

findColumn

public ExternalTableColumn findColumn(java.lang.String name)

Finds an ExternalTableColumn in the ExternalTable

Parameters:

name - a String specifying the name of the ExternalTableColumn to find. It is case sensitive.

Returns:

the ExternalTableColumn found; or null if no ExternalTableColumn exists of the given name

moveColumn

public void moveColumn(ExternalTableColumn column,
                       int newPosition)

Moves an ExternalTableColumn to a new position.

Parameters:

column - the ExternalTableColumn to move

newPosition - the position in this ExternalTable to move the column to.

getDatafiles

public Datafile[] getDatafiles()

Get the Data Files.

Returns:

an array containing the Datafiles (if any) configured for this external table.

createDatafile

public Datafile createDatafile(java.lang.String name)
                        throws NameSpaceException

Create a Data File.

Parameters:

the - name of the Datafile to create.

Returns:

a Datafile object.

Throws:

NameSpaceException - if a Datafile of that name already exists.

findDatafile

public Datafile findDatafile(java.lang.String name)

Find a Data File.

Parameters:

the - name of the Datafile to find.

Returns:

a Datafile object.

deleteDatafile

public void deleteDatafile(java.lang.String name)

Delete a Data File.

Parameters:

the - name of the Datafile to delete.