com.esri.aims.mtier.model.map.layer.query
Class Buffer

java.lang.Object
  com.esri.aims.mtier.model.map.layer.query.Buffer

All Implemented Interfaces:

Serializable

public class Buffer
extends Object
implements Serializable

The Buffer object is used to perform specific buffers against a service. The Buffer object contains all the properties that specifies the type of buffer.

See Also:

Serialized Form

Field Summary

static String	DECIMAL_DEGREES Defines Buffer units as.
static String	FEET Defines Buffer units.
static String	KILOMETERS Defines Buffer units.
static String	METERS Defines Buffer units.
static String	MILES Defines Buffer units.

Constructor Summary

Buffer()
Constructs an instance of a Buffer object.

Method Summary

double	getBufferDistance() Returns the buffer distance.
Symbol	getBufferRegionSymbol() Returns the symbol object associated with this regional buffer layer.
Symbol	getBufferSelectionSymbol() Returns the selected buffer features layers symbol object.
FeatureLayer	getBufferTargetLayer() Returns the filter objects buffer target layer.
String	getBufferUnits() Returns the buffer units value.
boolean	isPerformBuffer() Returns true if setPerformBuffer(true) is called.
boolean	isProjectBuffer() Determines if buffer projection is set.
void	setBufferDistance(double value) Sets the distance of the buffer.
void	setBufferRegionSymbol(Object symbolObject) Sets the regional buffer layers symbol object.
void	setBufferSelectionSymbol(Object symbolObject) Sets the given Symbol object for this buffer features layer.
void	setBufferTargetLayer(FeatureLayer targetLayer) Sets the filter objects buffer target layer.
void	setBufferUnits(String value) Sets the buffer units.
void	setPerformBuffer(boolean value) Set this method to true before calling Map.createBufferImage.
void	setProjectBuffer(boolean value) If set to false, the buffer is not projected.

Methods inherited from class java.lang.Object

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

Field Detail

DECIMAL_DEGREES

public static final String DECIMAL_DEGREES

Defines Buffer units as.

See Also:

Constant Field Values

FEET

public static final String FEET

Defines Buffer units.

See Also:

Constant Field Values

METERS

public static final String METERS

Defines Buffer units.

See Also:

Constant Field Values

KILOMETERS

public static final String KILOMETERS

Defines Buffer units.

See Also:

Constant Field Values

MILES

public static final String MILES

Defines Buffer units.

See Also:

Constant Field Values

Constructor Detail

Buffer

public Buffer()

Constructs an instance of a Buffer object. Example:

Buffer buffer = new Buffer();

Method Detail

setBufferDistance

public void setBufferDistance(double value)

Sets the distance of the buffer. Example:

buffer.setBufferDistance(125.0);

Parameters:

value - the buffer distance.

See Also:

getBufferDistance()

getBufferDistance

public double getBufferDistance()

Returns the buffer distance. Example:

double bufferDistance = buffer.getBufferDistance();

Returns:

double

setBufferUnits

public void setBufferUnits(String value)

Sets the buffer units. Example:

buffer.setBufferUnits(buffer.DECIMAL_DEGREES);

Parameters:

value - the map units that apply to a buffer.

getBufferUnits

public String getBufferUnits()

Returns the buffer units value. Example:

String units = buffer.getBufferUnits();

Returns:

String

setBufferTargetLayer

public void setBufferTargetLayer(FeatureLayer targetLayer)

Sets the filter objects buffer target layer. The buffer target layer is the layer that you want to select features from that falls within the buffer area. Example:

 FeatureLayer targetLayer = map.getLayers().item(0);
 buffer.setBufferTargetLayer(targetLayer);
 

Parameters:

targetLayer - the FeatureLayer object.

See Also:

getBufferTargetLayer()

getBufferTargetLayer

public FeatureLayer getBufferTargetLayer()

Returns the filter objects buffer target layer. The buffer target layer is the layer that you want to select features from, that falls within the buffer area. Example:

 FeatureLayer targetlayer = buffer.getBufferTargetLayer();
 

Returns:

FeatureLayer

See Also:

setBufferTargetLayer(com.esri.aims.mtier.model.map.layer.FeatureLayer)

setBufferSelectionSymbol

public void setBufferSelectionSymbol(Object symbolObject)

Sets the given Symbol object for this buffer features layer. Example:

 SimpleMarkerSymbol simpleMarker = new SimpleMarkerSymbol();
 simpleMarker.setColor("255,0,0");
 buffer.setBufferSelectionSymbol(simpleMarker);
 

Parameters:

symbolObject - the symbol object.

See Also:

getBufferSelectionSymbol()

getBufferSelectionSymbol

public Symbol getBufferSelectionSymbol()

Returns the selected buffer features layers symbol object. Example:

 Symbol symbol = buffer.getBufferSelectionSymbol();
 

Returns:

Symbol

See Also:

setBufferSelectionSymbol(java.lang.Object)

setBufferRegionSymbol

public void setBufferRegionSymbol(Object symbolObject)

Sets the regional buffer layers symbol object. Objects set to this layer must be for polygon topology. Example:

 SimplePolygonSymbol simplePolygon = new SimplePolygonSymbol();
 simplePolygon.setFillColor("255,0,0");
 buffer.setBufferRegionSymbol(simplePolygon);
 

Parameters:

symbolObject - the polygon symbol.

See Also:

getBufferRegionSymbol()

getBufferRegionSymbol

public Symbol getBufferRegionSymbol()

Returns the symbol object associated with this regional buffer layer. Example:

 Symbol symbol = buffer.getBufferRegionSymbol();
 

Returns:

Object

See Also:

setBufferRegionSymbol(java.lang.Object)

setProjectBuffer

public void setProjectBuffer(boolean value)

If set to false, the buffer is not projected. This method sets the attribute "project" in the BUFFER element in an ArcXML request. Please refer to ArcXML Programmer's Reference Guide for more information. Example:

buffer.setProjectBuffer(true);

Parameters:

value - specifies performing projections on the buffer.

isProjectBuffer

public boolean isProjectBuffer()

Determines if buffer projection is set. Example:

 if(buffer.isProjectBuffer() == true){
  buffer.setProjectBuffer(false);
 }
 

Returns:

a boolean value.

setPerformBuffer

public void setPerformBuffer(boolean value)

Set this method to true before calling Map.createBufferImage. Example: buffer.setPerformBuffer(true);

Parameters:

value - default is false.

See Also:

isPerformBuffer()

isPerformBuffer

public boolean isPerformBuffer()

Returns true if setPerformBuffer(true) is called. Example:

 if(buffer.isPerformBuffer() == true){
  buffer.setPerformBuffer(false);
 }
 

Returns:

boolean

See Also:

setPerformBuffer(boolean)