tap.parameters

Class TAPParameters

java.lang.Object

uws.job.parameters.UWSParameters

tap.parameters.TAPParameters

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,java.lang.Object>>

public class TAPParameters
extends UWSParameters

This class lets list and describe all standard TAP parameters submitted by a TAP client to this TAP service.

Version:

2.1 (04/2017)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	TAP_PARAMETERS All the TAP parameters.

Fields inherited from class uws.job.parameters.UWSParameters

expectedAdditionalParams, files, mapParamControllers, params, UWS_RO_PARAMETERS, UWS_RW_PARAMETERS, UWS_RW_PARAMETERS_REGEXP

Constructor Summary

Constructors

Constructor and Description
TAPParameters(javax.servlet.http.HttpServletRequest request, ServiceConnection service) Create a TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest.
TAPParameters(javax.servlet.http.HttpServletRequest request, ServiceConnection service, java.util.Map<java.lang.String,InputParamController> controllers) Create a TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest.
TAPParameters(ServiceConnection service) Create an empty list of parameters.
TAPParameters(ServiceConnection service, java.util.Map<java.lang.String,java.lang.Object> params) Create a TAPParameters instance whose the parameters are given in parameter.
TAPParameters(ServiceConnection service, java.util.Map<java.lang.String,java.lang.Object> params, java.util.Map<java.lang.String,InputParamController> controllers) Create a TAPParameters instance whose the parameters are given in parameter.

Method Summary

Modifier and Type	Method and Description
protected static java.util.Map<java.lang.String,InputParamController>	buildDefaultControllers(ServiceConnection service, java.util.Map<java.lang.String,InputParamController> customControllers) Build a map containing all controllers for all standard TAP parameters.
void	check() Check the coherence between all TAP parameters.
java.lang.String	getFormat() Get the value of the standard TAP parameter "FORMAT".
java.lang.String	getLang() Get the value of the standard TAP parameter "LANG".
java.lang.Integer	getMaxRec() Get the value of the standard TAP parameter "MAX_REC".
java.lang.String	getQuery() Get the value of the standard TAP parameter "QUERY".
java.lang.String	getRequest() Get the value of the standard TAP parameter "REQUEST".
protected java.lang.String	getStringParam(java.lang.String paramName) Get the value of the given parameter, but as a String, whatever is its original type.
java.lang.String	getUpload() Get the value of the standard TAP parameter "UPLOAD".
DALIUpload[]	getUploadedTables() Get the list of all tables uploaded and defined by the standard TAP parameter "UPLOAD".
java.lang.String	getVersion() Get the value of the standard TAP parameter "VERSION".

Methods inherited from class uws.job.parameters.UWSParameters

get, getAdditionalParameters, getController, getControllers, getDefaultControllers, getDestructionTime, getExecutionDuration, getFiles, getInputPhase, getNames, getParameters, getRunId, hasInputPhase, init, isEmpty, iterator, normalizeParamName, remove, set, size, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

TAP_PARAMETERS

protected static final java.util.List<java.lang.String> TAP_PARAMETERS

All the TAP parameters.

Constructor Detail

TAPParameters

public TAPParameters(ServiceConnection service)

Create an empty list of parameters.

Parameters:

service - Description of the TAP service in which the parameters are created and will be used.

TAPParameters

public TAPParameters(javax.servlet.http.HttpServletRequest request,
                     ServiceConnection service)
              throws TAPException

Create a TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest.

Parameters:

request - HTTP request containing the parameters to gather inside this class.

service - Description of the TAP service in which the parameters are created and will be used.

Throws:

TAPException - If any error occurs while extracting the DALIParameters OR while setting a parameter.

See Also:

UWSParameters.getParameters(HttpServletRequest)

TAPParameters

public TAPParameters(javax.servlet.http.HttpServletRequest request,
                     ServiceConnection service,
                     java.util.Map<java.lang.String,InputParamController> controllers)
              throws TAPException

Create a TAPParameters instance whose the parameters must be extracted from the given HttpServletRequest.

Parameters:

request - HTTP request containing the parameters to gather inside this class.

service - Description of the TAP service in which the parameters are created and will be used.

controllers - Additional/Replacing controllers to apply on some input parameters. Ignored if NULL.

Throws:

TAPException - If any error occurs while extracting the DALIParameters OR while setting a parameter.

Since:

2.1

See Also:

UWSParameters.getParameters(HttpServletRequest)

TAPParameters

public TAPParameters(ServiceConnection service,
                     java.util.Map<java.lang.String,java.lang.Object> params)
              throws TAPException

Create a TAPParameters instance whose the parameters are given in parameter.

Parameters:

service - Description of the TAP service. Limits of the standard TAP parameters are listed in it.

params - List of parameters to load inside this object.

Throws:

TAPException - If any error occurs while extracting the DALIParameters OR while setting a parameter.

See Also:

TAPParameters(ServiceConnection, Map, Map)

TAPParameters

public TAPParameters(ServiceConnection service,
                     java.util.Map<java.lang.String,java.lang.Object> params,
                     java.util.Map<java.lang.String,InputParamController> controllers)
              throws TAPException

Create a TAPParameters instance whose the parameters are given in parameter.

Parameters:

service - Description of the TAP service. Limits of the standard TAP parameters are listed in it.

params - List of parameters to load inside this object.

controllers - Additional/Replacing controllers to apply on some input parameters. Ignored if NULL.

Throws:

TAPException - If any error occurs while extracting the DALIParameters OR while setting a parameter.

Method Detail

buildDefaultControllers

protected static final java.util.Map<java.lang.String,InputParamController> buildDefaultControllers(ServiceConnection service,
                                                                                                    java.util.Map<java.lang.String,InputParamController> customControllers)

Build a map containing all controllers for all standard TAP parameters.

Note: All standard parameters, except UPLOAD. Indeed, since this parameter can be provided in several times (in one HTTP request) and needs to be interpreted immediately after initialization, no controller has been set for it. Its value will be actually tested in the constructor while interpreting it.

Parameters:

service - Description of the TAP service.

customControllers - Additional/Replacing controllers to apply on some input parameters. Ignored if NULL.

Returns:

Map of all default controllers.

Since:

2.0

getStringParam

protected final java.lang.String getStringParam(java.lang.String paramName)

Get the value of the given parameter, but as a String, whatever is its original type.

Basically, the different cases of conversion into String are the following:

• NULL: NULL is returned.
• An array (of whatever is the items' type): a string in which each Object.toString() are concatenated ; each item is separated by a semicolon
• Anything else: Object.toString()

Parameters:

paramName - Name of the parameter whose the value must be returned as a String.

Returns:

The string value of the specified parameter.

getRequest

public final java.lang.String getRequest()

Get the value of the standard TAP parameter "REQUEST".

Returns:

"REQUEST" value.

getLang

public final java.lang.String getLang()

Get the value of the standard TAP parameter "LANG".

Returns:

"LANG" value.

getVersion

public final java.lang.String getVersion()

Get the value of the standard TAP parameter "VERSION".

Returns:

"VERSION" value.

getFormat

public final java.lang.String getFormat()

Get the value of the standard TAP parameter "FORMAT".

Returns:

"FORMAT" value.

getQuery

public final java.lang.String getQuery()

Get the value of the standard TAP parameter "QUERY".

Returns:

"QUERY" value.

getUpload

public final java.lang.String getUpload()

Get the value of the standard TAP parameter "UPLOAD".

Note: This parameter is generally a set of several Strings, each representing one table to upload. This function returns this set as a String in which each items are joined, semicolon separated, inside a single String.

Returns:

"UPLOAD" value.

getUploadedTables

public final DALIUpload[] getUploadedTables()

Get the list of all tables uploaded and defined by the standard TAP parameter "UPLOAD".

Returns:

Tables to upload in database at query execution.

getMaxRec

public final java.lang.Integer getMaxRec()

Get the value of the standard TAP parameter "MAX_REC". This value is the maximum number of rows that the result of the query must contain.

Returns:

Maximum number of output rows.

check

public void check()
           throws TAPException

Check the coherence between all TAP parameters.

This function does not test individually each parameters, but all of them as a coherent whole. Thus, the parameter REQUEST must be provided and if its value is "doQuery", the parameters LANG and QUERY must be also provided.

Throws:

TAPException - If one required parameter is missing.