Package uk.ac.starlink.ttools.filter
Class MetadataFilter
java.lang.Object
uk.ac.starlink.ttools.filter.BasicFilter
uk.ac.starlink.ttools.filter.MetadataFilter
- All Implemented Interfaces:
ProcessingFilter
Filter for extracting column metadata.
- Since:
- 26 Apr 2006
- Author:
- Mark Taylor
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo[]
All known metadata items.static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
static final uk.ac.starlink.table.ValueInfo
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateStep
(Iterator<String> argIt) Creates a new ProcessingStep based on a sequence of command-line arguments.protected String[]
static uk.ac.starlink.util.MapGroup
<uk.ac.starlink.table.ValueInfo, Object> metadataMapGroup
(uk.ac.starlink.table.StarTable table) Constructs a MapGroup containing column metadata of a given table.Methods inherited from class uk.ac.starlink.ttools.filter.BasicFilter
explainSyntax, getDescription, getName, getUsage
-
Field Details
-
INDEX_INFO
public static final uk.ac.starlink.table.ValueInfo INDEX_INFO -
NAME_INFO
public static final uk.ac.starlink.table.ValueInfo NAME_INFO -
CLASS_INFO
public static final uk.ac.starlink.table.ValueInfo CLASS_INFO -
SHAPE_INFO
public static final uk.ac.starlink.table.ValueInfo SHAPE_INFO -
ELSIZE_INFO
public static final uk.ac.starlink.table.ValueInfo ELSIZE_INFO -
UNIT_INFO
public static final uk.ac.starlink.table.ValueInfo UNIT_INFO -
DESCRIPTION_INFO
public static final uk.ac.starlink.table.ValueInfo DESCRIPTION_INFO -
UCD_INFO
public static final uk.ac.starlink.table.ValueInfo UCD_INFO -
UTYPE_INFO
public static final uk.ac.starlink.table.ValueInfo UTYPE_INFO -
XTYPE_INFO
public static final uk.ac.starlink.table.ValueInfo XTYPE_INFO -
KNOWN_INFOS
public static final uk.ac.starlink.table.ValueInfo[] KNOWN_INFOSAll known metadata items.
-
-
Constructor Details
-
MetadataFilter
public MetadataFilter()Constructor.
-
-
Method Details
-
getDescriptionLines
- Specified by:
getDescriptionLines
in classBasicFilter
-
createStep
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.- Parameters:
argIt
- iterator over command-line arguments positioned at the first one- Throws:
ArgException
-
metadataMapGroup
public static uk.ac.starlink.util.MapGroup<uk.ac.starlink.table.ValueInfo,Object> metadataMapGroup(uk.ac.starlink.table.StarTable table) Constructs a MapGroup containing column metadata of a given table.- Parameters:
table
- the table for which to extract metadata- Returns:
- mapgroup containing column metadata
-