Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.SequentialPatterns.SequenceRule Class Reference

Inheritance diagram for kddml.Core.DataMining.SequentialPatterns.SequenceRule:

kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager List of all members.

Public Member Functions

 SequenceRule (Sequence antecedent, Delimiter delimiter, Sequence consequent, double confidence, double support, int occurrence) throws IllegalArgumentException
void setTime (TimeManager time)
void setAntecedentTimes (TimeManager[] times) throws IllegalArgumentException
void setConsequentTimes (TimeManager[] times) throws IllegalArgumentException
SequenceManager getAntecedent ()
Iterator getAntecedentTimes ()
Double getConfidence ()
SequenceManager getConsequent ()
Iterator getConsequentTimes ()
DelimiterManager getDelimiter ()
int getNumberOfSequenceElements ()
Integer getOccurrence ()
Double getSupport ()
TimeManager getTime ()
boolean contains (SequenceManager sequence)
boolean equals (Object sequence_rule)
String toString ()

Protected Attributes

Double support
Double confidence
Integer occurrence

Detailed Description

Basically a rule tells the relation between the elements of a sequence, i.e. probability that an ordered group of elements in sequence follow another one.

A sequence rule consists of an antecedent and a consequent sequence, separated by a delimiter and, possibly, time.

Title: KDDML

Description: Knowledge Discovery in Database Environment

Copyright: Copyright (c) 2004

Company: Universita' di Pisa - Dipartimento di Informatica

Author:
Daniele Cerra (daniele@cerra.info)
Version:
2.0.0 alfa


Constructor & Destructor Documentation

kddml.Core.DataMining.SequentialPatterns.SequenceRule.SequenceRule Sequence  antecedent,
Delimiter  delimiter,
Sequence  consequent,
double  confidence,
double  support,
int  occurrence
throws IllegalArgumentException
 

Build a new rule with given arguments.

Parameters:
antecedent antecedent sequence
delimiter delimiter between antecedent and consequent sequence
consequent consequence sequence
confidence rule confidence - between 0 and 1 inclusive
support rule support - between 0 and 1 inclusive
occurrence number of occurrence of rule - greater than 0
Exceptions:
IllegalArgumentException if confidence, support or occurence don't respect specified range values


Member Function Documentation

void kddml.Core.DataMining.SequentialPatterns.SequenceRule.setTime TimeManager  time  ) 
 

Set time between antecedent and consequent sequences.

Parameters:
time time between sequences

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceRule.setAntecedentTimes TimeManager[]  times  )  throws IllegalArgumentException
 

Set times between elements in antecedent sequence. Each TimeManager object represent time information between two following elements in sequence. E.g. let be s = <e1, e2, e3> the antecedent sequence, setting times for s, mean to give two time information, respectively the time between e1 and e2, and the time between e2 and e3.

Parameters:
times times between elements
Exceptions:
IllegalArgumentException times mismatch elements in antecedent sequence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceRule.setConsequentTimes TimeManager[]  times  )  throws IllegalArgumentException
 

Set times between elements in consequent sequence. Each TimeManager object represent time information between two following elements in sequence. E.g. let be s = <e1, e2, e3> the consequent sequence, setting times for s, mean to give two time information, respectively the time between e1 and e2, and the time between e2 and e3.

Parameters:
times times between elements
Exceptions:
IllegalArgumentException times mismatch elements in consequent sequence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

SequenceManager kddml.Core.DataMining.SequentialPatterns.SequenceRule.getAntecedent  ) 
 

Return antecedent sequence composing this rule.

Returns:
antecedent sequence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceRule.getAntecedentTimes  ) 
 

Return an iterator over times between elements in antecedent sequence.

Returns:
antecedent sequence times iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

Double kddml.Core.DataMining.SequentialPatterns.SequenceRule.getConfidence  ) 
 

Return confidence of this rule: probability of the consequent following the antecedent. Calculated as the number of occurrences of a sequence divided by the number of occurrences of the antecedent.

Confidence is expressed as probabilistic number between 0 and 1.

Returns:
confidence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

SequenceManager kddml.Core.DataMining.SequentialPatterns.SequenceRule.getConsequent  ) 
 

Return consequent sequence composing this rule.

Returns:
consequent sequence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceRule.getConsequentTimes  ) 
 

Return an iterator over times between elements in consequent sequence.

Returns:
consequent sequence times iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

DelimiterManager kddml.Core.DataMining.SequentialPatterns.SequenceRule.getDelimiter  ) 
 

Return delimiter between antecedent and consequent sequence.

Returns:
delimiter

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

int kddml.Core.DataMining.SequentialPatterns.SequenceRule.getNumberOfSequenceElements  ) 
 

Return the total number of sequence elements in both the antecedent and consequent sequences.

Returns:
number of sequence elements

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceRule.getOccurrence  ) 
 

Return number of occurrence of this rule: the number of objects in the data for which the antecedent and consequent sequences hold true.

Returns:
occurrence

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

Double kddml.Core.DataMining.SequentialPatterns.SequenceRule.getSupport  ) 
 

Return support of this rule: the ratio of the number of objects in the data for which the antecedent and consequent Sequences hold true, to the total number of objects in the data.

Support is expressed as probabilistic number between 0 and 1.

Returns:
support

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

TimeManager kddml.Core.DataMining.SequentialPatterns.SequenceRule.getTime  ) 
 

Return time between antecedent and consequent sequence.

Returns:
time

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceRule.contains SequenceManager  sequence  ) 
 

Check if antecedent or consequent sequences contain given sequence.

Parameters:
sequence sequence to be checked
Returns:
true if sequence belog to this rule

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceRule.equals Object  sequence_rule  ) 
 

Check when two rules are equals. To be equal, two rules must have the same antecedent and consequent sequences.

Parameters:
sequence_rule object to be checked
Returns:
true if objects are equals, false otherwise

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.

String kddml.Core.DataMining.SequentialPatterns.SequenceRule.toString  ) 
 

Return a string representation of rule.

Returns:
this object as string

Implements kddml.Core.DataMining.SequentialPatterns.SequenceRuleManager.


Member Data Documentation

Double kddml.Core.DataMining.SequentialPatterns.SequenceRule.support [protected]
 

The ratio of the number of objects in the data for which the antecedent and consequent Sequences hold true, to the total number of objects in the data.

Double kddml.Core.DataMining.SequentialPatterns.SequenceRule.confidence [protected]
 

Probability of the consequent following the antecedent. Calculated as the number of occurrences of a sequence divided by the number of occurrences of the antecedent.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceRule.occurrence [protected]
 

The number of objects in the data for which the antecedent and consequent sequences hold true.


Generated on Thu Feb 23 13:04:42 2006 for kddml by  doxygen 1.4.3