Package uk.ac.starlink.ttools.filter
Class RandomFilter
- java.lang.Object
-
- uk.ac.starlink.ttools.filter.BasicFilter
-
- uk.ac.starlink.ttools.filter.RandomFilter
-
- All Implemented Interfaces:
ProcessingFilter
,ProcessingStep
public class RandomFilter extends BasicFilter implements ProcessingStep
Processing step which calls theTables.randomTable(uk.ac.starlink.table.StarTable)
utility.- Since:
- 25 Feb 2010
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description RandomFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ProcessingStep
createStep(java.util.Iterator argIt)
Creates a new ProcessingStep based on a sequence of command-line arguments.protected java.lang.String[]
getDescriptionLines()
uk.ac.starlink.table.StarTable
wrap(uk.ac.starlink.table.StarTable in)
Performs a table filtering step.-
Methods inherited from class uk.ac.starlink.ttools.filter.BasicFilter
explainSyntax, getDescription, getName, getUsage
-
-
-
-
Method Detail
-
getDescriptionLines
protected java.lang.String[] getDescriptionLines()
- Specified by:
getDescriptionLines
in classBasicFilter
-
createStep
public ProcessingStep createStep(java.util.Iterator argIt)
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 itsusageFrament
is blank, it will be filled in later using this mode's usage text.- Specified by:
createStep
in interfaceProcessingFilter
- Parameters:
argIt
- iterator over command-line arguments positioned at the first one
-
wrap
public uk.ac.starlink.table.StarTable wrap(uk.ac.starlink.table.StarTable in) throws java.io.IOException
Description copied from interface:ProcessingStep
Performs a table filtering step.- Specified by:
wrap
in interfaceProcessingStep
- Parameters:
in
- input table- Returns:
- output table
- Throws:
java.io.IOException
-
-