com.esri.arcgis.controls
Class ARFeatureSet

java.lang.Object
  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.

Description

Use the ARFeatureSet object to iterate over the set of ARFeature objects that are returned from the IARLayer::QueryARFeatures , IARMap::QueryARFeatures and IARGlobe::QueryARFeatures methods. Unlike the ARFeatureCursor, the ARFeatureSet supports retrieving ARFeature objects that have already been retrieved and supports making multiple passes over the features. This is useful if there are a small number of ARFeature objects; an ARFeatureSet can consume a lot of memory and take a long time to be populated.

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.

Description

The ARFeatureCount property returns the number of ARFeature's within 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.

Description

The Next method advances the ARFeatureSet by one, and returns the ARFeature object at that position.

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.

Description

Resets the ARFeatureSet to the beginning. To make subsequent passes through the ARFeatureSet use the Reset method to go back to the first ARFeature in the collection.

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.

Description

Use the CustomProperty to associate any useful data with the ARFeatureSet. This is similar to a 'Tag' property, and can be use to store strings, numbers and objects.

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.

Description

Centers the extent of all the features in the ARFeatureSet on the display to make them visible. The extent of the ARMap will change, but the IARMap::MapScale will remain the same. By default the screen is automatically refreshed.

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.

Description

Flashes all the features in the ARFeatureSet once on the display. The greater the ARFeatureCount, the longer it will take to flash the features. Before using the Flash method use the ZoomTo or CenterAt method to ensure that the ARFeature is visible in the ARMap display area to the user.

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.

Description

Flickers all the features in the ARFeatureSet on the display. This is like flashing the features four times in quick succession. The greater the ARFeatureCount, the longer it will take to flicker the features. Before using the Flicker method use the ZoomTo or CenterAt method to ensure that the ARFeature is visible in the ARMap display area to the user.

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.

Description

Zooms to the extent of all the features in the ARFeatureSet to make them visible on the display. This may change the IARMap::MapScale. By default the screen is automatically refreshed.

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.

Description

Highlights all the features in the ARFeatureSet on the display. By deafult the screen is automatically refreshed.

Remarks

This method acts on an instance of an object. In order to toggle the highlighting of an ARFeatureSet, one must work with the same instance of the object.

The Highlight method triggers the following events:

OnBeforeScreenDraw
OnAfterScreenDraw

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.