tap.parameters

Class MaxRecController

java.lang.Object

tap.parameters.MaxRecController

All Implemented Interfaces:

InputParamController

public class MaxRecController
extends java.lang.Object
implements InputParamController

Let controlling the maximum number of rows that can be output by a TAP service. The maximum and default values are provided by the service connection.

Note: By default, this parameter can be modified by anyone without any limitation. The default and maximum value is set by default to TAPJob.UNLIMITED_MAX_REC.

Note: The special value 0 means that just the metadata of the result must be returned. Considering the meaning of this value, it will not be considered as an TAPJob.UNLIMITED_MAX_REC, but like a valid value. The maximum value can then be also 0.

The logic of the output limit is set in this class. Here it is:

• If no value is specified by the TAP client, the default value is returned.
• If no default value is provided, the maximum output limit is returned.
• If no maximum value is provided, there is no limit (=TAPJob.UNLIMITED_MAX_REC).

Version:

2.0 (03/2015)

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
MaxRecController(ServiceConnection service) Build a controller for the MaxRec parameter.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the output limit of any managed job can be modified.
void	allowModification(boolean allowModification) Lets indicating whether the output limit of any managed job can be modified.
java.lang.Object	check(java.lang.Object value) Checks the value of the controlled parameter and builds a new object from this value.
java.lang.Object	getDefault() Returns the default value of the controlled parameter.
int	getMaxOutputLimit() Get the maximum number of rows that can be output.

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

MaxRecController

public MaxRecController(ServiceConnection service)

Build a controller for the MaxRec parameter.

Parameters:

service - Connection to the TAP service.

Method Detail

getDefault

public final 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).

getMaxOutputLimit

public final int getMaxOutputLimit()

Get the maximum number of rows that can be output.

Returns:

Maximum output limit.

check

public java.lang.Object check(java.lang.Object value)
                       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:

value - 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.

allowModification

public final boolean allowModification()

Tells whether the output limit of any managed job can be modified.

Specified by:

allowModification in interface InputParamController

Returns:

true if the output limit can be modified, false otherwise.

allowModification

public final void allowModification(boolean allowModification)

Lets indicating whether the output limit of any managed job can be modified.

Parameters:

allowModification - true if the output limit can be modified, false otherwise.