com.moximedia.aims
Class AimsBuffer

java.lang.Object
  extended bycom.moximedia.aims.AimsBuffer
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class AimsBuffer
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Implementation of ArcIMS buffer. When in SPATIALFILTER, BUFFER defines a new spatial filter polygon; this polygon will be built around the spatial filter's geometry and will be used as new spatial filter. When in SPATIALQUERY, BUFFER defines the polygon that will be built around features extracted by the query. When in SPATIALQUERY, BUFFER may have a TARGETLAYER subtag. In this case, the buffer built around all extracted features will be used as a spatial filter to extract features from the target layer.

Author:
Doug Cates
See Also:
Serialized Form

Constructor Summary
AimsBuffer()
          Creates new AimsBuffer
AimsBuffer(double distance)
          Creates new AimsBuffer with a specified distance
 
Method Summary
 java.lang.Object clone()
          Creates a copy of this object.
 boolean getProject()
          Gets the project attribute setting.
 AimsFeatureLayer getTargetLayer()
          Gets the buffer's target layer.
 void setDistance(double distance)
          Sets the buffer distance
 void setProject(boolean project)
          Sets the project attribute.
 void setTargetLayer(AimsFeatureLayer targetLayer)
          Sets the buffer's target layer.
 void setUnits(java.lang.String units)
          Sets the units of the buffer distance.
 java.lang.String toAxlString()
          Returns the AXL string to refresh this object, using the default environment coordinate separators.
 java.lang.String toAxlString(AimsEnvironment env)
          Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting.
 java.lang.String toAxlString(java.lang.String requestType, AimsEnvironment env)
          Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AimsBuffer

public AimsBuffer()
Creates new AimsBuffer


AimsBuffer

public AimsBuffer(double distance)
Creates new AimsBuffer with a specified distance

Parameters:
distance - The buffer distance.
Method Detail

setUnits

public void setUnits(java.lang.String units)
Sets the units of the buffer distance.

Parameters:
units - The units of the buffer distance.

setProject

public void setProject(boolean project)
Sets the project attribute.

Parameters:
project - The project attribute.

getProject

public boolean getProject()
Gets the project attribute setting.

Returns:
The project attribute setting.

setDistance

public void setDistance(double distance)
Sets the buffer distance

Parameters:
distance - The buffer distance.

getTargetLayer

public AimsFeatureLayer getTargetLayer()
Gets the buffer's target layer.

Returns:
The target layer for the buffer.

setTargetLayer

public void setTargetLayer(AimsFeatureLayer targetLayer)
Sets the buffer's target layer. The target layer is only used by buffers associated with AimsSpatialFilters.

Parameters:
targetLayer - The target layer for the buffer.

clone

public java.lang.Object clone()
Creates a copy of this object.

Returns:
An object that is a copy of this object. The object must be cast to an AimsBuffer before use.

toAxlString

public java.lang.String toAxlString()
Returns the AXL string to refresh this object, using the default environment coordinate separators. This method is not typically used by the application programmer.

Returns:
The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(AimsEnvironment env)
Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting. This method is not typically used by the application programmer.

Parameters:
env - The environment object containing coordinate separators.
Returns:
The AXL string to refresh this object.

toAxlString

public java.lang.String toAxlString(java.lang.String requestType,
                                    AimsEnvironment env)
Returns the AXL string to refresh this object, using the coordinate separators in the specified environnment setting. This method is not typically used by the application programmer.

Parameters:
requestType - The parent tag of the buffer, valid values are SPATIALQUERY or null.
env - The environment object containing coordinate separators.
Returns:
The AXL string to refresh this object.


Internet Mapping Framework for ArcIMS Java Object Model API (v5.1.00)
Copyright © 2006 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.