|
|||||||||
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.model.MiningModel | +--oracle.dmt.odm.model.AssociationRulesModel
The abstract class AssociationRulesModel
is a Java representation of
the association rules model.
This class provides methods to access the rules in the model.
Method Summary |
Type | Method |
---|---|
java.lang.String |
getAntecedentTableName()
Returns the rules table name that contains the antecedents of the rules found in this instance of assocication rules model. |
float |
getAverageNumberOfItemsPerTransaction()
Returns the average number of items per transaction in the data used to build this instance of assocication rules model. |
Category[] |
getItems()
Returns the items in the input data used to build this instance of assocication rules model. |
int |
getMaxNumberOfItemsPerTransaction()
Returns the maximum number of items per transaction in the data used to build this instance of assocication rules model. |
int |
getNumberOfItems()
Returns the number of items in the data used to build this instance of assocication rules model. |
int |
getNumberOfRules()
Returns the number of rules found in this instance of assocication rules model. |
int |
getNumberOfTransactions()
Returns the number of transactions in the data used to build this instance of assocication rules model. |
static MiningRuleSet |
getRules(Connection dmsConn,
java.lang.String modelName,
int maxNumRules,
RuleSortCriteria sortOrder)
Returns an instance of MiningRuleSet that contains the specified
number of rules
sorted in the specified order (confidence or support). |
static MiningRuleSet |
getRulesByConfidence(Connection dmsConn,
java.lang.String modelName,
float confidence,
int maxNumRules)
Returns an instance of MiningRuleSet that contains the specified
number of rules whose confidence is greater than the specified value. |
static MiningRuleSet |
getRulesByContents(Connection dmsConn,
java.lang.String modelName,
java.lang.String[] antecedentList,
java.lang.String[] consequentList,
int maxNumRules)
Returns an instance of MiningRuleSet that contains the specified
items as antecedent and consequent. |
static MiningRuleSet |
getRulesBySupport(Connection dmsConn,
java.lang.String modelName,
float support,
int maxNumRules)
Returns an instance of MiningRuleSet that contains the specified
number of mining rules whose support is greater than the specified value. |
java.lang.String |
getRuleTableName()
Returns the rules table name that contains the information on the rules found in this instance of assocication rules model. |
static AssociationRulesModel |
restore(Connection dmsConn,
java.lang.String modelName)
Returns an instance of AssociationRulesModel with the specified name
persisted in the data mining server. |
Methods inherited from class oracle.dmt.odm.model.MiningModel |
build, getBinCategoricalTableName, getBinNumericTableName, getMiningAlgorithm, getMiningFunction, getMiningFunctionSettings, getModelName, listContents, listContents, listContents, listContents, remove, setModelNameForMig |
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 int getNumberOfTransactions()
public int getMaxNumberOfItemsPerTransaction()
public float getAverageNumberOfItemsPerTransaction()
public int getNumberOfItems()
public int getNumberOfRules()
public java.lang.String getRuleTableName()
public java.lang.String getAntecedentTableName()
public Category[] getItems()
public static MiningRuleSet getRules(Connection dmsConn, java.lang.String modelName, int maxNumRules, RuleSortCriteria sortOrder) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
MiningRuleSet
that contains the specified
number of rules
sorted in the specified order (confidence or support).dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the rules are extractedmaxNumRules
- The maximum number of rules to be extractedsortOrder
- The sort order by which the rules are sorted
(either support or confidence)MiningRuleSet
that contains
the retrieved mining rulesInvalidArgumentException
- when dmsConn
, modelName
,
or sortOrder
is null, or maxNumRules
is not a
positive integer.java.sql.SQLException
- when an error occurs during the retrieval of rulesMiningObjectException
- when an invalid mining rule is foundMiningRuleSet
public static MiningRuleSet getRulesBySupport(Connection dmsConn, java.lang.String modelName, float support, int maxNumRules) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
MiningRuleSet
that contains the specified
number of mining rules whose support is greater than the specified value.dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the rules are extractedsupport
- The support value for the rulesmaxNumRules
- The maximum number of rules to be extractedMiningRuleSet
that contains
the retrieved mining rulesInvalidArgumentException
- when dmsConn
, modelName
,
or maxNumRules
is not a positive integer, or
support
is out of range (negative or greater than 1).java.sql.SQLException
- when an error occurs during the retrieval of rulesMiningObjectException
- when an invalid mining rule is foundMiningRuleSet
public static MiningRuleSet getRulesByConfidence(Connection dmsConn, java.lang.String modelName, float confidence, int maxNumRules) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
MiningRuleSet
that contains the specified
number of rules whose confidence is greater than the specified value.dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the rules are extractedconfidence
- The confidence value for the rulesmaxNumRules
- The maximum number of rules to be extractedMiningRuleSet
that contains
the retrieved mining rulesInvalidArgumentException
- when dmsConn
, modelName
,
or maxNumRules
is not a positive integer, or
confidence
is out of range (non-positive or greater than 1).java.sql.SQLException
- when an error occurs during the retrieval of rulesMiningObjectException
- when an invalid mining rule is foundMiningRuleSet
public static MiningRuleSet getRulesByContents(Connection dmsConn, java.lang.String modelName, java.lang.String[] antecedentList, java.lang.String[] consequentList, int maxNumRules) throws java.sql.SQLException, InvalidArgumentException, MiningObjectException, ODMException
MiningRuleSet
that contains the specified
items as antecedent and consequent.dmsConn
- The connection to the data mining servermodelName
- The name of the model from which the rules are extractedantecedentList
- A list of antecedent itemsconsequentList
- A list of consequent itemsMiningRuleSet
that contains
the retrieved mining rulesInvalidArgumentException
- when dmsConn
, modelName
,
or maxNumRules
is not a positive integer, or
both antecedentList
and consequentList
are null.java.sql.SQLException
- when an error occurs during the retrieval of rulesMiningObjectException
- when an invalid mining rule is found- See Also:
MiningRuleSet
public static AssociationRulesModel restore(Connection dmsConn, java.lang.String modelName) throws java.sql.SQLException, MiningObjectException, InvalidArgumentException, ODMException
AssociationRulesModel
with the specified name
persisted in the data mining server.dmsConn
- The connection to the data mining servermodelName
- The name of the model to be restoredAssociationRulesModel
restoredInvalidArgumentException
- when dmsConn
or modelName
is null.ODMException
- when modelName
is empty or exceeds 30 acharacter
in length.java.sql.SQLException
- when an error occurs during the retrieval of the modelMiningObjectException
- when the restored model is not an instance of
AssociationRulesModel
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |