uk.ac.starlink.ttools.task

Class CdsUploadSkyMatch

java.lang.Object

uk.ac.starlink.ttools.task.ConsumerTask

uk.ac.starlink.ttools.task.SingleMapperTask

uk.ac.starlink.ttools.task.CdsUploadSkyMatch

All Implemented Interfaces:

Task

public class CdsUploadSkyMatch
extends SingleMapperTask

Upload matcher that uses CDS's Xmatch service.

Since:

14 May 2014

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
CdsUploadSkyMatch() Constructor.

Method Summary

Modifier and Type	Method and Description
TableProducer	createProducer(Environment env) Returns an object which can produce the effective output table which will be consumed by this task.
Parameter<Integer>	getBlocksizeParameter() Returns the parameter for acquiring upload block size.
Parameter<String>	getCdsSuffixParameter() Returns the parameter for acquiring the fixer suffix parameter.
Parameter<String>	getCdsTableParameter() Returns the parameter for acquiring the name of the remote VizieR table.
Parameter<String>	getDecParameter() Returns the parameter for acquiring the expression for Declination.
Parameter<UserFindMode>	getFindParameter() Returns the parameter for acquiring the find mode.
Parameter<JoinFixActionParameter.Fixer>	getFixColsParameter() Returns the parameter for acquiring the Fixer action.
Parameter<Double>	getRadiusArcsecParameter() Returns the parameter for acquiring the search radius in arcseconds.
Parameter<String>	getRaParameter() Returns the parameter for acquiring the expression for Right Ascension.
Parameter<Boolean>	getUseMocParameter() Returns the parameter for acquiring the whether a MOC should be sought and used to pre-filter rows before upload.

Methods inherited from class uk.ac.starlink.ttools.task.SingleMapperTask

createInputProducer, getInputFilterParameter, getInputTableParameter

Methods inherited from class uk.ac.starlink.ttools.task.ConsumerTask

createExecutable, createProducer, getIdentity, getOutputMode, getParameterList, getParameters, getPurpose

Methods inherited from class java.lang.Object

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

Constructor Detail

CdsUploadSkyMatch

public CdsUploadSkyMatch()

Constructor.

Method Detail

getRaParameter

public Parameter<String> getRaParameter()

Returns the parameter for acquiring the expression for Right Ascension.

Returns:

RA parameter

getDecParameter

public Parameter<String> getDecParameter()

Returns the parameter for acquiring the expression for Declination.

Returns:

declination parameter

getRadiusArcsecParameter

public Parameter<Double> getRadiusArcsecParameter()

Returns the parameter for acquiring the search radius in arcseconds.

Returns:

radius parameter

getCdsTableParameter

public Parameter<String> getCdsTableParameter()

Returns the parameter for acquiring the name of the remote VizieR table.

Returns:

CDS table name parameter

getUseMocParameter

public Parameter<Boolean> getUseMocParameter()

Returns the parameter for acquiring the whether a MOC should be sought and used to pre-filter rows before upload.

Returns:

useMoc parameter

getFindParameter

public Parameter<UserFindMode> getFindParameter()

Returns the parameter for acquiring the find mode.

Returns:

find mode parameter

getBlocksizeParameter

public Parameter<Integer> getBlocksizeParameter()

Returns the parameter for acquiring upload block size.

Returns:

block size parameter

getFixColsParameter

public Parameter<JoinFixActionParameter.Fixer> getFixColsParameter()

Returns the parameter for acquiring the Fixer action.

Returns:

column fixer parameter

getCdsSuffixParameter

public Parameter<String> getCdsSuffixParameter()

Returns the parameter for acquiring the fixer suffix parameter.

Returns:

fixer suffix parameter

createProducer

public TableProducer createProducer(Environment env)
                             throws TaskException

Description copied from class: ConsumerTask

Returns an object which can produce the effective output table which will be consumed by this task. The table produced by the resulting producer can be fed to the ConsumerTask.getIdentity(uk.ac.starlink.table.StarTable) method.

Specified by:

createProducer in class ConsumerTask

Parameters:

env - execution environment

Returns:

table producer

Throws:

TaskException