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
,HealpixMetadataFilter
,KeepColumnFilter
,MetadataFilter
,NameFilter
,PixSampleFilter
,ProgressFilter
,RandomFilter
,RandomViewFilter
,RangeFilter
,RepeatFilter
,ReplaceColumnFilter
,ReplaceValueFilter
,ResolverFilter
,SelectFilter
,SequentialViewFilter
,SetParameterFilter
,SortFilter
,SortHeadFilter
,StatsFilter
,TailFilter
,TransposeFilter
,UniqueFilter
Basic implementation of ProcessingFilter methods.
Utility superclass for implementing concrete ProcessingFilter.
- Since:
- 9 Aug 2005
- Author:
- Mark Taylor
-
Constructor Details
-
BasicFilter
Constructor.- Parameters:
name
- filter nameusage
- filter usage
-
-
Method Details
-
getName
-
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
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
-
explainSyntax
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
-