tap.parameters

Class FormatController

java.lang.Object

tap.parameters.FormatController

All Implemented Interfaces:

InputParamController

public class FormatController
extends java.lang.Object
implements InputParamController

Let controlling the format of all job result in a TAP service. The default values are provided by the service connection.

Note: By default, the format can be modified by anyone without any limitation.

Version:

2.0 (09/2014)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowModification Indicates whether the output limit of jobs can be modified.
protected ServiceConnection	service Connection to the service which knows the maximum and default value of this parameter.

Constructor Summary

Constructors

Constructor and Description
FormatController(ServiceConnection service) Build a controller for the Format parameter.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the controlled parameter may be modified after initialization.
void	allowModification(boolean allowModif) Lets indicating whether the format parameter can be modified.
java.lang.Object	check(java.lang.Object format) Checks the value of the controlled parameter and builds a new object from this value.
protected java.lang.String	getAllowedFormats() Get a list of all allowed output formats (for each, the main MIME type but also the short type representation are given).
java.lang.Object	getDefault() Returns the default value of the controlled parameter.

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final ServiceConnection service

Connection to the service which knows the maximum and default value of this parameter.

allowModification

protected boolean allowModification

Indicates whether the output limit of jobs can be modified.

Constructor Detail

FormatController

public FormatController(ServiceConnection service)

Build a controller for the Format parameter.

Parameters:

service - Connection to the TAP service.

Method Detail

allowModification

public final boolean allowModification()

Description copied from interface: InputParamController

Tells whether the controlled parameter may be modified after initialization.

Specified by:

allowModification in interface InputParamController

Returns:

true to allow the modification, false otherwise.

allowModification

public final void allowModification(boolean allowModif)

Lets indicating whether the format parameter can be modified.

Parameters:

allowModif - true if the format can be modified, false otherwise.

getDefault

public java.lang.Object getDefault()

Description copied from interface: InputParamController

Returns the default value of the controlled parameter.

Specified by:

getDefault in interface InputParamController

Returns:

Default value (null is allowed).

check

public java.lang.Object check(java.lang.Object format)
                       throws UWSException

Description copied from interface: InputParamController

Checks the value of the controlled parameter and builds a new object from this value.

Specified by:

check in interface InputParamController

Parameters:

format - Parameter value to check.

Returns:

The same value or a new object built from the given value.

Throws:

UWSException - If the given value is strongly incorrect.

getAllowedFormats

protected final java.lang.String getAllowedFormats()

Get a list of all allowed output formats (for each, the main MIME type but also the short type representation are given).

Returns:

List of all output formats.