edu.ucdavis.cstars.client.tasks

Class BufferParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.BufferParameters

public class BufferParameters
extends com.google.gwt.core.client.JavaScriptObject

Represents a geometry service resource exposed by the ArcGIS Server REST API. It is used to perform various operations on geometries such as project, simplify, buffer, and relationships.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static BufferParameters	create() Creates a new BufferParameters object.
SpatialReference	getBufferSpatialRefernce() The spatial reference in which the geometries are buffered.
com.google.gwt.core.client.JsArrayNumber	getDistances() The distances the input features are buffered.
com.google.gwt.core.client.JsArray<Geometry>	getGeometries() The input geometries to buffer.
SpatialReference	getOutSpatialRefernce() The spatial reference for the returned geometries.
GeometryService.UnitType	getUnit() The units for calculating each buffer distance.
boolean	isGeodesic() If the input geometries are in geographic coordinate system set geodesic to true in order to generate a buffer polygon using a geodesic distance.
void	setBufferSpatialRefernce(SpatialReference bufferSpatialReference) Set the bufferSpatialReference parameter.
void	setDistances(int[] distances) Set the distances parameter.
void	setGeodesic(boolean geodesic) Set the geodesic parameter.
void	setGeometries(Geometry[] geometries) Set the geometries parameter.
void	setOutSpatialRefernce(SpatialReference outSpatialReference) Set the outSpatialReference parameter.
void	setUnionResults(boolean unionResults) Set the unionResults parameter.
void	setUnit(GeometryService.UnitType unit) Set the unit parameter.
boolean	unionResults() If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static BufferParameters create()

Creates a new BufferParameters object. The constructor takes no parameters.

Returns:

BufferParameters

getBufferSpatialRefernce

public final SpatialReference getBufferSpatialRefernce()

The spatial reference in which the geometries are buffered. If bufferSpatialReference is not specified, the geometries are buffered in the spatial reference specified by outSpatialReference. If outSpatialReference is also not specified, they are buffered in the spatial reference of the features.

Returns:

SpatialReference

setBufferSpatialRefernce

public final void setBufferSpatialRefernce(SpatialReference bufferSpatialReference)

Set the bufferSpatialReference parameter.

Parameters:

bufferSpatialReference - - The spatial reference in which the geometries are buffered. If bufferSpatialReference is not specified, the geometries are buffered in the spatial reference specified by outSpatialReference. If outSpatialReference is also not specified, they are buffered in the spatial reference of the features.

getDistances

public final com.google.gwt.core.client.JsArrayNumber getDistances()

The distances the input features are buffered. The distance units are specified by unit.

Returns:

JsArrayNumber

setDistances

public final void setDistances(int[] distances)

Set the distances parameter.

Parameters:

distances - - The distances the input features are buffered. The distance units are specified by unit.

isGeodesic

public final boolean isGeodesic()

If the input geometries are in geographic coordinate system set geodesic to true in order to generate a buffer polygon using a geodesic distance. The bufferSpatialReference property is ignored when geodesic is set to true. Requires ArcGIS Server 10.1 or greater geometry service. (As of v2.7)

Returns:

boolean

setGeodesic

public final void setGeodesic(boolean geodesic)

Set the geodesic parameter.

Parameters:

geodesic - - If the input geometries are in geographic coordinate system set geodesic to true in order to generate a buffer polygon using a geodesic distance. The bufferSpatialReference property is ignored when geodesic is set to true. Requires ArcGIS Server 10.1 or greater geometry service. (As of v2.7)

getGeometries

public final com.google.gwt.core.client.JsArray<Geometry> getGeometries()

The input geometries to buffer.

Returns:

JsArray

setGeometries

public final void setGeometries(Geometry[] geometries)

Set the geometries parameter.

Parameters:

geometries - - The input geometries to buffer.

getOutSpatialRefernce

public final SpatialReference getOutSpatialRefernce()

The spatial reference for the returned geometries. If outSpatialReference is not specified, the output geometries are in the spatial reference specified by bufferSR. If bufferSpatialReference is also not specified, they are in the spatial reference of the features.

Returns:

SpatialReference

setOutSpatialRefernce

public final void setOutSpatialRefernce(SpatialReference outSpatialReference)

Set the outSpatialReference parameter.

Parameters:

outSpatialReference - - The spatial reference for the returned geometries. If outSpatialReference is not specified, the output geometries are in the spatial reference specified by bufferSR. If bufferSpatialReference is also not specified, they are in the spatial reference of the features.

unionResults

public final boolean unionResults()

If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.

Returns:

boolean

setUnionResults

public final void setUnionResults(boolean unionResults)

Set the unionResults parameter.

Parameters:

unionResults - - If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array.

getUnit

public final GeometryService.UnitType getUnit()

The units for calculating each buffer distance. If unit is not specified, the units are derived from bufferSpatialReference. If bufferSpatialReference is not specified, the units are derived from the features. See the Geometry service constants table for values.

Returns:

UnitType

setUnit

public final void setUnit(GeometryService.UnitType unit)

Set the unit parameter.

Parameters:

unit - - The units for calculating each buffer distance. If unit is not specified, the units are derived from bufferSpatialReference. If bufferSpatialReference is not specified, the units are derived from the features. See the Geometry service constants table for values.