Class CopyMode

java.lang.Object
uk.ac.starlink.ttools.mode.CopyMode
All Implemented Interfaces:
ProcessingMode

public class CopyMode extends Object implements ProcessingMode
Processing mode which writes out a table.
Since:
11 Feb 2005
Author:
Mark Taylor (Starlink)
  • Field Details

  • Constructor Details

    • CopyMode

      public CopyMode()
  • Method Details

    • getAssociatedParameters

      public uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters()
      Description copied from interface: ProcessingMode
      Returns a list of any parameters which are associated with this mode.
      Specified by:
      getAssociatedParameters in interface ProcessingMode
      Returns:
      parameter list
    • getDescription

      public String getDescription()
      Description copied from interface: ProcessingMode
      Returns a textual description of this processing mode. This will be included in the user document so should be in XML.
      Specified by:
      getDescription in interface ProcessingMode
      Returns:
      textual description of this mode
    • createConsumer

      public TableConsumer createConsumer(uk.ac.starlink.task.Environment env) throws uk.ac.starlink.task.TaskException
      Description copied from interface: ProcessingMode
      Creates a TableConsumer, deriving any additional required configuration from a given environment.
      Specified by:
      createConsumer in interface ProcessingMode
      Parameters:
      env - execution environment
      Throws:
      uk.ac.starlink.task.TaskException
    • createConsumer

      public static TableConsumer createConsumer(uk.ac.starlink.task.Environment env, String loc, String fmt) throws uk.ac.starlink.task.UsageException
      Creates a TableConsumer which writes to a given location.
      Parameters:
      env - execution environment
      loc - location of output
      fmt - output format name
      Throws:
      uk.ac.starlink.task.UsageException