Package weka.filters.unsupervised.attribute

Class RenameAttribute

  • All Implemented Interfaces:
    java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter
    public class RenameAttribute
extends SimpleStreamFilter
implements WeightedInstancesHandler, WeightedAttributesHandler
    This filter is used for renaming attributes.
    Regular expressions can be used in the matching and replacing.
    See Javadoc of java.util.regex.Pattern class for more information:
    http://java.sun.com/javase/6/docs/api/java/util/regex/Pattern.html

    Valid options are: 

     -find <regexp>
  The regular expression that the attribute names must match.
  (default: ([\s\S]+))
 
     -replace <string>
  The string to replace the regular expression of matching attributes with.
  Cannot be used in conjunction with '-remove'.
  (default: $0)
 
     -remove
  In case the matching string needs to be removed instead of replaced.
  Cannot be used in conjunction with '-replace <string>'.
  (default: off)
 
     -all
  Replaces all occurrences instead of just the first.
  (default: only first occurrence)
 
     -R <range>
  The attribute range to work on.
 This is a comma separated list of attribute indices, with "first" and "last" valid values.
  Specify an inclusive range with "-".
  E.g: "first-3,5,6-10,last".
  (default: first-last)
 
     -V
  Inverts the attribute selection range.
  (default: off)
    Version:
    $Revision: 14534 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • RenameAttribute

        public RenameAttribute()

    • Method Detail

      • globalInfo

        public java.lang.String globalInfo()
        Returns a string describing this filter.
        Specified by:
        globalInfo in class SimpleFilter
        Returns:
        a description of the filter suitable for displaying in the explorer/experimenter gui

      • listOptions

        public java.util.Enumeration<Option> listOptions()
        Returns an enumeration describing the available options.
        Specified by:
        listOptions in interface OptionHandler
        Overrides:
        listOptions in class Filter
        Returns:
        an enumeration of all the available options.

      • setOptions

        public void setOptions​(java.lang.String[] options)
                throws java.lang.Exception
        Parses a given list of options.

        Valid options are: 

         -find <regexp>
  The regular expression that the attribute names must match.
  (default: ([\s\S]+))
 
         -replace <string>
  The string to replace the regular expression of matching attributes with.
  Cannot be used in conjunction with '-remove'.
  (default: $0)
 
         -remove
  In case the matching string needs to be removed instead of replaced.
  Cannot be used in conjunction with '-replace <string>'.
  (default: off)
 
         -all
  Replaces all occurrences instead of just the first.
  (default: only first occurrence)
 
         -R <range>
  The attribute range to work on.
 This is a comma separated list of attribute indices, with "first" and "last" valid values.
  Specify an inclusive range with "-".
  E.g: "first-3,5,6-10,last".
  (default: first-last)
 
         -V
  Inverts the attribute selection range.
  (default: off)
        Specified by:
        setOptions in interface OptionHandler
        Overrides:
        setOptions in class Filter
        Parameters:
        options - the list of options as an array of strings
        Throws:
        java.lang.Exception - if an option is not supported

      • getOptions

        public java.lang.String[] getOptions()
        Gets the current settings of the filter.
        Specified by:
        getOptions in interface OptionHandler
        Overrides:
        getOptions in class Filter
        Returns:
        an array of strings suitable for passing to setOptions

      • setFind

        public void setFind​(java.lang.String value)
        Sets the regular expression that the attribute names must match.
        Parameters:
        value - the regular expression

      • getFind

        public java.lang.String getFind()
        Returns the current regular expression for .
        Returns:
        a string containing a comma separated list of ranges

      • findTipText

        public java.lang.String findTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setReplace

        public void setReplace​(java.lang.String value)
        Sets the regular expression to replace matching attribute names with.
        Parameters:
        value - the regular expression

      • getReplace

        public java.lang.String getReplace()
        Returns the regular expression to replace matching attribute names with.
        Returns:
        the regular expression

      • replaceTipText

        public java.lang.String replaceTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setReplaceAll

        public void setReplaceAll​(boolean value)
        Sets whether to replace all occurrences or just the first one.
        Parameters:
        value - if true then all occurrences are replace

      • getReplaceAll

        public boolean getReplaceAll()
        Returns whether all occurrences are replaced or just the first one.
        Returns:
        true if all occurrences are replaced

      • replaceAllTipText

        public java.lang.String replaceAllTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setAttributeIndices

        public void setAttributeIndices​(java.lang.String value)
        Sets which attributes are to be acted on.
        Parameters:
        value - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from1.
        eg: first-3,5,6-last

      • getAttributeIndices

        public java.lang.String getAttributeIndices()
        Gets the current range selection.
        Returns:
        a string containing a comma separated list of ranges

      • attributeIndicesTipText

        public java.lang.String attributeIndicesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • setInvertSelection

        public void setInvertSelection​(boolean value)
        Sets whether to invert the selection of the attributes.
        Parameters:
        value - if true then the selection is inverted

      • getInvertSelection

        public boolean getInvertSelection()
        Gets whether to invert the selection of the attributes.
        Returns:
        true if the selection is inverted

      • invertSelectionTipText

        public java.lang.String invertSelectionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the explorer/experimenter gui

      • main

        public static void main​(java.lang.String[] args)
        Main method for executing this filter.
        Parameters:
        args - the arguments to the filter: use -h for help