TapMapper (Starlink-UK API)

java.lang.Object
- uk.ac.starlink.ttools.task.TapMapper

All Implemented Interfaces:

TableMapper
```
public class TapMapper
extends Object
implements TableMapper
```
Mapper that does the work for TapQuerier.

Since:

21 Feb 2011

Author:

Mark Taylor

Constructor Summary

Constructors
Constructor and Description

TapMapper()

Constructors
Constructor and Description
`TapMapper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TableMapping`	`createMapping(Environment env, int nup)` Creates a new mapping object, using a given execution environment for any additional required state.
`static Parameter<String>`	`createUploadNameParameter(String label)` Returns a parameter for acquiring the label under which one of the uploaded tables should be presented to the TAP server.
`Parameter<String>`	`getAdqlParameter()` Returns the parameter used to acquire ADQL query text.
`ContentCodingParameter`	`getContentCodingParameter()` Returns the parameter used to acquire the content coding.
`Parameter<String>`	`getLanguageParameter()` Returns the parameter used to acquire the query language variant.
`Parameter<Long>`	`getMaxrecParameter()` Returns the parameter used to acquire the output record limit.
`Parameter<?>[]`	`getParameters()` Returns the parameters defined by this mapper.
`TapResultReader`	`getResultReader()` Returns the result reader used by this mapper.
`Parameter<Boolean>`	`getSyncParameter()` Returns the parameter used to acquire the sync/async flag.
`TapServiceParams`	`getTapServiceParams()` Returns the TapServiceParams used by this mapper to acquire a TAP service.
`Parameter<VOTableWriter>`	`getVOTableWriterParameter()` Returns the parameter used to acquire the table upload writer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TapMapper
```
public TapMapper()
```
- Method Detail
  - getParameters
```
public Parameter<?>[] getParameters()
```
    Description copied from interface: TableMapper
    
    Returns the parameters defined by this mapper.
    
    Specified by:
    
    getParameters in interface TableMapper
    
    Returns:
    
    parameter array
  - createMapping
```
public TableMapping createMapping(Environment env,
                                  int nup)
                           throws TaskException
```
    Description copied from interface: TableMapper
    
    Creates a new mapping object, using a given execution environment for any additional required state.
    
    Specified by:
    
    createMapping in interface TableMapper
    
    Parameters:
    
    env - execution environment
    
    nup - number of input tables that the mapping will operate on if known; -1 if not
    
    Throws:
    
    TaskException
  - getTapServiceParams
```
public TapServiceParams getTapServiceParams()
```
    Returns the TapServiceParams used by this mapper to acquire a TAP service.
    
    Returns:
    
    tap service params
  - getAdqlParameter
```
public Parameter<String> getAdqlParameter()
```
    Returns the parameter used to acquire ADQL query text.
    
    Returns:
    
    adql parameter
  - getSyncParameter
```
public Parameter<Boolean> getSyncParameter()
```
    Returns the parameter used to acquire the sync/async flag.
    
    Returns:
    
    sync parameter
  - getLanguageParameter
```
public Parameter<String> getLanguageParameter()
```
    Returns the parameter used to acquire the query language variant.
    
    Returns:
    
    language parameter
  - getMaxrecParameter
```
public Parameter<Long> getMaxrecParameter()
```
    Returns the parameter used to acquire the output record limit.
    
    Returns:
    
    maxrec parameter
  - getContentCodingParameter
```
public ContentCodingParameter getContentCodingParameter()
```
    Returns the parameter used to acquire the content coding.
    
    Returns:
    
    content coding parameter
  - getVOTableWriterParameter
```
public Parameter<VOTableWriter> getVOTableWriterParameter()
```
    Returns the parameter used to acquire the table upload writer.
    
    Returns:
    
    upload writer parameter
  - getResultReader
```
public TapResultReader getResultReader()
```
    Returns the result reader used by this mapper.
    
    Returns:
    
    result reader
  - createUploadNameParameter
```
public static Parameter<String> createUploadNameParameter(String label)
```
    Returns a parameter for acquiring the label under which one of the uploaded tables should be presented to the TAP server.
    
    Parameters:
    
    label - parameter suffix
    
    Returns:
    
    upload name parameter

Class TapMapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TapMapper

Method Detail

getParameters

createMapping

getTapServiceParams

getAdqlParameter

getSyncParameter

getLanguageParameter

getMaxrecParameter

getContentCodingParameter

getVOTableWriterParameter

getResultReader

createUploadNameParameter