uk.ac.starlink.ttools.mode
Class StatsMode

java.lang.Object
  extended by uk.ac.starlink.ttools.mode.StatsMode
All Implemented Interfaces:
ProcessingMode

public class StatsMode
extends Object
implements ProcessingMode

Processing mode for calculating statistics on a table.

Since:
16 Mar 2005
Author:
Mark Taylor (Starlink)

Constructor Summary
StatsMode()
           
 
Method Summary
 TableConsumer createConsumer(uk.ac.starlink.task.Environment env)
          Creates a TableConsumer, deriving any additional required configuration from a given environment.
 uk.ac.starlink.task.Parameter[] getAssociatedParameters()
          Returns a list of any parameters which are associated with this mode.
 String getDescription()
          Returns a textual description of this processing mode.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StatsMode

public StatsMode()
Method Detail

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)
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


Copyright © 2009 Central Laboratory of the Research Councils. All Rights Reserved.