edu.ucdavis.cstars.client.tasks

Class DistanceParameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.DistanceParameters

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

Input parameters for the distance method on the GeometryService. Geometry1 and geometry2 are required.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
static DistanceParameters	create() Creates a new DistanceParameters object.
GeometryService.UnitType	getDistanceUnit() Specifies the units for measuring distance between geometry1 and geometry2.
Geometry	getGeometry1() The geometry from which the distance is to measured.
Geometry	getGeometry2() The geometry to which the distance is measured.
boolean	isGeodesic() Default value is false.
void	setDistanceUnit(GeometryService.UnitType distanceUnit) Set the disance unit parameter.
void	setGeodesic(boolean geodesic) Set the geodesic parameter
void	setGeometry1(Geometry geometry1) Set the geometry1 parameter.
void	setGeometry2(Geometry geometry2) set the geometry2 parameter.

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 DistanceParameters create()

Creates a new DistanceParameters object.

Returns:

DistanceParameters

getDistanceUnit

public final GeometryService.UnitType getDistanceUnit()

Specifies the units for measuring distance between geometry1 and geometry2. If the unit is not specified the units are derived from the spatial reference.

Returns:

UnitType

setDistanceUnit

public final void setDistanceUnit(GeometryService.UnitType distanceUnit)

Set the disance unit parameter.

Parameters:

distanceUnit - - Specifies the units for measuring distance between geometry1 and geometry2. If the unit is not specified the units are derived from the spatial reference.

isGeodesic

public final boolean isGeodesic()

Default value is false. When true the geodesic distance between geometry1 and geometry2 is measured.

Returns:

boolean

setGeodesic

public final void setGeodesic(boolean geodesic)

Set the geodesic parameter

Parameters:

geodesic - - Default value is false. When true the geodesic distance between geometry1 and geometry2 is measured.

getGeometry1

public final Geometry getGeometry1()

The geometry from which the distance is to measured. The geometry can be one of the following geometry types: esriGeometryPoint, esriGeometryPolyline, esriGeometryPolygon or esriGeometryMultipoint.

Returns:

Geometry

setGeometry1

public final void setGeometry1(Geometry geometry1)

Set the geometry1 parameter.

Parameters:

geometry1 - - The geometry from which the distance is to measured. The geometry can be one of the following geometry types: esriGeometryPoint, esriGeometryPolyline, esriGeometryPolygon or esriGeometryMultipoint.

getGeometry2

public final Geometry getGeometry2()

The geometry to which the distance is measured. The geometry can be one of the following geomtry types: esriGeometryPoint, esriGeometryPolyline, esriGeometryPolygon or esriGeometryMultipoint.

Returns:

Geometry

setGeometry2

public final void setGeometry2(Geometry geometry2)

set the geometry2 parameter.

Parameters:

geometry2 - - The geometry to which the distance is measured. The geometry can be one of the following geomtry types: esriGeometryPoint, esriGeometryPolyline, esriGeometryPolygon or esriGeometryMultipoint.