com.esri.arcgis.geometry
Class BufferConstruction

java.lang.Object
  extended by com.esri.arcgis.geometry.BufferConstruction
All Implemented Interfaces:
IBufferConstruction, IBufferConstructionProperties, IBufferConstructionProperties2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class BufferConstruction
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IBufferConstruction, IBufferConstructionProperties, IBufferConstructionProperties2

COM Class 'BufferConstruction'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriGeometry.olb'

Description 'Buffers collections of lines or collections of polygons.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.geometry.IBufferConstruction
IID, IID2d199435_c30b_480d_b7da_587f8fd32124, xxDummy
 
Fields inherited from interface com.esri.arcgis.geometry.IBufferConstructionProperties2
IID, IID3b4ca07a_7a46_4766_86dc_4b4f81035c88, xxDummy
 
Fields inherited from interface com.esri.arcgis.geometry.IBufferConstructionProperties
IIDea859cce_60b2_4621_8b54_154cddd81947
 
Constructor Summary
BufferConstruction()
          Constructs a BufferConstruction using ArcGIS Engine.
BufferConstruction(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BufferConstruction theBufferConstruction = (BufferConstruction) obj;
 
Method Summary
 IGeometry buffer(IGeometry pInGeometry, double distance)
          Compatibility method for clients wishing to replace useages of ITopologicalOperator::Buffer.
 void constructBuffers(IEnumGeometry pInputGeometries, double distance, IGeometryCollection pOutputBuffers)
          Constructs buffer polygons at the specified distance for the set of input geometries.
 void constructBuffersByDistances(IGeometricBufferSourceSink pBufferInputOutput)
          Constructs buffer polygons for the set of input geometries and distances supplied from the specified source-sink interface.
 void constructBuffersByDistances2(IEnumGeometry pInputGeometries, IDoubleArray pDistances, IGeometryCollection pOutputBuffers)
          Constructs buffer polygons for the set of input geometries and distances supplied from arrays.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IBufferProgress getBufferProgress()
          Report the progress of a buffer operation via this callback interface.
static java.lang.String getClsid()
          getClsid.
 double getDensifyDeviation()
          For planar buffering, the max dist.
 IDoubleArray getDistanceOffsets()
          Constructs concentric buffers at the base distance plus each distance offset.
 ILongArray getEmptyBufferIDs()
          Returns an array of identifiers of input geometries that result in empty buffers - typically as a result of buffering polygons by negative distances.
 int getEndOption()
          Specifies the shape of the end caps of polyline buffers; defaults to 'esriBufferRound'.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getSideOption()
          Specifies on which side of a polyline its buffer is constructed; defaults to 'esriBufferFull' (both sides).
 IUnit getUnit()
          The unit of measure used for the buffering distance and densification deviation distance (optional, default units are obtained from spatial reference of input geometries).
 int hashCode()
          the hashcode for this object
 boolean isExplodeBuffers()
          Specifies whether or not output buffers can have multiple outer rings (defaut is false).
 boolean isGenerateCurves()
          Specifies whether sequences of curve points are replaced with true curves in the output buffers (default is true).
 boolean isOutsideOnly()
          Excludes the inside of the input polygon from the output buffer (default = false).
 boolean isUnionOverlappingBuffers()
          Specifies whether or not overlaps are preserved in the set of output buffers (default is false).
 boolean isUseGeodesicBuffering()
          Specifies whether planar or geodesic (on an ellipsoid) buffering is done.
 void release()
          Release a BufferConstruction.
 void setBufferProgressByRef(IBufferProgress ppProgress)
          Report the progress of a buffer operation via this callback interface.
 void setDensifyDeviation(double pDeviation)
          For planar buffering, the max dist.
 void setDistanceOffsetsByRef(IDoubleArray ppDistanceOffsets)
          Constructs concentric buffers at the base distance plus each distance offset.
 void setEndOption(int pEndOption)
          Specifies the shape of the end caps of polyline buffers; defaults to 'esriBufferRound'.
 void setExplodeBuffers(boolean pExplodeBuffers)
          Specifies whether or not output buffers can have multiple outer rings (defaut is false).
 void setGenerateCurves(boolean pbGenerateCurves)
          Specifies whether sequences of curve points are replaced with true curves in the output buffers (default is true).
 void setOutsideOnly(boolean bpOutsideOnly)
          Excludes the inside of the input polygon from the output buffer (default = false).
 void setSideOption(int pSideOption)
          Specifies on which side of a polyline its buffer is constructed; defaults to 'esriBufferFull' (both sides).
 void setUnionOverlappingBuffers(boolean pbUnionOverlapping)
          Specifies whether or not overlaps are preserved in the set of output buffers (default is false).
 void setUnitByRef(IUnit ppUnit)
          The unit of measure used for the buffering distance and densification deviation distance (optional, default units are obtained from spatial reference of input geometries).
 void setUseGeodesicBuffering(boolean pbUseGeodesicBuffering)
          Specifies whether planar or geodesic (on an ellipsoid) buffering is done.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferConstruction

public BufferConstruction()
                   throws java.io.IOException,
                          java.net.UnknownHostException
Constructs a BufferConstruction using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

BufferConstruction

public BufferConstruction(java.lang.Object obj)
                   throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BufferConstruction theBufferConstruction = (BufferConstruction) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a BufferConstruction.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

constructBuffers

public void constructBuffers(IEnumGeometry pInputGeometries,
                             double distance,
                             IGeometryCollection pOutputBuffers)
                      throws java.io.IOException,
                             AutomationException
Constructs buffer polygons at the specified distance for the set of input geometries. The input geometries can be a mix of polylines, polygons, points and multipoints.

Specified by:
constructBuffers in interface IBufferConstruction
Parameters:
pInputGeometries - A reference to a com.esri.arcgis.geometry.IEnumGeometry (in)
distance - The distance (in)
pOutputBuffers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

constructBuffersByDistances

public void constructBuffersByDistances(IGeometricBufferSourceSink pBufferInputOutput)
                                 throws java.io.IOException,
                                        AutomationException
Constructs buffer polygons for the set of input geometries and distances supplied from the specified source-sink interface. The input geometries can be a mix of polylines, polygons, points and multipoints.

Specified by:
constructBuffersByDistances in interface IBufferConstruction
Parameters:
pBufferInputOutput - A reference to a com.esri.arcgis.geometry.IGeometricBufferSourceSink (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

constructBuffersByDistances2

public void constructBuffersByDistances2(IEnumGeometry pInputGeometries,
                                         IDoubleArray pDistances,
                                         IGeometryCollection pOutputBuffers)
                                  throws java.io.IOException,
                                         AutomationException
Constructs buffer polygons for the set of input geometries and distances supplied from arrays. The input geometries can be a mix of polylines, polygons, points and multipoints.

Specified by:
constructBuffersByDistances2 in interface IBufferConstruction
Parameters:
pInputGeometries - A reference to a com.esri.arcgis.geometry.IEnumGeometry (in)
pDistances - A reference to a com.esri.arcgis.system.IDoubleArray (in)
pOutputBuffers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

buffer

public IGeometry buffer(IGeometry pInGeometry,
                        double distance)
                 throws java.io.IOException,
                        AutomationException
Compatibility method for clients wishing to replace useages of ITopologicalOperator::Buffer. This method does not use the properties exposed in IBufferConstructionProperties.

Specified by:
buffer in interface IBufferConstruction
Parameters:
pInGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
distance - The distance (in)
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEmptyBufferIDs

public ILongArray getEmptyBufferIDs()
                             throws java.io.IOException,
                                    AutomationException
Returns an array of identifiers of input geometries that result in empty buffers - typically as a result of buffering polygons by negative distances. The identifier is either a sequence number or a geomID.

Specified by:
getEmptyBufferIDs in interface IBufferConstruction
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBufferProgressByRef

public void setBufferProgressByRef(IBufferProgress ppProgress)
                            throws java.io.IOException,
                                   AutomationException
Report the progress of a buffer operation via this callback interface.

Specified by:
setBufferProgressByRef in interface IBufferConstructionProperties
Parameters:
ppProgress - A reference to a com.esri.arcgis.geometry.IBufferProgress (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferProgress

public IBufferProgress getBufferProgress()
                                  throws java.io.IOException,
                                         AutomationException
Report the progress of a buffer operation via this callback interface.

Specified by:
getBufferProgress in interface IBufferConstructionProperties
Returns:
A reference to a com.esri.arcgis.geometry.IBufferProgress
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDistanceOffsetsByRef

public void setDistanceOffsetsByRef(IDoubleArray ppDistanceOffsets)
                             throws java.io.IOException,
                                    AutomationException
Constructs concentric buffers at the base distance plus each distance offset.

Specified by:
setDistanceOffsetsByRef in interface IBufferConstructionProperties
Parameters:
ppDistanceOffsets - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceOffsets

public IDoubleArray getDistanceOffsets()
                                throws java.io.IOException,
                                       AutomationException
Constructs concentric buffers at the base distance plus each distance offset.

Specified by:
getDistanceOffsets in interface IBufferConstructionProperties
Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnitByRef

public void setUnitByRef(IUnit ppUnit)
                  throws java.io.IOException,
                         AutomationException
The unit of measure used for the buffering distance and densification deviation distance (optional, default units are obtained from spatial reference of input geometries).

Specified by:
setUnitByRef in interface IBufferConstructionProperties
Parameters:
ppUnit - A reference to a com.esri.arcgis.geometry.IUnit (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnit

public IUnit getUnit()
              throws java.io.IOException,
                     AutomationException
The unit of measure used for the buffering distance and densification deviation distance (optional, default units are obtained from spatial reference of input geometries).

Specified by:
getUnit in interface IBufferConstructionProperties
Returns:
A reference to a com.esri.arcgis.geometry.IUnit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSideOption

public void setSideOption(int pSideOption)
                   throws java.io.IOException,
                          AutomationException
Specifies on which side of a polyline its buffer is constructed; defaults to 'esriBufferFull' (both sides).

Specified by:
setSideOption in interface IBufferConstructionProperties
Parameters:
pSideOption - A com.esri.arcgis.geometry.esriBufferConstructionSideEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSideOption

public int getSideOption()
                  throws java.io.IOException,
                         AutomationException
Specifies on which side of a polyline its buffer is constructed; defaults to 'esriBufferFull' (both sides).

Specified by:
getSideOption in interface IBufferConstructionProperties
Returns:
A com.esri.arcgis.geometry.esriBufferConstructionSideEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutsideOnly

public void setOutsideOnly(boolean bpOutsideOnly)
                    throws java.io.IOException,
                           AutomationException
Excludes the inside of the input polygon from the output buffer (default = false).

Specified by:
setOutsideOnly in interface IBufferConstructionProperties
Parameters:
bpOutsideOnly - The bpOutsideOnly (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isOutsideOnly

public boolean isOutsideOnly()
                      throws java.io.IOException,
                             AutomationException
Excludes the inside of the input polygon from the output buffer (default = false).

Specified by:
isOutsideOnly in interface IBufferConstructionProperties
Returns:
The bpOutsideOnly
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndOption

public void setEndOption(int pEndOption)
                  throws java.io.IOException,
                         AutomationException
Specifies the shape of the end caps of polyline buffers; defaults to 'esriBufferRound'.

Specified by:
setEndOption in interface IBufferConstructionProperties
Parameters:
pEndOption - A com.esri.arcgis.geometry.esriBufferConstructionEndEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndOption

public int getEndOption()
                 throws java.io.IOException,
                        AutomationException
Specifies the shape of the end caps of polyline buffers; defaults to 'esriBufferRound'.

Specified by:
getEndOption in interface IBufferConstructionProperties
Returns:
A com.esri.arcgis.geometry.esriBufferConstructionEndEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGenerateCurves

public void setGenerateCurves(boolean pbGenerateCurves)
                       throws java.io.IOException,
                              AutomationException
Specifies whether sequences of curve points are replaced with true curves in the output buffers (default is true).

Specified by:
setGenerateCurves in interface IBufferConstructionProperties
Parameters:
pbGenerateCurves - The pbGenerateCurves (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGenerateCurves

public boolean isGenerateCurves()
                         throws java.io.IOException,
                                AutomationException
Specifies whether sequences of curve points are replaced with true curves in the output buffers (default is true).

Specified by:
isGenerateCurves in interface IBufferConstructionProperties
Returns:
The pbGenerateCurves
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDensifyDeviation

public void setDensifyDeviation(double pDeviation)
                         throws java.io.IOException,
                                AutomationException
For planar buffering, the max dist. between a line connecting two buffer curve points and the true curve (defaults to -1, indicating 1000 * xy tol of sr of input geoms ). For geodesic buffering default to 10 meters.

Specified by:
setDensifyDeviation in interface IBufferConstructionProperties
Parameters:
pDeviation - The pDeviation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDensifyDeviation

public double getDensifyDeviation()
                           throws java.io.IOException,
                                  AutomationException
For planar buffering, the max dist. between a line connecting two buffer curve points and the true curve (defaults to -1, indicating 1000 * xy tol of sr of input geoms ). For geodesic buffering default to 10 meters.

Specified by:
getDensifyDeviation in interface IBufferConstructionProperties
Returns:
The pDeviation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnionOverlappingBuffers

public void setUnionOverlappingBuffers(boolean pbUnionOverlapping)
                                throws java.io.IOException,
                                       AutomationException
Specifies whether or not overlaps are preserved in the set of output buffers (default is false).

Specified by:
setUnionOverlappingBuffers in interface IBufferConstructionProperties
Parameters:
pbUnionOverlapping - The pbUnionOverlapping (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUnionOverlappingBuffers

public boolean isUnionOverlappingBuffers()
                                  throws java.io.IOException,
                                         AutomationException
Specifies whether or not overlaps are preserved in the set of output buffers (default is false).

Specified by:
isUnionOverlappingBuffers in interface IBufferConstructionProperties
Returns:
The pbUnionOverlapping
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExplodeBuffers

public void setExplodeBuffers(boolean pExplodeBuffers)
                       throws java.io.IOException,
                              AutomationException
Specifies whether or not output buffers can have multiple outer rings (defaut is false).

Specified by:
setExplodeBuffers in interface IBufferConstructionProperties
Parameters:
pExplodeBuffers - The pExplodeBuffers (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExplodeBuffers

public boolean isExplodeBuffers()
                         throws java.io.IOException,
                                AutomationException
Specifies whether or not output buffers can have multiple outer rings (defaut is false).

Specified by:
isExplodeBuffers in interface IBufferConstructionProperties
Returns:
The pExplodeBuffers
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseGeodesicBuffering

public void setUseGeodesicBuffering(boolean pbUseGeodesicBuffering)
                             throws java.io.IOException,
                                    AutomationException
Specifies whether planar or geodesic (on an ellipsoid) buffering is done.

Specified by:
setUseGeodesicBuffering in interface IBufferConstructionProperties2
Parameters:
pbUseGeodesicBuffering - The pbUseGeodesicBuffering (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseGeodesicBuffering

public boolean isUseGeodesicBuffering()
                               throws java.io.IOException,
                                      AutomationException
Specifies whether planar or geodesic (on an ellipsoid) buffering is done.

Specified by:
isUseGeodesicBuffering in interface IBufferConstructionProperties2
Returns:
The pbUseGeodesicBuffering
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.