Package com.luciad.util.measure

Class ALcdMeasureProvider.Parameters.Builder

java.lang.Object

com.luciad.util.measure.ALcdMeasureProvider.Parameters.Builder

Enclosing class:

ALcdMeasureProvider.Parameters

public static class ALcdMeasureProvider.Parameters.Builder
extends Object

Builder to create Parameter objects.

Since:

2013.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ALcdMeasureProvider.Parameters.Builder	all(ALcdMeasureProvider.Parameters aParameters)	Sets all parameters on the builder based on the given Parameter object.
ALcdMeasureProvider.Parameters	build()	Builds a new Parameter object.
ALcdMeasureProvider.Parameters.Builder	interpolationType(ELcdInterpolationType aInterpolationType)	Sets the interpolation type.
ALcdMeasureProvider.Parameters.Builder	sampleDensity(double aSampleDensity)	Sets the sample density for which a measure is queried.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

sampleDensity

public ALcdMeasureProvider.Parameters.Builder sampleDensity(double aSampleDensity)

Sets the sample density for which a measure is queried. This value can be Double.NaN, in order to not specify a sample density. In that case, the most detailed measure can be returned.

The sample density is an indication of the spacing (in units of the point reference) between sample points for which measures are being retrieved. It indicates the number of samples per unit of area in the given point reference.

Parameters:

aSampleDensity - the sample density for which measures should be retrieved.

Returns:

this

interpolationType

public ALcdMeasureProvider.Parameters.Builder interpolationType(ELcdInterpolationType aInterpolationType)

Sets the interpolation type. This is useful when retrieving measures from rasters. By default, this parameter is ELcdInterpolationType.NONE. Note that only NONE and LINEAR are currently supported.

Parameters:

aInterpolationType - the interpolation type.

Returns:

this

all

public ALcdMeasureProvider.Parameters.Builder all(ALcdMeasureProvider.Parameters aParameters)

Sets all parameters on the builder based on the given Parameter object.

Parameters:

aParameters - a parameter object.

Returns:

this

build

public ALcdMeasureProvider.Parameters build()

Builds a new Parameter object.

Returns:

a new Parameter object.