uk.ac.starlink.ttools.filter
Class FixNamesFilter

java.lang.Object
  extended by uk.ac.starlink.ttools.filter.BasicFilter
      extended by uk.ac.starlink.ttools.filter.FixNamesFilter
All Implemented Interfaces:
ProcessingFilter, ProcessingStep

public class FixNamesFilter
extends BasicFilter
implements ProcessingStep

Filter to normalise syntax of column and parameter names so they are legal java identifiers.

Since:
18 Dec 2009
Author:
Mark Taylor

Constructor Summary
FixNamesFilter()
          Constructor.
 
Method Summary
 ProcessingStep createStep(Iterator argIt)
          Creates a new ProcessingStep based on a sequence of command-line arguments.
 String fixName(String name)
          Performs the name unmunging.
 String[] getDescriptionLines()
           
 StarTable wrap(StarTable base)
          Performs a table filtering step.
 
Methods inherited from class uk.ac.starlink.ttools.filter.BasicFilter
explainSyntax, getDescription, getName, getUsage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FixNamesFilter

public FixNamesFilter()
Constructor.

Method Detail

getDescriptionLines

public String[] getDescriptionLines()
Specified by:
getDescriptionLines in class BasicFilter

createStep

public ProcessingStep createStep(Iterator argIt)
                          throws ArgException
Description copied from interface: ProcessingFilter
Creates a new ProcessingStep based on a sequence of command-line arguments. The argIt argument is an iterator over the command-line arguments positioned just before any arguments intended for this filter. If legal, any that can be comprehended by this filter should be read (iterated over) and removed, and a ProcessingStep should accordingly be returned. In the case of a successful return, it is essential that no arguments other than the ones intended for this filter are read from the iterator.

If the argument list is badly-formed as far as this filter is concerned, an ArgException should be thrown. If its usageFrament is blank, it will be filled in later using this mode's usage text.

Specified by:
createStep in interface ProcessingFilter
Parameters:
argIt - iterator over command-line arguments positioned at the first one
Throws:
ArgException

wrap

public StarTable wrap(StarTable base)
Description copied from interface: ProcessingStep
Performs a table filtering step.

Specified by:
wrap in interface ProcessingStep
Parameters:
base - input table
Returns:
output table

fixName

public String fixName(String name)
Performs the name unmunging.

Parameters:
name - input name
Returns:
string like name which is a valid java identifier


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