com.esri.arcgis.controls
Class ARFeature

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

All Implemented Interfaces:

IARFeature, java.io.Serializable

public class ARFeature

extends java.lang.Object

implements IARFeature

ARFeature object.

Product Availability

Available with ArcGIS Engine.

See Also:

Serialized Form

Constructor Summary

ARFeature(java.lang.Object obj)
Construct a ARFeature using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	centerAt() Centers the feature on the map display.
boolean	equals(java.lang.Object o) Compare this object with another
void	flash() Flashes the feature on the display.
void	flicker() Flickers the feature on the display.
IARFeature	getAsIARFeature() 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.
java.lang.String	getFieldAliasName(int index) The alias name of the field.
int	getFieldCount() The number of fields in the field collection.
java.lang.String	getFieldName(int index) The name of the field.
int	getFieldType(int index) The type of field.
java.lang.Object	getInternalObject() The internal ArcObjects IFeature object.
java.lang.Object	getValue(java.lang.Object index) The value of the field.
java.lang.String	getValueAsString(java.lang.Object index) A property to access the value of the specified field as a string.
int	hashCode() the hashcode for this object
void	highlight(boolean bHighlight, int color) Highlights the feature on the display.
boolean	isFieldAccessible(java.lang.Object index) A property that checks if the specified field is accessible.
void	setCustomProperty(java.lang.Object pVal) A property to associate data with an object.
void	zoomTo() Zooms the map to display the feature.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ARFeature

public ARFeature(java.lang.Object obj)
          throws java.io.IOException

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

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

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIARFeature

public IARFeature getAsIARFeature()

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

getValue

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

Description copied from interface: IARFeature

The value of the field.

Specified by:

getValue in interface IARFeature

Parameters:

index - A Variant (in)

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFieldCount

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

Description copied from interface: IARFeature

The number of fields in the field collection.

Specified by:

getFieldCount in interface IARFeature

Returns:

The lCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldName

public java.lang.String getFieldName(int index)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IARFeature

The name of the field.

Specified by:

getFieldName in interface IARFeature

Parameters:

index - The index (in)

Returns:

The sName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFieldAliasName

public java.lang.String getFieldAliasName(int index)
                                   throws java.io.IOException,
                                          AutomationException

Description copied from interface: IARFeature

The alias name of the field.

Specified by:

getFieldAliasName in interface IARFeature

Parameters:

index - The index (in)

Returns:

The sAliasName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getFieldType

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

Description copied from interface: IARFeature

The type of field.

Specified by:

getFieldType in interface IARFeature

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.controls.esriARFieldType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

zoomTo

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

Description copied from interface: IARFeature

Zooms the map to display the feature.

Specified by:

zoomTo in interface IARFeature

Throws:

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

AutomationException - If the ArcObject component throws an exception.

centerAt

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

Description copied from interface: IARFeature

Centers the feature on the map display.

Specified by:

centerAt in interface IARFeature

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: IARFeature

Flashes the feature on the display.

Specified by:

flash in interface IARFeature

Throws:

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

AutomationException - If the ArcObject component throws an exception.

flicker

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

Description copied from interface: IARFeature

Flickers the feature on the display.

Specified by:

flicker in interface IARFeature

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInternalObject

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

Description copied from interface: IARFeature

The internal ArcObjects IFeature object.

Specified by:

getInternalObject in interface IARFeature

Returns:

A reference to another Object (IUnknown)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCustomProperty

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

Description copied from interface: IARFeature

A property to associate data with an object.

Specified by:

getCustomProperty in interface IARFeature

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: IARFeature

A property to associate data with an object.

Specified by:

setCustomProperty in interface IARFeature

Parameters:

pVal - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

highlight

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

Description copied from interface: IARFeature

Highlights the feature on the display.

Specified by:

highlight in interface IARFeature

Parameters:

bHighlight - The bHighlight (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFieldAccessible

public boolean isFieldAccessible(java.lang.Object index)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IARFeature

A property that checks if the specified field is accessible.

Specified by:

isFieldAccessible in interface IARFeature

Parameters:

index - A Variant (in)

Returns:

The bAccessible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValueAsString

public java.lang.String getValueAsString(java.lang.Object index)
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IARFeature

A property to access the value of the specified field as a string.

Specified by:

getValueAsString in interface IARFeature

Parameters:

index - A Variant (in)

Returns:

The bsValueAsString

Throws:

AutomationException - If the ArcObject component throws an exception.

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