uk.ac.starlink.ttools
Class CopyMode

java.lang.Object
  |
  +--uk.ac.starlink.ttools.ProcessingMode
        |
        +--uk.ac.starlink.ttools.CopyMode

public class CopyMode
extends ProcessingMode

Processing mode which writes out a table.

Since:
11 Feb 2005

Constructor Summary
CopyMode()
           
 
Method Summary
 String getHelp()
           
 String getModeUsage()
          Returns a list of additional flags which can be used when this mode is operational (as processed by setArgs).
 String getName()
          Returns the name of this mode.
 void process(StarTable table)
          Writes the input table to an output table.
 boolean setArgs(List argList)
          Consume a list of arguments.
 
Methods inherited from class uk.ac.starlink.ttools.ProcessingMode
getOutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CopyMode

public CopyMode()
Method Detail

getName

public String getName()
Description copied from class: ProcessingMode
Returns the name of this mode. The returned value should be short and preferably lower case - it will be used (with a prepended "-") as the name of a command line flag.

Specified by:
getName in class ProcessingMode
Returns:
mode name

setArgs

public boolean setArgs(List argList)
Description copied from class: ProcessingMode
Consume a list of arguments. Any arguments which this mode knows about should be noted and removed from the list. Any others should be ignored, and left in the list. The return value should be true if everything looks OK, false if there is some syntax error in the arguments.

Overrides:
setArgs in class ProcessingMode
Parameters:
argList - an array of strings obtained from the command line
Returns:
true iff the arguments are unobjectionable

getModeUsage

public String getModeUsage()
Description copied from class: ProcessingMode
Returns a list of additional flags which can be used when this mode is operational (as processed by setArgs). The default implementation returns null.

Overrides:
getModeUsage in class ProcessingMode
Returns:
usage string describing mode-specific flags

getHelp

public String getHelp()

process

public void process(StarTable table)
             throws IOException
Writes the input table to an output table.

Specified by:
process in class ProcessingMode
Parameters:
table - input table
IOException

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.