uk.ac.starlink.ttools.taplint

Class TapLinter

java.lang.Object

uk.ac.starlink.ttools.taplint.TapLinter

public class TapLinter
extends Object

Organises validation stages for TAP validator.

Since:

6 Jun 2011

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	MDQ_NAME Name of the MDQ stage.

Constructor Summary

Constructors

Constructor and Description
TapLinter() Constructor.

Method Summary

Modifier and Type	Method and Description
Executable	createExecutable(OutputReporter reporter, TapService tapService, Set<String> stageCodeSet, int maxTestTables, java.util.function.Predicate<TableMeta> tableFilter) Creates and returns an executable for TAP validation.
static String[]	getAnnouncements(boolean includeCodes) Returns a list of startup announcements with which the taplint application introduces itself.
Map<String,Stage>	getKnownStages() Returns an ordered map of the validation stages defined by this class.
boolean	isDefault(String code) Indicates whether the stage with a given code is run by default or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MDQ_NAME

public static final String MDQ_NAME

Name of the MDQ stage.

See Also:

Constant Field Values

Constructor Detail

TapLinter

public TapLinter()

Constructor.

Method Detail

getKnownStages

public Map<String,Stage> getKnownStages()

Returns an ordered map of the validation stages defined by this class.

Returns:

ordered code->stage map

isDefault

public boolean isDefault(String code)

Indicates whether the stage with a given code is run by default or not.

Parameters:

code - stage code

Returns:

true iff the corresponding stage is run by default

createExecutable

public Executable createExecutable(OutputReporter reporter,
                                   TapService tapService,
                                   Set<String> stageCodeSet,
                                   int maxTestTables,
                                   java.util.function.Predicate<TableMeta> tableFilter)
                            throws TaskException

Creates and returns an executable for TAP validation.

Parameters:

reporter - validation message destination

tapService - TAP service description

stageCodeSet - unordered collection of code strings indicating which stages should be run

maxTestTables - limit on the number of tables to test, or <=0 for no limit

tableFilter - filter for tables to receive testing, or null for no restriction

Returns:

tap validator executable

Throws:

TaskException

getAnnouncements

public static String[] getAnnouncements(boolean includeCodes)

Returns a list of startup announcements with which the taplint application introduces itself.

Parameters:

includeCodes - if true include a summary of taplint report codes

Returns:

announcement lines