Main Page | Class Hierarchy | Class List | Class Members

kddml.Core.DataMining.SequentialPatterns.SequenceManager Interface Reference

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

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

Public Member Functions

boolean addElement (SequenceElementManager el)
boolean addElement (DelimiterManager d, SequenceElementManager el)
int getNumberOfElements ()
int getNumberOfItems ()
Integer getOccurrence ()
Double getSupport ()
Iterator sequenceIterator ()
Iterator getElements ()
boolean equals (Object sequence)
boolean contains (SequenceManager sm)
boolean contains (SequenceElementManager element)
boolean isSupported (DataSequenceManager dseq)
TimestampedTransactionManager[] coveringTransactions (DataSequenceManager dseq) throws AssociationModelException
TimestampedTransactionManager[] coarseCoveringTransactions (DataSequenceManager dseq)
SequenceManager subSequence (int from, int to)
void append (DelimiterManager delimiter, SequenceManager sequence)
void append (SequenceManager sequence)
DelimiterManager getPrecedingDelimiter (int index)
String toString ()
SequenceManager copy ()
void setSupport (Double support)
void setOccurrence (Integer occurrence)

Detailed Description

A sequence consists of:
  1. Optional attributes (support and occurrence);
  2. A list of sets composing the sequences (SequenceElementManager);
A sequence is structured as a set of consecutive elements (SequenceElementManager). Each of this elements is separated by the one that follows with a delimiter (DelimiterManager).

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

boolean kddml.Core.DataMining.SequentialPatterns.SequenceManager.addElement SequenceElementManager  el  ) 
 

Add an element to this sequence. The DEFAULT delimiter (see DelimiterType) is added between given and previous element.

Parameters:
el new element to be added
Returns:
true if element is added, false otherwise

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceManager.addElement DelimiterManager  d,
SequenceElementManager  el
 

Add an element to this sequence.

Parameters:
d delimiter between last element and the new one
el new element to be added
Returns:
true if element is added, false otherwise

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Return the numbers of element in this sequence.

Returns:
number of element

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Return the numbers of items in all element of this sequence.

Returns:
total umber of items

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Return the numbers of objects in the data for which this sequence holds true.

Returns:
number of occurrence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Return the ratio of the number of objects in the data for which this sequence holds true, to the total number of objects in the data.

Returns:
sequence support

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceManager.sequenceIterator  ) 
 

Return an iterator over all object in sequence. This include both elements and delimiters. Remember that each sequence element, except the last, is followed by a DelimiterManager, so a sequence iterator return a sequence of objects like: seq_element_obj, delimiter_obj, seq_element_obj, delimiter_obj, ...

Returns:
iterator over all objects in sequence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

Iterator kddml.Core.DataMining.SequentialPatterns.SequenceManager.getElements  ) 
 

Return an iterator over all elements in sequence. Delimiters object excluded.

Returns:
iterator over all elements in sequence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceManager.equals Object  sequence  ) 
 

Test if two sequence are equals. To be equals, sequences must have the same elements in the same order.

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

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceManager.contains SequenceManager  sm  ) 
 

Check if given sequence is contained in this one, i.e. if given sequence is a subset of this one. This method, also return true, if given sequence is equals to this one.

Parameters:
sm sequence to be checked
Returns:
true if sequence is contained, false otherwise

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Check if given sequence element belong to this sequence. This method return only if sequence element is equal to one in this sequence.

Parameters:
element sequence element to be checked
Returns:
true if sequence element belong to this sequene, false otherwise

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

boolean kddml.Core.DataMining.SequentialPatterns.SequenceManager.isSupported DataSequenceManager  dseq  ) 
 

Check if given data sequence support this sequence.

For each element e in this sequence, there is a transaction t such that e.isSupported(t) holds true, and is respected element order. E.g. s = (e1)...(em); d = (t1)...(tn) 1) m <= n 2) e(1).isSupported(ti) => e(2).isSupported(tj) , j > i

Parameters:
dseq data sequence to be checked
Returns:
true if given data sequence support this sequence, false otherwise

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

TimestampedTransactionManager [] kddml.Core.DataMining.SequentialPatterns.SequenceManager.coveringTransactions DataSequenceManager  dseq  )  throws AssociationModelException
 

This method return only those transactions (and relative items, i.e. only items in transactions that match items in sequence elements) in given data sequence, that support the sequence. If sequence is not support by given data sequence, this method return null.
This method works exactly as isSupported(DataSequenceManager dseq), except that instead of only checking which transactions support sequence elements, it return those transactions.

Parameters:
dseq DataSequenceManager data sequence to be checked
Returns:
TimestampedTransactionManager[] the set of transactions that support this sequence, or null if sequence is not supported
Exceptions:
AssociationModelException 

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

TimestampedTransactionManager [] kddml.Core.DataMining.SequentialPatterns.SequenceManager.coarseCoveringTransactions DataSequenceManager  dseq  ) 
 

This method return only those transactions in given data sequence, that support the sequence. Differently from coveringTransactions() method, this method return all items in those transactions, i.e. not only items in transaction that match items in sequence elements. If sequence is not support by given data sequence, this method return null.

This method works exactly as isSupported(DataSequenceManager dseq), except that instead of only checking which transactions support sequence elements, it return those transactions.

Parameters:
dseq data sequence to be checked
Returns:
the set of transactions that support this sequence, or null if sequence is not supported

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

SequenceManager kddml.Core.DataMining.SequentialPatterns.SequenceManager.subSequence int  from,
int  to
 

Return a subsequence starting at index "from" inclusive and ending at index "to" excluded. Returned sequence doesn't have neither support nor occurence. Index range is [0 - number of elements]. Calling sequence.subSequence(0, sequence.getNumberOfElements()) return a copy of sequence.

Parameters:
from start index (inclusive)
to end index (excluded)
Returns:
subsequence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

void kddml.Core.DataMining.SequentialPatterns.SequenceManager.append DelimiterManager  delimiter,
SequenceManager  sequence
 

Append a sequence to the end of this one.

Parameters:
delimiter a delimiter between old and new elements
sequence sequence to be appended

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

void kddml.Core.DataMining.SequentialPatterns.SequenceManager.append SequenceManager  sequence  ) 
 

Append a sequence to the end of this one. The DEFAULT delimiter (see DelimiterType) is added between given and previous sequence.

Parameters:
sequence sequence to be appended

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

DelimiterManager kddml.Core.DataMining.SequentialPatterns.SequenceManager.getPrecedingDelimiter int  index  ) 
 

Return delimiter object that precedes element with specified index. This method could be useful in conjunction with suSequence() method. Index range is [0, number of elements].

Parameters:
index element index
Returns:
delimiter

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

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

Return a string representation of this object.

Returns:
this object as string

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

SequenceManager kddml.Core.DataMining.SequentialPatterns.SequenceManager.copy  ) 
 

Make a copy of this sequence. Copy a sequence, mean copy the structure, support and occurrence; sequence elements and delimiters are not copied.

Returns:
new sequence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

void kddml.Core.DataMining.SequentialPatterns.SequenceManager.setSupport Double  support  ) 
 

Update sequence support Support must between 0 and 1 inclusive.

Parameters:
support new support

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.

void kddml.Core.DataMining.SequentialPatterns.SequenceManager.setOccurrence Integer  occurrence  ) 
 

Update number of occurrence

Parameters:
occurrence new occurence

Implemented in kddml.Core.DataMining.SequentialPatterns.Sequence.


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