ca.pfv.spmf.algorithms.sequentialpatterns.spade_spam_AGP

Class EquivalenceClass

java.lang.Object

ca.pfv.spmf.algorithms.sequentialpatterns.spade_spam_AGP.EquivalenceClass

All Implemented Interfaces:

java.lang.Comparable<EquivalenceClass>

public class EquivalenceClass
extends java.lang.Object
implements java.lang.Comparable<EquivalenceClass>

This is the definition of an equivalence class. Each one is composed by a pattern that its the class identifier and the IdList associated with that pattern. Besides, it also contains all the equivalence class children that are supersequences (by means i-extension or s-extension) of the class identifier. In this way a complete structure of classes can be created from the root class to the longest ones. Copyright Antonio Gomariz Peñalver 2013 This file is part of the SPMF DATA MINING SOFTWARE (http://www.philippe-fournier-viger.com/spmf). SPMF is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. SPMF is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with SPMF. If not, see .

Constructor Summary

Constructors

Constructor and Description
EquivalenceClass(Pattern classIdentifier) Constructor from a pattern.
EquivalenceClass(Pattern classIdentifier, IDList idList) Constructor from a pattern and an IdList.
EquivalenceClass(Pattern classIdentifier, java.util.List<EquivalenceClass> classMembers) Constructor from a pattern and a set of equivalence classes
EquivalenceClass(Pattern classIdentifier, java.util.List<EquivalenceClass> classMembers, IDList idList) Constructor from a pattern, an IdList and a set of equivvalence classes

Method Summary

Modifier and Type	Method and Description
void	addClassMember(EquivalenceClass classMember) Method to add an equivalence class as a new class' member.
void	clear() It cleans all the information for an equivalence class.
int	compareTo(EquivalenceClass arg) It makes the comparison between two classes.
Pattern	getClassIdentifier() It gets the equivalence class identifier
java.util.List<EquivalenceClass>	getClassMembers() Get the members of the equivalence class
IDList	getIdList() It gets the IdList of the Equivalence class' identifier
EquivalenceClass	getIthMember(int i) It gets the ith member of the class.
void	setClassIdentifier(Pattern classIdentifier) It sets the equivalence class identifier
void	setClassMembers(java.util.List<EquivalenceClass> classMembers) Set the members of the equivalence class
void	setIdList(IDList idList) It sets the IdList of the Equivalence class' identifier
java.lang.String	toString() Get the string representation of this equivalence class.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EquivalenceClass

public EquivalenceClass(Pattern classIdentifier)

Constructor from a pattern.

Parameters:

classIdentifier - The pattern to be use as the equivalence class identifier

EquivalenceClass

public EquivalenceClass(Pattern classIdentifier,
                        IDList idList)

Constructor from a pattern and an IdList.

Parameters:

classIdentifier - The pattern to be use as the equivalence class identifier

idList - The idList that is associated to that the argument pattern

EquivalenceClass

public EquivalenceClass(Pattern classIdentifier,
                        java.util.List<EquivalenceClass> classMembers)

Constructor from a pattern and a set of equivalence classes

Parameters:

classIdentifier - The pattern to be use as the equivalence class identifier

classMembers - The equivalence classes that are to be the members of the equivalence class (superpatterns of the pattern given as an argument)

EquivalenceClass

public EquivalenceClass(Pattern classIdentifier,
                        java.util.List<EquivalenceClass> classMembers,
                        IDList idList)

Constructor from a pattern, an IdList and a set of equivvalence classes

Parameters:

classIdentifier - The pattern to be use as the equivalence class identifier

classMembers - The equivalence classes that are to be the members of the equivalence class (superpatterns of the pattern given as an argument)

idList - The IdList associated with the pattern given as an argument

Method Detail

getClassMembers

public java.util.List<EquivalenceClass> getClassMembers()

Get the members of the equivalence class

Returns:

a list of equivalence classes

setClassMembers

public void setClassMembers(java.util.List<EquivalenceClass> classMembers)

Set the members of the equivalence class

Parameters:

classMembers - Set of equivalence classes that are going to be the members

addClassMember

public void addClassMember(EquivalenceClass classMember)

Method to add an equivalence class as a new class' member.

Parameters:

classMember -

getIthMember

public EquivalenceClass getIthMember(int i)

It gets the ith member of the class.

Parameters:

i - The index of the member in which we are interested

Returns:

the ith member

getIdList

public IDList getIdList()

It gets the IdList of the Equivalence class' identifier

Returns:

the idlist

setIdList

public void setIdList(IDList idList)

It sets the IdList of the Equivalence class' identifier

Parameters:

idList - the idlist

getClassIdentifier

public Pattern getClassIdentifier()

It gets the equivalence class identifier

Returns:

the identifier

setClassIdentifier

public void setClassIdentifier(Pattern classIdentifier)

It sets the equivalence class identifier

Parameters:

classIdentifier - the identifier

compareTo

public int compareTo(EquivalenceClass arg)

It makes the comparison between two classes. That comparison is exactly as that one of their identifiers.

Specified by:

compareTo in interface java.lang.Comparable<EquivalenceClass>

Parameters:

arg - the other class

Returns:

0 if equals, -1 if this one is smaller, otherwise 1

toString

public java.lang.String toString()

Get the string representation of this equivalence class.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

clear

public void clear()

It cleans all the information for an equivalence class.