Package uk.ac.starlink.ttools.filter
Class BasicFilter
- java.lang.Object
-
- uk.ac.starlink.ttools.filter.BasicFilter
-
- All Implemented Interfaces:
ProcessingFilter
- Direct Known Subclasses:
AddColumnFilter
,AddSkyCoordsFilter
,AssertFilter
,BadValueFilter
,CacheFilter
,CheckFilter
,ClearParameterFilter
,CollapseColsFilter
,ColumnCalculatorFilter
,ColumnMetadataFilter
,DeleteColumnFilter
,EveryFilter
,ExplodeAllFilter
,ExplodeColsFilter
,FixNamesFilter
,HeadFilter
,KeepColumnFilter
,MetadataFilter
,NameFilter
,PixSampleFilter
,ProgressFilter
,RandomFilter
,RandomViewFilter
,RangeFilter
,RepeatFilter
,ReplaceColumnFilter
,ReplaceValueFilter
,ResolverFilter
,SelectFilter
,SequentialViewFilter
,SetParameterFilter
,SortFilter
,SortHeadFilter
,StatsFilter
,TailFilter
,TransposeFilter
,UniqueFilter
public abstract class BasicFilter extends java.lang.Object implements ProcessingFilter
Basic implementation of ProcessingFilter methods. Utility superclass for implementing concrete ProcessingFilter.- Since:
- 9 Aug 2005
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
BasicFilter(java.lang.String name, java.lang.String usage)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static java.lang.String
explainSyntax(java.lang.String[] usages)
Returns a snippet of XML explaining use of the syntax of some given usage-type example arguments.java.lang.String
getDescription()
Description for this filter.protected abstract java.lang.String[]
getDescriptionLines()
java.lang.String
getName()
java.lang.String
getUsage()
Usage message for this filter.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface uk.ac.starlink.ttools.filter.ProcessingFilter
createStep
-
-
-
-
Method Detail
-
getName
public java.lang.String getName()
-
getUsage
public java.lang.String getUsage()
Description copied from interface:ProcessingFilter
Usage message for this filter. This should contain any arguments which apply to this item; the name itself should not be included. May contain newline characters to break up a long line.- Specified by:
getUsage
in interfaceProcessingFilter
- Returns:
- usage string
-
getDescription
public java.lang.String getDescription()
Description copied from interface:ProcessingFilter
Description for this filter. This is currently inserted into the user document, so should be in XML format.- Specified by:
getDescription
in interfaceProcessingFilter
- Returns:
- textual description of this filter
-
getDescriptionLines
protected abstract java.lang.String[] getDescriptionLines()
-
explainSyntax
public static java.lang.String explainSyntax(java.lang.String[] usages)
Returns a snippet of XML explaining use of the syntax of some given usage-type example arguments. These may be one of the following:- expr
- col-id
- colid-list
- Parameters:
usages
- array of formal arguments to be explained- Returns:
- XML explanation
-
-