uk.ac.starlink.ttools.taplint
Class TableMetadataStage

java.lang.Object
  extended by uk.ac.starlink.ttools.taplint.TableMetadataStage
All Implemented Interfaces:
MetadataHolder, Stage
Direct Known Subclasses:
TablesEndpointStage, TapSchemaStage

public abstract class TableMetadataStage
extends Object
implements Stage, MetadataHolder

Validation stage for checking the content of parsed Table metadata. Concrete subclasses must provide a method to acquire the metadata as an array of TableMeta objects.

Since:
3 Jun 2011
Author:
Mark Taylor

Constructor Summary
TableMetadataStage(String srcDescription, String[] knownColFlags, boolean reportOtherFlags)
          Constructor.
 
Method Summary
 String getDescription()
          Returns a short one-line description of this stage.
 String getSourceDescription()
          Returns a short text description of table metadata source.
 SchemaMeta[] getTableMetadata()
          Returns the table metadata obtained by the last run of this stage.
protected abstract  SchemaMeta[] readTableMetadata(Reporter reporter, URL serviceUrl)
          Returns an array providing table metadata to check.
 void run(Reporter reporter, URL serviceUrl)
          Performs the validation checks for this stage.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TableMetadataStage

public TableMetadataStage(String srcDescription,
                          String[] knownColFlags,
                          boolean reportOtherFlags)
Constructor.

Parameters:
srcDescription - short text description of table metadata source
knownColFlags - standard column flag values to report counts for
reportOtherFlags - whether to report counts for non-standard column flag values
Method Detail

getDescription

public String getDescription()
Description copied from interface: Stage
Returns a short one-line description of this stage.

Specified by:
getDescription in interface Stage
Returns:
description in imperative mood

getSourceDescription

public String getSourceDescription()
Returns a short text description of table metadata source.

Returns:
metadata source description

getTableMetadata

public SchemaMeta[] getTableMetadata()
Returns the table metadata obtained by the last run of this stage.

Specified by:
getTableMetadata in interface MetadataHolder
Returns:
table metadata array

readTableMetadata

protected abstract SchemaMeta[] readTableMetadata(Reporter reporter,
                                                  URL serviceUrl)
Returns an array providing table metadata to check.

Parameters:
reporter - destination for validation messages
serviceUrl - TAP service URL
Returns:
list of schema metadata elements

run

public void run(Reporter reporter,
                URL serviceUrl)
Description copied from interface: Stage
Performs the validation checks for this stage.

Specified by:
run in interface Stage
Parameters:
reporter - destination for validation messages
serviceUrl - TAP service URL


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