|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.dmt.odm.MiningObject | +--oracle.dmt.odm.LocatableObject | +--oracle.dmt.odm.settings.function.MiningFunctionSettings
The abstract class MiningFunctionSettings
(MFS) captures the high level
specification input for building a data mining model.
In ODM, functions are divided into the following categories:
AssociationRulesFunctionSettings
AttributeImportanceFunctionSettings
ClusteringFunctionSettings
SupervisedFunctionSettings
ClassificationFunctionSettings
LogicalDataSpecification
,
DataUsageSpecification
, Serialized FormMethod Summary |
Type | Method |
---|---|
void |
activateAll()
Changes all mining attributes to have active attribute usage. |
void |
adjustAttributeUsage(java.lang.String[] attributesList,
AttributeUsage newAttrUsage)
Adjusts the data usage specification for the specified mining attributes to have new attribute usage. |
void |
adjustAttributeUsage(java.lang.String[] attributesList,
UsageAdjustment newAttrUsage)
Adjusts the data usage specification for the specified mining attributes based on the specified usage adjustment. |
void |
adjustDataPreparationStatus(java.lang.String[] attributesList,
DataPreparationStatus newPreparationStatus)
Adjusts the data usage specification based for the specified mining attributes to have new data preparation status. |
DataUsageSpecification |
getDataUsageSpecification()
Returns the data usage specification of the function settings. |
LogicalDataSpecification |
getLogicalDataSpecification()
Returns the logical data specification of the function settings. |
java.lang.String |
getMiningAlgorithmName()
Returns the name of mining algorithm used to build a mining model. |
MiningAlgorithmSettings |
getMiningAlgorithmSettings()
Returns the mining algorithm settings of the function settings, if any. |
MiningFunction |
getMiningFunction()
Returns the kind of mining function of this function settings. |
java.lang.String |
getName()
Returns the name of this mining function settings. |
MiningAttribute[] |
getSupplementalAttributes()
Returns an array of supplementary mining attributes in this fiunction settings. |
boolean |
getValidateBeforeStore()
Returns a flag that controls validation before the mining function settings object is persisted in the DMS. |
static java.lang.String[] |
listContents(Connection dmsConn)
Returns an array of the names of mining function settings persisted in the specified data mining server. |
static java.lang.String[] |
listContents(Connection dmsConn,
java.util.Date start,
java.util.Date end)
Returns an array of the names of mining function settings persisted within the specified time interval in the data mining server. |
static java.lang.String[] |
listContents(Connection dmsConn,
MiningFunction function,
MiningAlgorithm algorithm)
Returns an array of the names of mining function settings of the specified mining function type that contain the given algorithm type from the specified data mining server. |
static java.lang.String[] |
listContents(Connection dmsConn,
MiningFunction function,
MiningAlgorithm algorithm,
java.util.Date start,
java.util.Date end)
Returns an array of the names of mining function settings of the specified function type with the specified algorithm type that are persisted within the specified time interval in the data mining server. |
static void |
remove(Connection dmsConn,
java.lang.String settingsName)
Removes the specified mining function settings from the data mining server. |
static MiningFunctionSettings |
restore(java.sql.Connection dbConn,
java.lang.String settingsName)
Returns an instance of MiningFunctionSettings with the specified
name persisted in the data mining server
given a database connection and the function settings name. |
static MiningFunctionSettings |
restore(Connection dmsConn,
java.lang.String settingsName)
Returns an instance of MiningFunctionSettings with the specified
name persisted in the data mining server
given a connection to the data mining server and the function settings name. |
void |
setDataUsageSpecification(DataUsageSpecification dus)
Sets a data usage specification to this mining function settings. |
void |
setMiningAlgorithmName(java.lang.String name)
Deprecated. As of ODM 9.2.0. |
void |
setMiningAlgorithmSettings(MiningAlgorithmSettings algorithmSettings)
Sets a mining algorithm settings to be used to build a model. |
void |
setMiningFunction(MiningFunction function)
Deprecated. As of ODM 9.2.0. |
void |
setValidateBeforeStore(boolean validateControl)
Indicates that the mining function settings object is validated, if true, before it is persisted in the DMS. |
void |
store(Connection dmsConn,
java.lang.String settingsName)
Persists this instance of mining function settings with the given name in the specified ODM schema. |
Methods inherited from class oracle.dmt.odm.LocatableObject |
deserialize, serialize |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public LogicalDataSpecification getLogicalDataSpecification()
LogicalDataSpecification
- The logical data specification of this function
settings.public DataUsageSpecification getDataUsageSpecification()
DataUsageSpecification
- Tge data usage specification of this function
settings.public void setMiningAlgorithmSettings(MiningAlgorithmSettings algorithmSettings)
algorithmSettings
is null, the DMS will choose the default algorithm
settings that is appropriate for the function.algorithm
- A mining algorithm settingspublic MiningAlgorithmSettings getMiningAlgorithmSettings()
MiningAlgorithmSettings
- The algorithm settingspublic java.lang.String getMiningAlgorithmName()
String
- The name of the algorithmpublic void setMiningAlgorithmName(java.lang.String name) throws InvalidArgumentException
name
- The name of the algorithmInvalidArgumentException
- when name
is either null, or
an invalid algorithm name.public void setMiningFunction(MiningFunction function)
function
- The kind of mining function to be usedpublic MiningFunction getMiningFunction()
MiningFunction
- The kind of mining functionpublic java.lang.String getName()
store
method.
Therefore, this method returns null if the settings has not been stored.String
- The name of this mining function settingspublic void setDataUsageSpecification(DataUsageSpecification dus)
dus
- A data usage specificationDataUsageSpecification
public MiningAttribute[] getSupplementalAttributes()
MiningAttribute[]
- An array of mining attributesMiningAttribute
, DataUsageEntry
,
AttributeUsage
public static java.lang.String[] listContents(Connection dmsConn) throws java.sql.SQLException
dmsConn
- A connection to the data mining serverString[]
- The name of mining function settingsjava.sql.SQLException
- when an error occurs during the retrievalpublic static java.lang.String[] listContents(Connection dmsConn, MiningFunction function, MiningAlgorithm algorithm) throws java.sql.SQLException
dmsConn
- A connection to the data mining serverfunction
- The kind of mining functionalgorithm
- The kind of algorithmString[]
- The name of mining function settingsjava.sql.SQLException
- when an error occurs during the retrievalpublic static java.lang.String[] listContents(Connection dmsConn, java.util.Date start, java.util.Date end) throws java.sql.SQLException
start
or end
is null, the current
system time is used.dmsConn
- A connection to the data mining serverstart
- The start of the time intervalend
- The ending of the time intervalString[]
- The name of mining function settingsjava.sql.SQLException
- when an error occurs during the retrievalpublic static java.lang.String[] listContents(Connection dmsConn, MiningFunction function, MiningAlgorithm algorithm, java.util.Date start, java.util.Date end) throws java.sql.SQLException
start
or end
is null, the current
system time is used.dmsConn
- A connection to the data mining serverfunction
- The kind of mining functionalgorithm
- The kind of algorithmstart
- The start of the time intervalend
- The ending of the time intervalString[]
- The name of mining function settingsjava.sql.SQLException
- when an error occurs during the retrievalpublic void setValidateBeforeStore(boolean validateControl)
validateControl
- A Boolean flag to control validationpublic boolean getValidateBeforeStore()
public void store(Connection dmsConn, java.lang.String settingsName) throws java.sql.SQLException, java.io.IOException, InvalidArgumentException, MiningObjectException, ODMException
An instance of mining function settings may be modified
until store
method is executed on it.
When a mining function settings 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 mining function settings object is persisted
with a name in the data mining server, it is immutable.
dmsConn
- A connection to the data mining serversettingsName
- The name of the mining function settings to be storedInvalidArgumentException
- dmsConn
is null, or
settingsName
is null.
ODMException
- when
settingsName
is empty or exceeds 64 characters in length.MiningObjectException
- java.sql.SQLException
- when an error occurs during the execution of store.java.io.IOException
- Inherited exceptionpublic static MiningFunctionSettings restore(java.sql.Connection dbConn, java.lang.String settingsName) throws java.sql.SQLException
MiningFunctionSettings
with the specified
name persisted in the data mining server
given a database connection and the function settings name.dbConn
- A database connection to the data mining serversettingsName
- The name of the function settings to be restoredMiningFunctionSettings
- An instance of MiningFunctionSettings
restored
- SQLException
public static MiningFunctionSettings restore(Connection dmsConn, java.lang.String settingsName) throws java.sql.SQLException, InvalidArgumentException, ODMException
MiningFunctionSettings
with the specified
name persisted in the data mining server
given a connection to the data mining server and the function settings name.dmsConn
- A connection to the data mining serversettingsName
- The name of the function settings to be restoredMiningFunctionSettings
- An instance of MiningFunctionSettings
restored
- SQLException
public static void remove(Connection dmsConn, java.lang.String settingsName) throws java.sql.SQLException, MiningObjectException, InvalidArgumentException, ODMException
dmsConn
- A connection to the data mining serversettingsName
- The name of the mining function settings to be removedInvalidArgumentException
- dmsConn
is null, or
settingsName
is null,
ODMException
- when
settingsName
is empty or exceeds 64 characters in length.java.sql.SQLException
- when an error occurs during the removalMiningObjectException
- when the mining function settings
does not exist in the data mining serverpublic void adjustAttributeUsage(java.lang.String[] attributesList, AttributeUsage newAttrUsage) throws InvalidArgumentException
attributesList
- The names of the attributes to have new attribute usageInvalidArgumentException
- thrown when any of the arguments is null or
any of the specified mining attribute does not exist.AttributeUsage
public void adjustDataPreparationStatus(java.lang.String[] attributesList, DataPreparationStatus newPreparationStatus) throws InvalidArgumentException
attributesList
- The names of the mining attributes to have new data
preparation statusnewPreparationStatus
- The new data preparation status of the attributesInvalidArgumentException
- any of the arguments is null or
any of the specified mining attribute does not exist.AttributeUsage
public void adjustAttributeUsage(java.lang.String[] attributesList, UsageAdjustment newAttrUsage) throws InvalidArgumentException, MiningObjectException
attributesList
- The names of the mining attributes to be changednewAttrUsage
- Specifies how the new usage of the mining attributes
are to be changedInvalidArgumentException
- any of the arguments is null or
any of the specified mining attribute does not exist.UsageAdjustment
, AttributeUsage
public void activateAll() throws MiningObjectException
AttributeUsage
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |