oracle.dmt.odm
Class LocationAccessData

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.LocationAccessData
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
LocationCellAccessData

public class LocationAccessData
extends MiningObject

An instance of LocationAccessData allows users to specify the location of input and output data tables.

Since:
9.0.1
See Also:
Serialized Form

Constructor Summary
LocationAccessData(java.lang.String unifiedLocation)
          Creates an instance of LocationAccessData for the specified location string.
LocationAccessData(java.lang.String objectName, java.lang.String schemaName)
          Creates an instance of LocationAccessData for the specified object name and schema name.
 
Method Summary
TypeMethod
static LocationAccessData deserialize(byte[] obj)
          For internal use only.
 Location getLocation()
          For internal use only
 java.lang.String getObjectName()
          Returns the object name corresponding to the table when the object is stored.
 java.lang.String getSchema()
          Returns the schema name corresponding to the location when the object is located.
static boolean isEqual(LocationAccessData lad1, LocationAccessData lad2, LocationEqualityLevel lel)
          Compares two instances of LocationAccessData.
 byte[] serialize()
          For internal use only.
 java.lang.String toString()
          Converts location information contained in the object into a single string, which can then be used to create a LocationAccessData object.
 boolean validate(Connection connection)
          Validates that connection specifes an actual location.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LocationAccessData

public LocationAccessData(java.lang.String unifiedLocation)
                   throws InvalidArgumentException,
                          ODMException
Creates an instance of LocationAccessData for the specified location string. The format of a location string is schema.object.
Parameters:
unifiedLocation - string in the format schema.object
Throws:
InvalidArgumentException - is thrown
- when the unifiedLocation is null
- when the unifiedLocation > 64 bytes
- when the unifiedLocation is invalid format

LocationAccessData

public LocationAccessData(java.lang.String objectName,
                          java.lang.String schemaName)
                   throws InvalidArgumentException,
                          ODMException
Creates an instance of LocationAccessData for the specified object name and schema name.
Parameters:
objectName - object name
schemaName - schema name
Throws:
InvalidArgumentException - is thrown
- when the objectName is null
- when the objectName is > 30 bytes - when the schemaName is not null and it is > 30 bytes
Method Detail

getObjectName

public java.lang.String getObjectName()
Returns the object name corresponding to the table when the object is stored.
Returns:
object name

getSchema

public java.lang.String getSchema()
Returns the schema name corresponding to the location when the object is located.
Returns:
schema name

getLocation

public Location getLocation()
For internal use only

toString

public java.lang.String toString()
Converts location information contained in the object into a single string, which can then be used to create a LocationAccessData object.
Overrides:
toString in class java.lang.Object
Returns:
String in the format schema.object

validate

public boolean validate(Connection connection)
                 throws InvalidArgumentException,
                        ODMException
Validates that connection specifes an actual location. If the connection is successfully made, validate returns true, otherwise false.
Parameters:
connection - connection returned from DataMiningServer login
Returns:
boolean (true or false)
Throws:
InvalidArgumentException - is thrown
- when the connection is null
ODMException - is thrown
- when validation cannot be performed

isEqual

public static boolean isEqual(LocationAccessData lad1,
                              LocationAccessData lad2,
                              LocationEqualityLevel lel)
                       throws InvalidArgumentException
Compares two instances of LocationAccessData. If they are identical, returns true, otherwise, returns false.
Parameters:
lad1 - LocationAccessData
lad2 - LocationAccessData
lel - LocationEqualityLevel
Returns:
boolean true if equality level = schemaLevel and schema name match true if equality level = exactMatch and schema name and object name match false if otherwise
Throws:
InvalidArgumentException - is thrown
- when the lad1/lad2/lel are null

serialize

public byte[] serialize()
                 throws java.io.IOException
For internal use only.

deserialize

public static LocationAccessData deserialize(byte[] obj)
                                      throws java.io.IOException,
                                             java.lang.ClassNotFoundException
For internal use only.