com.esri.arcgis.carto
Class FeatureCursorBuffer

java.lang.Object
  com.esri.arcgis.carto.FeatureCursorBuffer

All Implemented Interfaces:

IBufferProcessingParameter, IFeatureCursorBuffer, IFeatureCursorBuffer2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FeatureCursorBuffer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureCursorBuffer, IFeatureCursorBuffer2, IBufferProcessingParameter

A cursor for buffering features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FeatureCursorBuffer()
Constructs a FeatureCursorBuffer using ArcGIS Engine.

FeatureCursorBuffer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureCursorBuffer theFeatureCursorBuffer = (FeatureCursorBuffer) obj;

Method Summary

void	buffer(IFeatureClassName pNewLocationName) Buffers features to a new and existing feature class.
void	bufferToGraphics(ICompositeGraphicsLayer pCompositeGraphicsLayer) Buffers the selected features and stores them into a composite graphics layer.
boolean	equals(Object o) Compare this object with another
IEnumGeometry	getBufferedGeometry() Enumerator of buffered features.
static String	getClsid() getClsid.
void	graphicsLayer(IGraphicsLayer pGraphicsLayer, boolean selected) Graphics layer of elements to buffer (overrides FeatureCursor).
void	graphicsLayer2(IGraphicsLayer pGraphicsLayer, boolean selected, int[] pSelectedElements, boolean[] bHasPolygons) Graphics layer of elements to buffer (overrides FeatureCursor).
int	hashCode() the hashcode for this object
boolean	isAdjustCirclesForProjection() Indicates if circles are adjusted in Projected Coordinate Systems.
boolean	isGenerateRings() Indicates if ring buffers (hollow) are created instead of disk buffers (filled).
void	setAdjustCirclesForProjection(boolean adjustCirclesForProjection) Indicates if circles are adjusted in Projected Coordinate Systems.
void	setBufferSpatialReference(int rhs1) Indicates which spatial reference should be used for the buffering process.
void	setBufferSpatialReferenceByRef(ISpatialReference rhs1) Specifies in which spatial reference system should be buffered.
void	setCancelTrackByRef(ITrackCancel rhs1) TrackCancel used when buffering.
void	setDataFrameSpatialReferenceByRef(ISpatialReference rhs1) Specifies the spatial reference system of the data frame.
void	setDissolve(boolean rhs1) Indicates if overlapping buffered features should be dissolved.
void	setFeatureClassByRef(IFeatureClass rhs1) Establishes the reference to the source Feature Class, if any.
void	setFeatureCursorByRef(IFeatureCursor rhs1) Feature cursor of features to buffer (overrides GraphicsLayer).
void	setFieldDistance(String rhs1) Field specifying distance to buffer on.
void	setGenerateRings(boolean generateRings) Indicates if ring buffers (hollow) are created instead of disk buffers (filled).
void	setInputHasPolygons(boolean rhs1) Tells the buffer object explicitly that the input shapes contain polygons.
void	setPolygonBufferType(int rhs1) Indicates how to buffer polygon features.
void	setRingDistance(int numberOfRings, double rhs2) Multiple rings specifying distance to buffer on.
void	setSaveAsGraphics(boolean rhs1) Buffer output type (graphics or file).
void	setSimplifyShapes(boolean rhs1) Forces the buffer object to simplify the intermediate shapes during the buffer processing.
void	setSourceSpatialReferenceByRef(ISpatialReference rhs1) Specifies the spatial reference system of the source data (calls IFeatureCursorBuffer::SpatialReference()).
void	setSpatialReferenceByRef(ISpatialReference rhs1) Projection of buffered features.
void	setTargetSpatialReference(int rhs1) Indicates which spatial reference should be used for the buffer output.
void	setTargetSpatialReferenceByRef(ISpatialReference rhs1) Specifies the target spatial reference system.
void	setUnits(int mapUnits, int rhs2) Conversion units, from map units to buffer units.
void	setValueDistance(double rhs1) Constant buffer distance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

FeatureCursorBuffer

public FeatureCursorBuffer()
                    throws IOException,
                           UnknownHostException

Constructs a FeatureCursorBuffer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FeatureCursorBuffer

public FeatureCursorBuffer(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FeatureCursorBuffer theFeatureCursorBuffer = (FeatureCursorBuffer) obj;

Construct a FeatureCursorBuffer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FeatureCursorBuffer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setFeatureCursorByRef

public void setFeatureCursorByRef(IFeatureCursor rhs1)
                           throws IOException,
                                  AutomationException

Feature cursor of features to buffer (overrides GraphicsLayer).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureCursorByRef in interface IFeatureCursorBuffer

Specified by:

setFeatureCursorByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

graphicsLayer

public void graphicsLayer(IGraphicsLayer pGraphicsLayer,
                          boolean selected)
                   throws IOException,
                          AutomationException

Graphics layer of elements to buffer (overrides FeatureCursor).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

graphicsLayer in interface IFeatureCursorBuffer

Parameters:

pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)

selected - The selected (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDissolve

public void setDissolve(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if overlapping buffered features should be dissolved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDissolve in interface IFeatureCursorBuffer

Specified by:

setDissolve in interface IFeatureCursorBuffer2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValueDistance

public void setValueDistance(double rhs1)
                      throws IOException,
                             AutomationException

Constant buffer distance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setValueDistance in interface IFeatureCursorBuffer

Specified by:

setValueDistance in interface IFeatureCursorBuffer2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldDistance

public void setFieldDistance(String rhs1)
                      throws IOException,
                             AutomationException

Field specifying distance to buffer on.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFieldDistance in interface IFeatureCursorBuffer

Specified by:

setFieldDistance in interface IFeatureCursorBuffer2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRingDistance

public void setRingDistance(int numberOfRings,
                            double rhs2)
                     throws IOException,
                            AutomationException

Multiple rings specifying distance to buffer on.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setRingDistance in interface IFeatureCursorBuffer

Specified by:

setRingDistance in interface IFeatureCursorBuffer2

Parameters:

numberOfRings - The numberOfRings (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference rhs1)
                              throws IOException,
                                     AutomationException

Projection of buffered features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialReferenceByRef in interface IFeatureCursorBuffer

Specified by:

setSpatialReferenceByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int mapUnits,
                     int rhs2)
              throws IOException,
                     AutomationException

Conversion units, from map units to buffer units.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUnits in interface IFeatureCursorBuffer

Specified by:

setUnits in interface IFeatureCursorBuffer2

Parameters:

mapUnits - A com.esri.arcgis.system.esriUnits constant (in)

rhs2 - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPolygonBufferType

public void setPolygonBufferType(int rhs1)
                          throws IOException,
                                 AutomationException

Indicates how to buffer polygon features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPolygonBufferType in interface IFeatureCursorBuffer

Specified by:

setPolygonBufferType in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A com.esri.arcgis.carto.esriBufferType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelTrackByRef

public void setCancelTrackByRef(ITrackCancel rhs1)
                         throws IOException,
                                AutomationException

TrackCancel used when buffering.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelTrackByRef in interface IFeatureCursorBuffer

Specified by:

setCancelTrackByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferedGeometry

public IEnumGeometry getBufferedGeometry()
                                  throws IOException,
                                         AutomationException

Enumerator of buffered features.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBufferedGeometry in interface IFeatureCursorBuffer

Specified by:

getBufferedGeometry in interface IFeatureCursorBuffer2

Returns:

A reference to a com.esri.arcgis.geometry.IEnumGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

buffer

public void buffer(IFeatureClassName pNewLocationName)
            throws IOException,
                   AutomationException

Buffers features to a new and existing feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

buffer in interface IFeatureCursorBuffer

Specified by:

buffer in interface IFeatureCursorBuffer2

Parameters:

pNewLocationName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

graphicsLayer2

public void graphicsLayer2(IGraphicsLayer pGraphicsLayer,
                           boolean selected,
                           int[] pSelectedElements,
                           boolean[] bHasPolygons)
                    throws IOException,
                           AutomationException

Graphics layer of elements to buffer (overrides FeatureCursor).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

graphicsLayer2 in interface IFeatureCursorBuffer2

Parameters:

pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)

selected - The selected (in)

pSelectedElements - The pSelectedElements (out: use single element array)

bHasPolygons - The bHasPolygons (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bufferToGraphics

public void bufferToGraphics(ICompositeGraphicsLayer pCompositeGraphicsLayer)
                      throws IOException,
                             AutomationException

Buffers the selected features and stores them into a composite graphics layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

bufferToGraphics in interface IFeatureCursorBuffer2

Parameters:

pCompositeGraphicsLayer - A reference to a com.esri.arcgis.carto.ICompositeGraphicsLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceSpatialReferenceByRef

public void setSourceSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws IOException,
                                           AutomationException

Specifies the spatial reference system of the source data (calls IFeatureCursorBuffer::SpatialReference()).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSourceSpatialReferenceByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferSpatialReferenceByRef

public void setBufferSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws IOException,
                                           AutomationException

Specifies in which spatial reference system should be buffered.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setBufferSpatialReferenceByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetSpatialReferenceByRef

public void setTargetSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws IOException,
                                           AutomationException

Specifies the target spatial reference system.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setTargetSpatialReferenceByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataFrameSpatialReferenceByRef

public void setDataFrameSpatialReferenceByRef(ISpatialReference rhs1)
                                       throws IOException,
                                              AutomationException

Specifies the spatial reference system of the data frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setDataFrameSpatialReferenceByRef in interface IFeatureCursorBuffer2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdjustCirclesForProjection

public void setAdjustCirclesForProjection(boolean adjustCirclesForProjection)
                                   throws IOException,
                                          AutomationException

Indicates if circles are adjusted in Projected Coordinate Systems.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAdjustCirclesForProjection in interface IBufferProcessingParameter

Parameters:

adjustCirclesForProjection - The adjustCirclesForProjection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAdjustCirclesForProjection

public boolean isAdjustCirclesForProjection()
                                     throws IOException,
                                            AutomationException

Indicates if circles are adjusted in Projected Coordinate Systems.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isAdjustCirclesForProjection in interface IBufferProcessingParameter

Returns:

The adjustCirclesForProjection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGenerateRings

public void setGenerateRings(boolean generateRings)
                      throws IOException,
                             AutomationException

Indicates if ring buffers (hollow) are created instead of disk buffers (filled).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGenerateRings in interface IBufferProcessingParameter

Parameters:

generateRings - The generateRings (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isGenerateRings

public boolean isGenerateRings()
                        throws IOException,
                               AutomationException

Indicates if ring buffers (hollow) are created instead of disk buffers (filled).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isGenerateRings in interface IBufferProcessingParameter

Returns:

The generateRings

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveAsGraphics

public void setSaveAsGraphics(boolean rhs1)
                       throws IOException,
                              AutomationException

Buffer output type (graphics or file).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSaveAsGraphics in interface IBufferProcessingParameter

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass rhs1)
                          throws IOException,
                                 AutomationException

Establishes the reference to the source Feature Class, if any.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setFeatureClassByRef in interface IBufferProcessingParameter

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferSpatialReference

public void setBufferSpatialReference(int rhs1)
                               throws IOException,
                                      AutomationException

Indicates which spatial reference should be used for the buffering process.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBufferSpatialReference in interface IBufferProcessingParameter

Parameters:

rhs1 - A com.esri.arcgis.carto.esriBufferSpatialReferenceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetSpatialReference

public void setTargetSpatialReference(int rhs1)
                               throws IOException,
                                      AutomationException

Indicates which spatial reference should be used for the buffer output.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTargetSpatialReference in interface IBufferProcessingParameter

Parameters:

rhs1 - A com.esri.arcgis.carto.esriBufferSpatialReferenceType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputHasPolygons

public void setInputHasPolygons(boolean rhs1)
                         throws IOException,
                                AutomationException

Tells the buffer object explicitly that the input shapes contain polygons.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInputHasPolygons in interface IBufferProcessingParameter

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSimplifyShapes

public void setSimplifyShapes(boolean rhs1)
                       throws IOException,
                              AutomationException

Forces the buffer object to simplify the intermediate shapes during the buffer processing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSimplifyShapes in interface IBufferProcessingParameter

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.