oracle.dmt.odm.data
Class PhysicalDataSpecification

java.lang.Object
  |
  +--oracle.dmt.odm.MiningObject
        |
        +--oracle.dmt.odm.data.PhysicalDataSpecification

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NonTransactionalDataSpecification, TransactionalDataSpecification

public abstract class PhysicalDataSpecification

extends MiningObject

The abstract class PhysicalDataSpecification is the common superclass for all data format classes. A PhysicalDataSpecification instance characterizes the layout of the physical data to be used for mining. For example, data can be in transactional or non-transactional form. In transactional format, the roles of various columns are identified. The data referenced by a PhysicalDataSpecification instance is used in several capacities: model building, scoring, lift computation, etc.

Since:

9.0.1

See Also:

Serialized Form

Method Summary

DataFormatType	getFormat() Returns the data format type: transactional or non-transactional.
LocationAccessData	getLocationAccessData() Returns the LocationAccessData instance identifying where the source data resides.
java.lang.String	getName()
static boolean	remove(Connection dmsConn, java.lang.String pdsName) Removes the specified physical data specification from the data mining server.
static boolean	rename(Connection dmsConn, java.lang.String oldObjectName, java.lang.String newObjectName) Renames the specified physical data specification .
void	store(Connection dmsConn, java.lang.String pdsName) Persists this instance of physical data specification with the given name in the specified ODM schema.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFormat

public DataFormatType getFormat()

Returns the data format type: transactional or non-transactional.

Returns:

pyhsical data format

getLocationAccessData

public LocationAccessData getLocationAccessData()

Returns the LocationAccessData instance identifying where the source data resides.

Returns:

pyhsical data access information

getName

public java.lang.String getName()

store

public void store(Connection dmsConn,
                  java.lang.String pdsName)
           throws InvalidArgumentException,
MiningObjectException,
                  java.sql.SQLException,
ODMException

Persists this instance of physical data specification with the given name in the specified ODM schema. The name must be unique within a user schema.

An instance of physical data specification may be modified until store method is executed on it. When a physical data specification object is restored, its initial status is mutable. However, if a user wants to store this instance in the data mining server, a different name must be assigned to this instance. This means that once a physical data specification object is persisted with a name in the data mining server, it is immutable.

Parameters:

dmsConn - A connection to the data mining server

pdsName - The name of the mining function settings to be stored

Throws:

InvalidArgumentException -

• dmsConn is null, or
• pdsName is null.
• pdsName is empty or exceeds 30 characters in length.

java.sql.SQLException - when an error occurs during the execution of store.

MiningObjectException

ODMException

remove

public static boolean remove(Connection dmsConn,
                             java.lang.String pdsName)
                      throws java.sql.SQLException,
MiningObjectException,
InvalidArgumentException,
ODMException

Removes the specified physical data specification from the data mining server.

Parameters:

dmsConn - A connection to the data mining server

pdsName - The name of the physical data specification to be removed

Returns:

boolean - A flag indicating whether the specified object has been removed successfully.

Throws:

InvalidArgumentException -

• dmsConn is null, or
• pdsName is null.

ODMException - when pdsName is empty or exceeds 30 bytes in length.

java.sql.SQLException - when an error occurs during the removal

MiningObjectException - when the mining function settings does not exist in the data mining server.

rename

public static boolean rename(Connection dmsConn,
                             java.lang.String oldObjectName,
                             java.lang.String newObjectName)
                      throws java.sql.SQLException,
InvalidArgumentException,
ODMException

Renames the specified physical data specification .

Parameters:

dmsConn - A connection to the data mining server

oldObjectName - The name of the physical data specification to be renamed

newObjectName - The new name of the physical data specification to be assigned

Returns:

boolean - A flag indicating whether the specified object has been renamed successfully.

Throws:

InvalidArgumentException -

• dmsConn is null, or
• oldObjectName is null,
• newObjectName is null.

ODMException - when oldObjectName or newObjectName is empty or exceeds 30 bytes in length.

java.sql.SQLException - when an error occurs during the rename operation

Since:

10.1