Interface FeatureSet

  • All Superinterfaces:
    Dumpable
    All Known Implementing Classes:
    FeatureSetImpl, Utterance

    public interface FeatureSet
    extends Dumpable
    Represents the abstract interface to an entity that has a set of features. Provides interfaces to set and get the name/value pairs as well as providing a set of convenience methods for setting and retrieving values of a particular type.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void dump​(java.io.PrintWriter output, int pad, java.lang.String title)
      Dumps the FeatureSet in textual form.
      float getFloat​(java.lang.String name)
      Convenience method that returns the named feature as a float.
      int getInt​(java.lang.String name)
      Convenience method that returns the named feature as an int.
      java.lang.Object getObject​(java.lang.String name)
      Returns the named feature as an object.
      java.lang.String getString​(java.lang.String name)
      Convenience method that returns the named feature as a string.
      boolean isPresent​(java.lang.String name)
      Determines if the given feature is present.
      void remove​(java.lang.String name)
      Removes the named feature from this set of features.
      void setFloat​(java.lang.String name, float value)
      Convenience method that sets the named feature as a float
      void setInt​(java.lang.String name, int value)
      Convenience method that sets the named feature as an int.
      void setObject​(java.lang.String name, java.lang.Object value)
      Sets the named feature .
      void setString​(java.lang.String name, java.lang.String value)
      Convenience method that sets the named feature as a String.
    • Method Detail

      • isPresent

        boolean isPresent​(java.lang.String name)
        Determines if the given feature is present.
        Parameters:
        name - the name of the feature of interest
        Returns:
        true if the named feature is present
      • remove

        void remove​(java.lang.String name)
        Removes the named feature from this set of features.
        Parameters:
        name - the name of the feature of interest
      • getString

        java.lang.String getString​(java.lang.String name)
        Convenience method that returns the named feature as a string.
        Parameters:
        name - the name of the feature
        Returns:
        the value associated with the name or null if the value is not found
        Throws:
        java.lang.ClassCastException - if theassociated value is not a String
      • getInt

        int getInt​(java.lang.String name)
        Convenience method that returns the named feature as an int.
        Parameters:
        name - the name of the feature
        Returns:
        the value associated with the name or null if the value is not found
        Throws:
        java.lang.ClassCastException - if the associated value is not an int
      • getFloat

        float getFloat​(java.lang.String name)
        Convenience method that returns the named feature as a float.
        Parameters:
        name - the name of the feature
        Returns:
        the value associated with the name or null if the value is not found
        Throws:
        java.lang.ClassCastException - if the associated value is not a float.
      • getObject

        java.lang.Object getObject​(java.lang.String name)
        Returns the named feature as an object.
        Parameters:
        name - the name of the feature
        Returns:
        the value associated with the name or null if the value is not found
      • setInt

        void setInt​(java.lang.String name,
                    int value)
        Convenience method that sets the named feature as an int.
        Parameters:
        name - the name of the feature
        value - the value of the feature
      • setFloat

        void setFloat​(java.lang.String name,
                      float value)
        Convenience method that sets the named feature as a float
        Parameters:
        name - the name of the feature
        value - the value of the feature
      • setString

        void setString​(java.lang.String name,
                       java.lang.String value)
        Convenience method that sets the named feature as a String.
        Parameters:
        name - the name of the feature
        value - the value of the feature
      • setObject

        void setObject​(java.lang.String name,
                       java.lang.Object value)
        Sets the named feature .
        Parameters:
        name - the name of the feature
        value - the value of the feature
      • dump

        void dump​(java.io.PrintWriter output,
                  int pad,
                  java.lang.String title)
        Dumps the FeatureSet in textual form.
        Specified by:
        dump in interface Dumpable
        Parameters:
        output - where to send the formatted output
        pad - the padding
        title - the title