Class AbstractAssociator

java.lang.Object
weka.associations.AbstractAssociator
All Implemented Interfaces:
Serializable, Cloneable, Associator, CapabilitiesHandler, RevisionHandler
Direct Known Subclasses:
Apriori, FPGrowth, GeneralizedSequentialPatterns, PredictiveApriori, SingleAssociatorEnhancer, Tertius

public abstract class AbstractAssociator extends Object implements Cloneable, Associator, Serializable, CapabilitiesHandler, RevisionHandler
Abstract scheme for learning associations. All schemes for learning associations extend this class
Version:
$Revision: 5503 $
Author:
Eibe Frank (eibe@cs.waikato.ac.nz)
See Also:
  • Constructor Details

    • AbstractAssociator

      public AbstractAssociator()
  • Method Details

    • forName

      public static Associator forName(String associatorName, String[] options) throws Exception
      Creates a new instance of a associator given it's class name and (optional) arguments to pass to it's setOptions method. If the associator implements OptionHandler and the options parameter is non-null, the associator will have it's options set.
      Parameters:
      associatorName - the fully qualified class name of the associator
      options - an array of options suitable for passing to setOptions. May be null.
      Returns:
      the newly created associator, ready for use.
      Throws:
      Exception - if the associator name is invalid, or the options supplied are not acceptable to the associator
    • makeCopy

      public static Associator makeCopy(Associator model) throws Exception
      Creates a deep copy of the given associator using serialization.
      Parameters:
      model - the associator to copy
      Returns:
      a deep copy of the associator
      Throws:
      Exception - if an error occurs
    • makeCopies

      public static Associator[] makeCopies(Associator model, int num) throws Exception
      Creates copies of the current associator. Note that this method now uses Serialization to perform a deep copy, so the Associator object must be fully Serializable. Any currently built model will now be copied as well.
      Parameters:
      model - an example associator to copy
      num - the number of associators copies to create.
      Returns:
      an array of associators.
      Throws:
      Exception - if an error occurs
    • getCapabilities

      public Capabilities getCapabilities()
      Returns the Capabilities of this associator. Maximally permissive capabilities are allowed by default. Derived associators should override this method and first disable all capabilities and then enable just those capabilities that make sense for the scheme.
      Specified by:
      getCapabilities in interface Associator
      Specified by:
      getCapabilities in interface CapabilitiesHandler
      Returns:
      the capabilities of this object
      See Also:
    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Returns:
      the revision