Class JoinFixActionParameter.Fixer

  • Enclosing class:
    JoinFixActionParameter

    public abstract class JoinFixActionParameter.Fixer
    extends java.lang.Object
    Helper class which defines how suffixes are turned into JoinFixActions.
    • Constructor Summary

      Constructors 
      Constructor Description
      Fixer​(java.lang.String name, java.lang.String description)
      Constructor.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract uk.ac.starlink.table.JoinFixAction createAction​(uk.ac.starlink.task.Environment env, uk.ac.starlink.task.StringParameter suffixParam)
      Returns a JoinFixAction corresponding to a given label.
      java.lang.String getDescription()
      Returns a short description of the function of this object.
      java.lang.String toString()
      Returns object name.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Fixer

        public Fixer​(java.lang.String name,
                     java.lang.String description)
        Constructor.
        Parameters:
        name - object name, for presentation to the user as a parameter value
        description - short description of the function
    • Method Detail

      • createAction

        public abstract uk.ac.starlink.table.JoinFixAction createAction​(uk.ac.starlink.task.Environment env,
                                                                        uk.ac.starlink.task.StringParameter suffixParam)
                                                                 throws uk.ac.starlink.task.TaskException
        Returns a JoinFixAction corresponding to a given label.
        Parameters:
        env - execution environment
        suffixParam - parameter supplying suffix value (got from a createSuffixParameter method)
        Throws:
        uk.ac.starlink.task.TaskException
      • getDescription

        public java.lang.String getDescription()
        Returns a short description of the function of this object.
        Returns:
        description
      • toString

        public java.lang.String toString()
        Returns object name.
        Overrides:
        toString in class java.lang.Object