com.esri.arcgis.controls
Class ARFeatureSet

java.lang.Object
  com.esri.arcgis.controls.ARFeatureSet

All Implemented Interfaces:

IARFeatureSet, java.io.Serializable

public class ARFeatureSet

extends java.lang.Object

implements IARFeatureSet

ARFeatureSet object.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

ARFeatureSet(java.lang.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(java.lang.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.
IARFeatureSet	getAsIARFeatureSet() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.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(java.lang.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

Constructor Detail

ARFeatureSet

public ARFeatureSet(java.lang.Object obj)
             throws java.io.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 ARFeatureSet theARFeatureSet = (ARFeatureSet) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIARFeatureSet

public IARFeatureSet getAsIARFeatureSet()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getARFeatureCount

public int getARFeatureCount()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IARFeatureSet

The number of features in the ARFeatureSet.

Specified by:

getARFeatureCount in interface IARFeatureSet

Returns:

The lCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARFeature

public IARFeature getARFeature(int index)
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IARFeatureSet

The feature at the specified index.

Specified by:

getARFeature in interface IARFeatureSet

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeature

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

next

public IARFeature next()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IARFeatureSet

Retrieves the next feature in the ARFeatureSet.

Specified by:

next in interface IARFeatureSet

Returns:

A reference to a com.esri.arcgis.controls.IARFeature

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IARFeatureSet

Resets the ARFeatureSet to the beginning.

Specified by:

reset in interface IARFeatureSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IARFeatureSet

A property to associate data with an object.

Specified by:

getCustomProperty in interface IARFeatureSet

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setCustomProperty

public void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IARFeatureSet

A property to associate data with an object.

Specified by:

setCustomProperty in interface IARFeatureSet

Parameters:

pVal - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

centerAt

public void centerAt()
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IARFeatureSet

Centers the map display on the center of the ARFeatureSet.

Specified by:

centerAt in interface IARFeatureSet

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

flash

public void flash()
           throws java.io.IOException,
                  AutomationException

Description copied from interface: IARFeatureSet

Flashes the features in the ARFeatureSet.

Specified by:

flash in interface IARFeatureSet

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

flicker

public void flicker()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IARFeatureSet

Flickers the features in the ARFeatureSet.

Specified by:

flicker in interface IARFeatureSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomTo

public void zoomTo()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IARFeatureSet

Zooms the map to display the ARFeatureSet.

Specified by:

zoomTo in interface IARFeatureSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

highlight

public void highlight(boolean bHighlight,
                      int color)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IARFeatureSet

Highlights the features in the ARFeatureSet.

Specified by:

highlight in interface IARFeatureSet

Parameters:

bHighlight - The bHighlight (in)

color - The color (A COM typedef) (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.