com.esri.arcgis.controls
Class ARFeatureSet

java.lang.Object
  extended by com.esri.arcgis.controls.ARFeatureSet
All Implemented Interfaces:
IARFeatureSet, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARFeatureSet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARFeatureSet

ARFeatureSet object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARFeatureSet(Object obj)
          Construct a ARFeatureSet using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void centerAt()
          Centers the map display on the center of the ARFeatureSet.
 boolean equals(Object o)
          Compare this object with another
 void flash()
          Flashes the features in the ARFeatureSet.
 void flicker()
          Flickers the features in the ARFeatureSet.
 IARFeature getARFeature(int index)
          The feature at the specified index.
 int getARFeatureCount()
          The number of features in the ARFeatureSet.
 Object getCustomProperty()
          A property to associate data with an object.
 int hashCode()
          the hashcode for this object
 void highlight(boolean bHighlight, int color)
          Highlights the features in the ARFeatureSet.
 IARFeature next()
          Retrieves the next feature in the ARFeatureSet.
 void reset()
          Resets the ARFeatureSet to the beginning.
 void setCustomProperty(Object pVal)
          A property to associate data with an object.
 void zoomTo()
          Zooms the map to display the ARFeatureSet.
 
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

ARFeatureSet

public ARFeatureSet(Object obj)
             throws IOException
Construct a ARFeatureSet using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARFeatureSet.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ARFeatureSet o = (ARFeatureSet)obj; // will not work

ARFeatureSet o = new ARFeatureSet(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ARFeatureSet theARFeatureSet = (ARFeatureSet) obj;
Method Detail

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

getARFeatureCount

public int getARFeatureCount()
                      throws IOException,
                             AutomationException
The number of features in the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getARFeatureCount in interface IARFeatureSet
Returns:
The lCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARFeature

public IARFeature getARFeature(int index)
                        throws IOException,
                               AutomationException
The feature at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getARFeature in interface IARFeatureSet
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeature
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

next

public IARFeature next()
                throws IOException,
                       AutomationException
Retrieves the next feature in the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
next in interface IARFeatureSet
Returns:
A reference to a com.esri.arcgis.controls.IARFeature
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the ARFeatureSet to the beginning.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
reset in interface IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getCustomProperty in interface IARFeatureSet
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setCustomProperty in interface IARFeatureSet
Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt()
              throws IOException,
                     AutomationException
Centers the map display on the center of the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
centerAt in interface IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

public void flash()
           throws IOException,
                  AutomationException
Flashes the features in the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
flash in interface IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flicker

public void flicker()
             throws IOException,
                    AutomationException
Flickers the features in the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
flicker in interface IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomTo

public void zoomTo()
            throws IOException,
                   AutomationException
Zooms the map to display the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
zoomTo in interface IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

highlight

public void highlight(boolean bHighlight,
                      int color)
               throws IOException,
                      AutomationException
Highlights the features in the ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
highlight in interface IARFeatureSet
Parameters:
bHighlight - The bHighlight (in)
color - The color (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.