oracle.javatools.db.ora
Class OracleExternalTableProperties

java.lang.Object
  oracle.javatools.db.AbstractDBObject
      oracle.javatools.db.AbstractChildDBObject
          oracle.javatools.db.ora.OracleExternalTableProperties

All Implemented Interfaces:

ChildDBObject, DBObject, Copyable, DynamicPropertySet

public class OracleExternalTableProperties
extends AbstractChildDBObject

An external table is one whose metadata (definition) is stored in the database but whose data is stored outside the database. This object represents the properties associated with the external table clause for specifying such tables.

• An external table cannot be a temporary table.
• You cannot specify constraints on an external table.
• An external table cannot have object type, varray, or LONG columns. However, you can populate LOB columns of an external table with varray or LONG data from an internal database table.

The class extends AbstractChildDBObject so that it can implement replaceReferenceIDs() and getReferenceIDsImpl() for the default and location specifier directories.

Nested Class Summary

static class	OracleExternalTableProperties.AccessType Allowed values for the access parameter type.
static class	OracleExternalTableProperties.LocationSpecifier The LOCATION clause lets you specify one or more external data sources.
static class	OracleExternalTableProperties.ProjectColumn

Nested classes/interfaces inherited from class oracle.javatools.db.AbstractDBObject

AbstractDBObject.ChildSupport

Field Summary

static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP
static java.lang.String	ACCESS_DRIVER_TYPE_ORACLE_LOADER
static java.lang.String	KEY KEY for use in getProperty/setProperty on a Table object to query the external table properties.
static java.lang.String	REJECT_LIMIT_UNLIMITED
static java.lang.String	TYPE

Fields inherited from interface oracle.javatools.db.DBObject

COMMENT

Constructor Summary

OracleExternalTableProperties()
Creates an empty OracleExternalTableProperties object, which is used to define the properties of an external table.

Method Summary

void	addLocationSpecifier(DBObjectID directory, java.lang.String specifier) Adds a location specifier that uses the given Directory (by ID) and the specified location.
void	addLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier) Adds the given location specifier.
void	addLocationSpecifier(java.lang.String specifier) Adds a location specifier that uses the given Directory (by ID) and the specified location.
DBObject	copyTo(DBObject target, DBObject copyParent, IDPolicy idPolicy) Internal copy method used by the API to perform copy operations.
protected void	copyToImpl(OracleExternalTableProperties copy, DBObject copyParent, IDPolicy idPolicy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(OracleExternalTableProperties target)
java.lang.String	getAccessDriverType() Get the access driver type.
java.lang.Object	getAccessParameters() Get the access driver's parameters.
DBObjectID	getDefaultDirectory() Gets the default Directory by ID.
OracleExternalTableProperties.LocationSpecifier[]	getLocationSpecifiers() Gets the LocationSpecifiers which are used to specify the external locations used to store the table's data.
OracleExternalTableProperties.ProjectColumn	getProjectColumn() Get the value of the 'alter table project column clause'.
protected void	getReferenceIDsImpl(java.util.Collection<DBObjectID> refs) Used by the final getReferenceID() implementation.
java.lang.String	getRejectLimit() Gets the reject limit for the external table.
java.lang.String	getType() Returns the type of this object.
boolean	isAccessUsingClob()
void	removeAllLocationSpecifiers() Clears the list of LocationSpecifiers.
void	removeLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier) Removes the given location specifier.
boolean	replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap) Override in subclasses to replace reference IDs as appropriate.
void	setAccessDriverType(java.lang.String accessDriverType) Set the access driver type.
void	setAccessParameters(java.lang.Object accessParameters) Set the access driver's parameters.
void	setAccessUsingClob(boolean usingClob)
void	setDefaultDirectory(DBObjectID directory) Sets the default Directory by ID.
void	setLocationSpecifiers(OracleExternalTableProperties.LocationSpecifier[] locationSpecifiers) Sets the LocationSpecifiers which are used to specify the external locations used to store the table's data.
void	setProjectColumn(OracleExternalTableProperties.ProjectColumn projectColumn) Set the value of the 'alter table project column clause'.
void	setRejectLimit(java.lang.String rejectLimit) Sets the reject limit for the external table.

Methods inherited from class oracle.javatools.db.AbstractChildDBObject

copyToImpl, findParent, getParent, setParent

Methods inherited from class oracle.javatools.db.AbstractDBObject

changeParent, compareToImpl, copyObject, copyTo, copyTo, copyTo, copyToImpl, equalsImpl, findOwnedObject, findOwnedObject, findOwnedObject, getChildSupport, getID, getName, getOwnedObjects, getOwnedObjects, getOwnedObjectsImpl, getProperties, getProperty, getProperty, getReferenceIDs, hashCode, includeOwnedObject, includesType, includesType, removeThisAsParent, setID, setName, setProperties, setProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.javatools.db.DBObject

copyTo, copyTo, copyTo, findOwnedObject, findOwnedObject, getID, getName, getOwnedObjects, getOwnedObjects, getReferenceIDs, setID, setName

Methods inherited from interface oracle.javatools.util.DynamicPropertySet

getProperties, getProperty, getProperty, setProperties, setProperty

Field Detail

KEY

public static final java.lang.String KEY

KEY for use in getProperty/setProperty on a Table object to query the external table properties.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_LOADER

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_LOADER

See Also:

Constant Field Values

ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

public static final java.lang.String ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

See Also:

Constant Field Values

REJECT_LIMIT_UNLIMITED

public static final java.lang.String REJECT_LIMIT_UNLIMITED

See Also:

Constant Field Values

Constructor Detail

OracleExternalTableProperties

public OracleExternalTableProperties()

Creates an empty OracleExternalTableProperties object, which is used to define the properties of an external table.

Method Detail

getType

public java.lang.String getType()

Description copied from interface: DBObject

Returns the type of this object. Valid types include things like tables, views, synonyms, and columns.

Returns:

a string describing the type of object.

copyTo

public DBObject copyTo(DBObject target,
                       DBObject copyParent,
                       IDPolicy idPolicy)

Description copied from class: AbstractDBObject

Internal copy method used by the API to perform copy operations. All objects must implement this method if they are instantiable objects. Abstract objects (e.g. Relation) must NOT implement this method. The implementation should delegate to the copyToImpl method to copy the actual properties.

This method does not fix internal reference ids on copy. That is done by the calling DBObject.copyTo(DBObject, IDPolicy) method.

Specified by:

copyTo in class AbstractDBObject

See Also:

DBObject.copyTo(java.lang.Object), DBObject.copyTo(DBObject, boolean), AbstractDBObject.copyToImpl(oracle.javatools.db.AbstractDBObject, oracle.javatools.db.DBObject, oracle.javatools.db.IDPolicy)

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

replaceReferenceIDs

public boolean replaceReferenceIDs(java.util.Map<DBObjectID,DBObjectID> idMap)

Description copied from class: AbstractDBObject

Override in subclasses to replace reference IDs as appropriate. Always call super in the overridden implementation to make sure the default implementation (which checks the property map) is called.

Specified by:

replaceReferenceIDs in interface DBObject

Overrides:

replaceReferenceIDs in class AbstractDBObject

Parameters:

idMap - key = old DBObjectID, value = new DBObjectID

Returns:

true if any ids were replaced.

getReferenceIDsImpl

protected void getReferenceIDsImpl(java.util.Collection<DBObjectID> refs)

Description copied from class: AbstractDBObject

Used by the final getReferenceID() implementation. The list should not contain null values, or be null. Subclasses should start with super.getReferenceIDsImpl() and then add to the passed list as appopriate.

Overrides:

getReferenceIDsImpl in class AbstractDBObject

Parameters:

refs - the collection of ids this object references

setDefaultDirectory

public void setDefaultDirectory(DBObjectID directory)

Sets the default Directory by ID. The default directory is used for any LocationSpecifiers that have a null directory.

getDefaultDirectory

public DBObjectID getDefaultDirectory()

Gets the default Directory by ID. The default directory is used for any LocationSpecifiers that have a null directory.

setLocationSpecifiers

public void setLocationSpecifiers(OracleExternalTableProperties.LocationSpecifier[] locationSpecifiers)

Sets the LocationSpecifiers which are used to specify the external locations used to store the table's data.

See Also:

OracleExternalTableProperties.LocationSpecifier

getLocationSpecifiers

public OracleExternalTableProperties.LocationSpecifier[] getLocationSpecifiers()

Gets the LocationSpecifiers which are used to specify the external locations used to store the table's data.

See Also:

OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier)

Adds the given location specifier.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(DBObjectID directory,
                                 java.lang.String specifier)

Adds a location specifier that uses the given Directory (by ID) and the specified location.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

addLocationSpecifier

public void addLocationSpecifier(java.lang.String specifier)

Adds a location specifier that uses the given Directory (by ID) and the specified location.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

removeLocationSpecifier

public void removeLocationSpecifier(OracleExternalTableProperties.LocationSpecifier locationSpecifier)

Removes the given location specifier.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

removeAllLocationSpecifiers

public void removeAllLocationSpecifiers()

Clears the list of LocationSpecifiers.

See Also:

setLocationSpecifiers(oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier[]), OracleExternalTableProperties.LocationSpecifier

setAccessDriverType

public void setAccessDriverType(java.lang.String accessDriverType)

Set the access driver type. Valid values are : ACCESS_DRIVER_TYPE_ORACLE_LOADER or null (default) ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

See Also:

ACCESS_DRIVER_TYPE_ORACLE_LOADER, ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

getAccessDriverType

public java.lang.String getAccessDriverType()

Get the access driver type.

See Also:

ACCESS_DRIVER_TYPE_ORACLE_LOADER, ACCESS_DRIVER_TYPE_ORACLE_DATAPUMP

setAccessParameters

public void setAccessParameters(java.lang.Object accessParameters)

Set the access driver's parameters. This may be an SQLQuery or String representing a USING CLOB subquery, or an OpaqueFormatSpec or String representing an opaque format spec.

getAccessParameters

public java.lang.Object getAccessParameters()

Get the access driver's parameters.

See Also:

setAccessParameters(java.lang.Object)

setAccessUsingClob

public void setAccessUsingClob(boolean usingClob)

isAccessUsingClob

public boolean isAccessUsingClob()

setRejectLimit

public void setRejectLimit(java.lang.String rejectLimit)

Sets the reject limit for the external table.

getRejectLimit

public java.lang.String getRejectLimit()

Gets the reject limit for the external table.

setProjectColumn

public void setProjectColumn(OracleExternalTableProperties.ProjectColumn projectColumn)

Set the value of the 'alter table project column clause'.

See Also:

OracleExternalTableProperties.ProjectColumn

getProjectColumn

public OracleExternalTableProperties.ProjectColumn getProjectColumn()

Get the value of the 'alter table project column clause'.

See Also:

OracleExternalTableProperties.ProjectColumn

copyToImpl

protected void copyToImpl(OracleExternalTableProperties copy,
                          DBObject copyParent,
                          IDPolicy idPolicy)

equalsImpl

protected boolean equalsImpl(OracleExternalTableProperties target)