com.esri.arcgis.geodatabase
Class DirectionsLandmarkSource

java.lang.Object
  com.esri.arcgis.geodatabase.DirectionsLandmarkSource

All Implemented Interfaces:

IDirectionsLandmarkSource, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DirectionsLandmarkSource
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDirectionsLandmarkSource

Directions source information for landmark source feature classes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

DirectionsLandmarkSource()
Constructs a DirectionsLandmarkSource using ArcGIS Engine.

DirectionsLandmarkSource(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DirectionsLandmarkSource theDirectionsLandmarkSource = (DirectionsLandmarkSource) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getFeatureClassName() The name of the landmarks feature class.
String	getLabelFieldName() The name of the landmarks feature class field which is used to access the landmark display name.
String	getLevelFieldName() The name of the landmarks feature class field which is used to access the landmark Z-level value.
double	getSearchTolerance() The search tolerance value used to find landmarks along the route using spatial search.
int	getSearchToleranceUnits() The search tolerance value unit type.
int	hashCode() the hashcode for this object
boolean	isUseSpatialSearch() Indicates if spatial search should be used to locate landmarks along the route.
void	setFeatureClassName(String name) The name of the landmarks feature class.
void	setLabelFieldName(String name) The name of the landmarks feature class field which is used to access the landmark display name.
void	setLevelFieldName(String name) The name of the landmarks feature class field which is used to access the landmark Z-level value.
void	setSearchTolerance(double tolerance) The search tolerance value used to find landmarks along the route using spatial search.
void	setSearchToleranceUnits(int units) The search tolerance value unit type.
void	setUseSpatialSearch(boolean useSearch) Indicates if spatial search should be used to locate landmarks along the route.

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

DirectionsLandmarkSource

public DirectionsLandmarkSource()
                         throws IOException,
                                UnknownHostException

Constructs a DirectionsLandmarkSource using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DirectionsLandmarkSource

public DirectionsLandmarkSource(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DirectionsLandmarkSource theDirectionsLandmarkSource = (DirectionsLandmarkSource) obj;

Construct a DirectionsLandmarkSource using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DirectionsLandmarkSource.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

getFeatureClassName

public String getFeatureClassName()
                           throws IOException,
                                  AutomationException

The name of the landmarks feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getFeatureClassName in interface IDirectionsLandmarkSource

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassName

public void setFeatureClassName(String name)
                         throws IOException,
                                AutomationException

The name of the landmarks feature class.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setFeatureClassName in interface IDirectionsLandmarkSource

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

public String getLabelFieldName()
                         throws IOException,
                                AutomationException

The name of the landmarks feature class field which is used to access the landmark display name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLabelFieldName in interface IDirectionsLandmarkSource

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFieldName

public void setLabelFieldName(String name)
                       throws IOException,
                              AutomationException

The name of the landmarks feature class field which is used to access the landmark display name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLabelFieldName in interface IDirectionsLandmarkSource

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelFieldName

public String getLevelFieldName()
                         throws IOException,
                                AutomationException

The name of the landmarks feature class field which is used to access the landmark Z-level value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getLevelFieldName in interface IDirectionsLandmarkSource

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevelFieldName

public void setLevelFieldName(String name)
                       throws IOException,
                              AutomationException

The name of the landmarks feature class field which is used to access the landmark Z-level value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setLevelFieldName in interface IDirectionsLandmarkSource

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The search tolerance value used to find landmarks along the route using spatial search.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSearchTolerance in interface IDirectionsLandmarkSource

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerance

public void setSearchTolerance(double tolerance)
                        throws IOException,
                               AutomationException

The search tolerance value used to find landmarks along the route using spatial search.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSearchTolerance in interface IDirectionsLandmarkSource

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchToleranceUnits

public int getSearchToleranceUnits()
                            throws IOException,
                                   AutomationException

The search tolerance value unit type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getSearchToleranceUnits in interface IDirectionsLandmarkSource

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchToleranceUnits

public void setSearchToleranceUnits(int units)
                             throws IOException,
                                    AutomationException

The search tolerance value unit type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setSearchToleranceUnits in interface IDirectionsLandmarkSource

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSpatialSearch

public boolean isUseSpatialSearch()
                           throws IOException,
                                  AutomationException

Indicates if spatial search should be used to locate landmarks along the route.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isUseSpatialSearch in interface IDirectionsLandmarkSource

Returns:

The useSearch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSpatialSearch

public void setUseSpatialSearch(boolean useSearch)
                         throws IOException,
                                AutomationException

Indicates if spatial search should be used to locate landmarks along the route.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setUseSpatialSearch in interface IDirectionsLandmarkSource

Parameters:

useSearch - The useSearch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.