Interface IDList

  • All Known Implementing Classes:
    IDListStandard_Map

    public interface IDList
    Interface for a IdList class. If we are interested in adding any other kind of IdList, we can create a new one if there we implement the methods here exposed. 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 .
    Author:
    agomariz
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.Integer,​java.util.List<Position>> appearingInMap()
      It gets a map with a match between the sequences where the pattern associated with this IdList appears, and the position items of that sequence where the pattern is identified
      void clear()
      It clears the IdList.
      int getSupport()
      Get the minimum relative support outlined by the IdList, i.e.
      int getTotalElementsAfterPrefixes()
      It returns the number of elements that appears after each appearance of the pattern associated with the IdList
      IDList join​(IDList idList, boolean equals, int minSupport)
      It return the intersection IdList that results from the current object and the IdList given as an argument.
      void setAppearingIn​(Pattern pattern)
      It moves to a pattern the sequences where the Idlist is active.
      void setAppearingIn​(Trie trie)
      It moves to a Trie the sequences where the Idlist is active.
      void SetOriginalSequenceLengths​(java.util.Map<java.lang.Integer,​java.lang.Integer> map)
      It sets the original lengths of the database sequences
      void setTotalElementsAfterPrefixes​(int i)
      It sets the number of elements that appears after each appearance of the pattern associated with the IdList
      java.lang.String toString()
      Get the string representation of this IdList.
    • Method Detail

      • join

        IDList join​(IDList idList,
                    boolean equals,
                    int minSupport)
        It return the intersection IdList that results from the current object and the IdList given as an argument.
        Parameters:
        idList - IdList with which we join the current IdList.
        equals - Flag indicating if we want a intersection for equal relation, or, if it is false, an after relation.
        minSupport - Minimum relative support.
        Returns:
        the intersection
      • getSupport

        int getSupport()
        Get the minimum relative support outlined by the IdList, i.e. the number of sequences with any appearance on it.
        Returns:
        the minsup value
      • toString

        java.lang.String toString()
        Get the string representation of this IdList.
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation
      • setAppearingIn

        void setAppearingIn​(Trie trie)
        It moves to a Trie the sequences where the Idlist is active.
        Parameters:
        trie - the trie
      • setAppearingIn

        void setAppearingIn​(Pattern pattern)
        It moves to a pattern the sequences where the Idlist is active.
        Parameters:
        pattern - the pattern
      • clear

        void clear()
        It clears the IdList.
      • appearingInMap

        java.util.Map<java.lang.Integer,​java.util.List<Position>> appearingInMap()
        It gets a map with a match between the sequences where the pattern associated with this IdList appears, and the position items of that sequence where the pattern is identified
        Returns:
        the map
      • getTotalElementsAfterPrefixes

        int getTotalElementsAfterPrefixes()
        It returns the number of elements that appears after each appearance of the pattern associated with the IdList
        Returns:
        the number of elements
      • setTotalElementsAfterPrefixes

        void setTotalElementsAfterPrefixes​(int i)
        It sets the number of elements that appears after each appearance of the pattern associated with the IdList
        Parameters:
        i -
      • SetOriginalSequenceLengths

        void SetOriginalSequenceLengths​(java.util.Map<java.lang.Integer,​java.lang.Integer> map)
        It sets the original lengths of the database sequences
        Parameters:
        map -