oracle.javatools.db.ora
Class OracleExternalTableProperties.LocationSpecifier

java.lang.Object
  oracle.javatools.db.ora.OracleExternalTableProperties.LocationSpecifier

All Implemented Interfaces:

Copyable

Enclosing class:

OracleExternalTableProperties

public static class OracleExternalTableProperties.LocationSpecifier
extends java.lang.Object
implements Copyable

The LOCATION clause lets you specify one or more external data sources. A LocationSpecifier object represents one entry in a LOCATION clause.

Usually the LocationSpecifier is a file, but it need not be. Oracle Database does not interpret this clause. It is up to the access driver to interpret this information in the context of the external data. You cannot use wildcards in the LocationSpecifier to specify multiple files.

Constructor Summary

OracleExternalTableProperties.LocationSpecifier()
Creates an empty LocationSpecifier.

OracleExternalTableProperties.LocationSpecifier(DBObjectID directory, java.lang.String specifier)
Creates a LocationSpecifier with the given location and Directory.

OracleExternalTableProperties.LocationSpecifier(java.lang.String specifier)
Creates a LocationSpecifier with the given location, to use the default Directory.

Method Summary

java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(OracleExternalTableProperties.LocationSpecifier copy)
boolean	equals(java.lang.Object target)
protected boolean	equalsImpl(OracleExternalTableProperties.LocationSpecifier target)
DBObjectID	getDirectory() Gets the id for the Directory this location is using.
java.lang.String	getSpecifier() Gets the location in the Directory being specified.
void	setDirectory(DBObjectID directory) Sets the id for the Directory this location is using.
void	setSpecifier(java.lang.String specifier) Sets the location in the Directory being specified.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OracleExternalTableProperties.LocationSpecifier

public OracleExternalTableProperties.LocationSpecifier()

Creates an empty LocationSpecifier.

OracleExternalTableProperties.LocationSpecifier

public OracleExternalTableProperties.LocationSpecifier(java.lang.String specifier)

Creates a LocationSpecifier with the given location, to use the default Directory.

OracleExternalTableProperties.LocationSpecifier

public OracleExternalTableProperties.LocationSpecifier(DBObjectID directory,
                                                       java.lang.String specifier)

Creates a LocationSpecifier with the given location and Directory.

Parameters:

directory - the id of the Directory to use.

specifier - the location in that Directory being specified.

Method Detail

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected void copyToImpl(OracleExternalTableProperties.LocationSpecifier copy)

equals

public boolean equals(java.lang.Object target)

Overrides:

equals in class java.lang.Object

equalsImpl

protected boolean equalsImpl(OracleExternalTableProperties.LocationSpecifier target)

setDirectory

public void setDirectory(DBObjectID directory)

Sets the id for the Directory this location is using. If null the Directory of the owning OracleExternalTableProperties is used.

getDirectory

public DBObjectID getDirectory()

Gets the id for the Directory this location is using. If null the Directory of the owning OracleExternalTableProperties should be used.

setSpecifier

public void setSpecifier(java.lang.String specifier)

Sets the location in the Directory being specified.

getSpecifier

public java.lang.String getSpecifier()

Gets the location in the Directory being specified.