Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.SequentialPatterns.SequenceModel Class Reference

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

kddml.Core.DataMining.MiningModel kddml.Core.DataMining.SequentialPatterns.SequenceModelManager kddml.Core.KDDMLObject kddml.Core.DataMining.MiningModelManager kddml.Core.DataMining.MiningModelManager kddml.Core.HTMLTranslator List of all members.

Public Member Functions

KDDMLObjectType getType ()
boolean isEmpty ()
void saveToRepository () throws kddml.Core.KDDMLCoreException
String toString ()
void saveHTML () throws KDDMLCoreException
SequenceModelManager clone (File output_path)
boolean addSequence (SequenceManager sequence)
void addSequences (SequenceManager[] sequences)
boolean addRule (SequenceRuleManager rule)
void addRules (SequenceRuleManager[] rules)
boolean removeRule (SequenceRuleManager rule)
void removeRules (SequenceRuleManager[] rules)
boolean removeSequence (SequenceManager sequence)
void removeSequences (SequenceManager[] sequences)
boolean contains (SequenceRuleManager rule)
boolean contains (SequenceManager sequence)
boolean contains (SequenceElementManager element)
boolean contains (ItemManager item)
Iterator getItems ()
Iterator getSequenceElements ()
Iterator getSequences ()
Iterator getSequenceRules ()
Integer getNumberOfTransactions ()
Integer getMaxNumberOfItemsPerTransaction ()
Double getAvgNumberOfItemsPerTransaction ()
Double getMinimumSupport ()
Double getMinimumConfidence ()
Integer getLengthLimit ()
int getNumberOfItems ()
int getNumberOfElements ()
int getNumberOfSequences ()
int getNumberOfRules ()
Integer getTimeWindowWidth ()
Integer getMinimumTime ()
Integer getMaximumTime ()
Object sequencesToInstances ()

Static Public Attributes

static int MAX_NUMBER_OF_SEQUENCES = 5000
static int MAX_NUMBER_OF_RULES = 5000

Detailed Description

The problem of discovering sequential patterns is to find inter-transaction patterns such that the presence of a set of items is followed by another item in the time-stamp ordered transaction set. As instance, in a web server transaction logs, a visit by a client is recorded over a period of time. The time stamp associated with a transaction in this case will be a time interval which is determined and attached to the transaction during the data cleaning or transaction identification processes.
A sequence model consists of four major parts:
  1. model attributes (such as minimum support, minimum confidence, etc.);
  2. a list of items;
  3. a list of sets composing the sequences (either Itemsets or SetPredicates);
  4. a list of frequent sequences;
  5. a list of sequence rules.
Items, sets, sequences and sequence rules are ordered using a precise criterium and this objects are mantained in a TreeSet ordered structure. A SequenceModel can contain any number of itemsets and sequences.

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


Member Function Documentation

KDDMLObjectType kddml.Core.DataMining.SequentialPatterns.SequenceModel.getType  )  [virtual]
 

It returns the type of the object.

Returns:
KDDMLObjectType

Implements kddml.Core.KDDMLObject.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.isEmpty  )  [virtual]
 

Returns ture if the model do not contain sequences nor sequence rules.

Returns:
true if there are no sequences nor sequences rules.

Implements kddml.Core.KDDMLObject.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.saveToRepository  )  throws kddml.Core.KDDMLCoreException [virtual]
 

Save the object in the system repository. The destination path is provided by the object_path variable.

Exceptions:
KDDMLCoreException 

Implements kddml.Core.KDDMLObject.

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

Return a string representation of this object.

Returns:
this object as string

Reimplemented from kddml.Core.DataMining.MiningModel.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.saveHTML  )  throws KDDMLCoreException [virtual]
 

Saves the object in the system repository as HTML document.

Exceptions:
KDDMLCoreException 

Implements kddml.Core.HTMLTranslator.

SequenceModelManager kddml.Core.DataMining.SequentialPatterns.SequenceModel.clone File  output_path  ) 
 

Clones this model returning a new one. Model Returned is a shallow copy of this one (The elements themselves (items, sequence elements, sequences and sequence rules) are not cloned).

Parameters:
output_path File the path in the model system repository containing the cloned model
Returns:
cloned model

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.addSequence SequenceManager  sequence  ) 
 

Adds a sequence to this model. If sequence is already contained in this model, or sequence support is less than minimum support, sequence is not added. If sequence is added, sequence elements composing it are added too.

Parameters:
sequence sequence to be added
Returns:
true if sequence is added

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.addSequences SequenceManager[]  sequences  ) 
 

Adds a set of sequences to this model. If a sequence is already contained in this model, or it's support is less than minimum support, sequence is not added. For each sequence added, sequence elements composing it are added too.

Parameters:
sequences sequences to be added

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.addRule SequenceRuleManager  rule  ) 
 

Adds a rule to this model. If rule is already contained in this model, or confidence of rule is less than minimum confidence, or support of rule is less than minimum support, rule is not added. If rule is added, sequences composing it are added too.

Parameters:
rule rule to be added
Returns:
true if rule is added

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.addRules SequenceRuleManager[]  rules  ) 
 

Adds a set of rules to this model. If a rule is already contained in this model, or confidence of a rule is less than minimum confidence, or support of a rule is less than minimum support, rule is not added. For eacg rule added, sequences composing it are added too.

Parameters:
rules rules to be added

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.removeRule SequenceRuleManager  rule  ) 
 

Removes a rule from model. Removing a rule from model doesn't affect sequences composing it, i.e. sequences are not removed.

Parameters:
rule rule to be removed
Returns:
true if rule is removed

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.removeRules SequenceRuleManager[]  rules  ) 
 

Removes a set of rules from model. Removing a rule from model doesn't affect sequences composing it, i.e. sequences are not removed.

Parameters:
rules rules to be removed

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.removeSequence SequenceManager  sequence  ) 
 

Removes a sequence from model. All referred rules are removed too.

Parameters:
sequence sequence to be removed
Returns:
true if sequence is removed

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

void kddml.Core.DataMining.SequentialPatterns.SequenceModel.removeSequences SequenceManager[]  sequences  ) 
 

Removes a set of sequences from model. All referred rules are removed too.

Parameters:
sequences sequences to be removed

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.contains SequenceRuleManager  rule  ) 
 

Checks if this model contain given rule.

Parameters:
rule rule to be cheked
Returns:
true if rule is contained

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

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

Checks if this model contain given sequence.

Parameters:
sequence Ssequence to be cheked
Returns:
true if sequence is contained

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.contains SequenceElementManager  element  ) 
 

Checks if this model contain given element.

Parameters:
element element to be checked
Returns:
true if element is contained

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceModel.contains ItemManager  item  ) 
 

Checks if this model contain givenitem

Parameters:
item item to be checked
Returns:
true if item is contained

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceModel.getItems  ) 
 

Returns an iterator over all items in this model.

Returns:
an items iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceModel.getSequenceElements  ) 
 

Returns an iterator over all sequence elements in this model.

Returns:
a sequence elements iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceModel.getSequences  ) 
 

Returns an iterator over all sequences in this model.

Returns:
a sequences iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceModel.getSequenceRules  ) 
 

Returns an iterator over all sequence rules in this model.

Returns:
a sequence rules iterator

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getNumberOfTransactions  ) 
 

Returns the number of transactions of input data used to build this model.

Returns:
number of transactions

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getMaxNumberOfItemsPerTransaction  ) 
 

Returns the maximum number of items per transactions of input data used to build this model.

Returns:
max number of items per transactions

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Double kddml.Core.DataMining.SequentialPatterns.SequenceModel.getAvgNumberOfItemsPerTransaction  ) 
 

Returns the average number of items per transactions of input data used to build this model.

Returns:
average number of items per transactions. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Double kddml.Core.DataMining.SequentialPatterns.SequenceModel.getMinimumSupport  ) 
 

Returns minimum support of sequences.

Returns:
minimum support. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Double kddml.Core.DataMining.SequentialPatterns.SequenceModel.getMinimumConfidence  ) 
 

Returns minimum confidence of sequence rules.

Returns:
minimum confidence. Can be null

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getLengthLimit  ) 
 

Returns the maximum length of a sequence to be discovered.

Returns:
lenght limit. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.getNumberOfItems  ) 
 

Returns the total number of items belonging to this model.

Returns:
total number of items

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.getNumberOfElements  ) 
 

Returns the total number of sequence elements belonging to this model.

Returns:
total number of sequence elements

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.getNumberOfSequences  ) 
 

Returns the total number of sequences belonging to this model.

Returns:
total number of sequences

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.getNumberOfRules  ) 
 

Returns the total number of sequence rules belonging to this model.

Returns:
total number of sequence rules

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getTimeWindowWidth  ) 
 

Returns the time window width: this may be used to separate items associated with an object into discrete events, but only if no clear key already exists for the separate events. Two consecutive items must have a time gap of less than this value to be considered as being part of the same event.

Returns:
time window width. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getMinimumTime  ) 
 

Returns the minimum time between items (see getTimeWindowWidth())

Returns:
minimum time. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Integer kddml.Core.DataMining.SequentialPatterns.SequenceModel.getMaximumTime  ) 
 

Returns the maximum time between items (see getTimeWindowWidth())

Returns:
miximum time. Can be null.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.

Object kddml.Core.DataMining.SequentialPatterns.SequenceModel.sequencesToInstances  ) 
 

Returns a representation of the sequences contained in the model as a set of instances. The table have a total number of instances given by the number of sequences, and 5 fields representing:

  1. the sequence as string (attribute sequence);
  2. the support of sequence (attribute sequence_support).
  3. the length of sequence (attribute sequence_cardinality);
  4. the number of distinct items (attribute sequence_distinct_items_cardinality).
  5. the maximum number of items per set (attribute max_number_of_items_per_set).

Returns:
the set of instances representing all sequences present in model.

Implements kddml.Core.DataMining.SequentialPatterns.SequenceModelManager.


Member Data Documentation

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.MAX_NUMBER_OF_SEQUENCES = 5000 [static]
 

Max number of sequences that the model can contains.

int kddml.Core.DataMining.SequentialPatterns.SequenceModel.MAX_NUMBER_OF_RULES = 5000 [static]
 

Max number of sequence rules that the model can contains.


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