com.esri.arcgis.geometry
Interface ISegmentCollection

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISegmentCollectionProxy, Path, Polygon, Polyline, Ring

public interface ISegmentCollection
extends java.io.Serializable

COM Interface 'ISegmentCollection'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeometry.olb'

Description: 'Provides access to members that manipulate the segments of a path, ring, polyline, or polygon.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDb3fe6b20_4fc2_11d1_834e_0000f8775be9
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addSegment(ISegment inSegment, java.lang.Object before, java.lang.Object after)
          Adds a reference to the input segment at the end, or before or after a specified index.
 void addSegmentCollection(ISegmentCollection segments)
          Adds references to the segments from the specified segment collection.
 void addSegments(int count, ISegment newSegments)
          Adds references to segments.
 IEnumCurve getEnumCurve()
          A new curve enumerator for this segment collection.
 IEnumSegment getEnumSegments()
          A new enumerator for this segment collection.
 IEnumSegment getIndexedEnumSegments(IGeometry queryGeometry)
          A new indexed segment enumerator for this segment collection.
 ISegment getSegment(int i)
          A reference to the ith segment.
 int getSegmentCount()
          The number of segments.
 void hasNonLinearSegments(boolean[] nonLinearSegments)
          Indicates if this segment collection contains segments other than lines.
 void insertSegmentCollection(int index, ISegmentCollection newSegments)
          Inserts references to the segments in the input collectoin.
 void insertSegmentCollectionEx(int index, int start, int count, ISegmentCollection newSegments)
          Inserts references to some of the segments from the input collection.
 void insertSegments(int index, int count, ISegment newSegments)
          Inserts references to the input segments.
 void querySegments(int index, int count, ISegment[] segments)
          Returns references to some of the input segments.
 void removeSegments(int index, int count, boolean closeGap)
          Removes references to some segments.
 void replaceSegmentCollection(int index, int goingAway, ISegmentCollection newSegments)
          Remove and inserts some segments.
 void replaceSegments(int index, int comingIn, int goingAway, ISegment newSegments)
          Removes and inserts from segments.
 void segmentsChanged()
          Informs the segment collection that any cached values that it may be maintaining (envelope, length, etc.) are invalid.
 void setCircle(IPoint cp, double circleRadius)
          Defines this path, ring, polyline or polygon to contain a single circular arc segment that is closed.
 void setRectangle(IEnvelope inEnvelope)
          Defines this path, ring, polyline or polygon to have four line segments in the same positions as the sides of the input envelope.
 void setSegmentCollection(ISegmentCollection newSegments)
          Replaces all segments with references to segments from the input collection.
 void setSegments(int count, ISegment newSegments)
          Replaces all segments with references to the input segments.
 

Field Detail

IIDb3fe6b20_4fc2_11d1_834e_0000f8775be9

static final int IIDb3fe6b20_4fc2_11d1_834e_0000f8775be9
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getSegmentCount

int getSegmentCount()
                    throws java.io.IOException,
                           AutomationException
The number of segments.

Returns:
The cSegments
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSegment

ISegment getSegment(int i)
                    throws java.io.IOException,
                           AutomationException
A reference to the ith segment.

Parameters:
i - The i (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISegment
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSegment

void addSegment(ISegment inSegment,
                java.lang.Object before,
                java.lang.Object after)
                throws java.io.IOException,
                       AutomationException
Adds a reference to the input segment at the end, or before or after a specified index.

Parameters:
inSegment - A reference to a com.esri.arcgis.geometry.ISegment (in)
before - A Variant (in, optional, pass null if not required)
after - A Variant (in, optional, pass null if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

querySegments

void querySegments(int index,
                   int count,
                   ISegment[] segments)
                   throws java.io.IOException,
                          AutomationException
Returns references to some of the input segments. This method is intended for internal use only.

Parameters:
index - The index (in)
count - The count (in)
segments - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSegments

void addSegments(int count,
                 ISegment newSegments)
                 throws java.io.IOException,
                        AutomationException
Adds references to segments. This method is intended for internal use only.

Parameters:
count - The count (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addSegmentCollection

void addSegmentCollection(ISegmentCollection segments)
                          throws java.io.IOException,
                                 AutomationException
Adds references to the segments from the specified segment collection.

Parameters:
segments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertSegments

void insertSegments(int index,
                    int count,
                    ISegment newSegments)
                    throws java.io.IOException,
                           AutomationException
Inserts references to the input segments. This method is intended for internal use only.

Parameters:
index - The index (in)
count - The count (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertSegmentCollection

void insertSegmentCollection(int index,
                             ISegmentCollection newSegments)
                             throws java.io.IOException,
                                    AutomationException
Inserts references to the segments in the input collectoin.

Parameters:
index - The index (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertSegmentCollectionEx

void insertSegmentCollectionEx(int index,
                               int start,
                               int count,
                               ISegmentCollection newSegments)
                               throws java.io.IOException,
                                      AutomationException
Inserts references to some of the segments from the input collection.

Parameters:
index - The index (in)
start - The start (in)
count - The count (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceSegments

void replaceSegments(int index,
                     int comingIn,
                     int goingAway,
                     ISegment newSegments)
                     throws java.io.IOException,
                            AutomationException
Removes and inserts from segments. This method is intended for internal use only.

Parameters:
index - The index (in)
comingIn - The comingIn (in)
goingAway - The goingAway (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceSegmentCollection

void replaceSegmentCollection(int index,
                              int goingAway,
                              ISegmentCollection newSegments)
                              throws java.io.IOException,
                                     AutomationException
Remove and inserts some segments.

Parameters:
index - The index (in)
goingAway - The goingAway (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeSegments

void removeSegments(int index,
                    int count,
                    boolean closeGap)
                    throws java.io.IOException,
                           AutomationException
Removes references to some segments. If closeGap is TRUE, then any remaining internal gap in the path, ring, polyline or polygon is connected with a single line segment.

Parameters:
index - The index (in)
count - The count (in)
closeGap - The closeGap (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCircle

void setCircle(IPoint cp,
               double circleRadius)
               throws java.io.IOException,
                      AutomationException
Defines this path, ring, polyline or polygon to contain a single circular arc segment that is closed.

Parameters:
cp - A reference to a com.esri.arcgis.geometry.IPoint (in)
circleRadius - The circleRadius (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRectangle

void setRectangle(IEnvelope inEnvelope)
                  throws java.io.IOException,
                         AutomationException
Defines this path, ring, polyline or polygon to have four line segments in the same positions as the sides of the input envelope.

Parameters:
inEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSegments

void setSegments(int count,
                 ISegment newSegments)
                 throws java.io.IOException,
                        AutomationException
Replaces all segments with references to the input segments. This method is intended for internal use only.

Parameters:
count - The count (in)
newSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSegmentCollection

void setSegmentCollection(ISegmentCollection newSegments)
                          throws java.io.IOException,
                                 AutomationException
Replaces all segments with references to segments from the input collection.

Parameters:
newSegments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnumSegments

IEnumSegment getEnumSegments()
                             throws java.io.IOException,
                                    AutomationException
A new enumerator for this segment collection.

Returns:
A reference to a com.esri.arcgis.geometry.IEnumSegment
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnumCurve

IEnumCurve getEnumCurve()
                        throws java.io.IOException,
                               AutomationException
A new curve enumerator for this segment collection.

Returns:
A reference to a com.esri.arcgis.geometry.IEnumCurve
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasNonLinearSegments

void hasNonLinearSegments(boolean[] nonLinearSegments)
                          throws java.io.IOException,
                                 AutomationException
Indicates if this segment collection contains segments other than lines.

Parameters:
nonLinearSegments - The nonLinearSegments (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIndexedEnumSegments

IEnumSegment getIndexedEnumSegments(IGeometry queryGeometry)
                                    throws java.io.IOException,
                                           AutomationException
A new indexed segment enumerator for this segment collection.

Parameters:
queryGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:
A reference to a com.esri.arcgis.geometry.IEnumSegment
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

segmentsChanged

void segmentsChanged()
                     throws java.io.IOException,
                            AutomationException
Informs the segment collection that any cached values that it may be maintaining (envelope, length, etc.) are invalid. Use this method after editing segments directly.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.