com.esri.arcgis.geodatabase
Interface INetworkSource

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EdgeFeatureSource, INetworkSourceProxy, JunctionFeatureSource, NetworkSource, SDCNetworkSource, SystemJunctionSource, TurnFeatureSource

public interface INetworkSource

extends java.io.Serializable

Provides access to members that specify the properties of a source in a network dataset.

Product Availability

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

Remarks

The INetworkSource interface is used to access the properties of the network source, such as its name and source type.

To access the NetworkSource object for an existing network dataset source, use the Source, SourceByID, or SourceByName methods on the INetworkDataset interface.

The INetworkSource interface is also used to define a new network source. To create a new network source, cocreate the appropriate NetworkSource object, specify its properties, and pass the object to the INetworkBuild::AddSource method on the network dataset.

Method Summary

int	getElementType() Network element type of this network source.
int	getID() Unique identifier of this network source.
java.lang.String	getName() Name of the class associated with this network source.
INetworkSourceDirections	getNetworkSourceDirections() The driving directions settings for this network source.
IPropertySet	getProperties() Property set of this network source.
int	getSourceType() Type of network source.
boolean	isUsesGeometryInConnectivity() Indicates if the source object's geometry is used in determining network connectivity.
void	setElementType(int elementType) Network element type of this network source.
void	setName(java.lang.String sourceName) Name of the class associated with this network source.
void	setNetworkSourceDirectionsByRef(INetworkSourceDirections sourceDirections) The driving directions settings for this network source.
void	setProperties(IPropertySet sourceProperties) Property set of this network source.

Method Detail

getID

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

Unique identifier of this network source.

Remarks

Each source in a Network Dataset is identified by a unique value, the ID property. The ID property can be used to get a reference to the corresponding network source through the INetworkDataset::SourceByID property. This ID is different than the ID value returned by the IObjectClass::ObjectClassID property.

As with ObjectID values, SourceID values are never reused. They are not guaranteed to be sequential, but are guaranteed to be in increasing order based on when the source was added to the network. Unless the source is added or deleted from the DataElement, the SourceID values will remain constant after the INetworkDataset::UpdateSchema method is called.

Returns:

The iD

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementType

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

Network element type of this network source.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkElementType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementType

public void setElementType(int elementType)
                    throws java.io.IOException,
                           AutomationException

Network element type of this network source.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the class associated with this network source.

Returns:

The sourceName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String sourceName)
             throws java.io.IOException,
                    AutomationException

Name of the class associated with this network source.

Parameters:

sourceName - The sourceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

Property set of this network source.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperties

public void setProperties(IPropertySet sourceProperties)
                   throws java.io.IOException,
                          AutomationException

Property set of this network source.

Parameters:

sourceProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUsesGeometryInConnectivity

public boolean isUsesGeometryInConnectivity()
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the source object's geometry is used in determining network connectivity.

Remarks

The UsesGeometryInConnectivity property indicates whether the geometries of the features in a NetworkSource are used in determining how its network elements are connected to each other.

For example, the geometries of the features in an EdgeFeatureSource and JunctionFeatureSource are used to determine how the generated edge and junction elements connect to each other. The UsesGeometryInConnectivity property for these sources is True.

In contrast, the geometries of the features in a TurnFeatureSource are not used in deteriming how the turn elements are associated with the edges and junctions of the network -- the fields of the TurnFeatureSource feature class determine this. The UsesGeometryInConnectivity property for the TurnFeatureSource is False.

Returns:

The usesGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceType

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

Type of network source.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkSourceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNetworkSourceDirections

public INetworkSourceDirections getNetworkSourceDirections()
                                                    throws java.io.IOException,
                                                           AutomationException

The driving directions settings for this network source.

Remarks

The NetworkSourceDirections property specifies the information needed to generate driving directions when reporting routes traversing elements from this NetworkSource.

Returns:

A reference to a com.esri.arcgis.geodatabase.INetworkSourceDirections

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNetworkSourceDirectionsByRef

public void setNetworkSourceDirectionsByRef(INetworkSourceDirections sourceDirections)
                                     throws java.io.IOException,
                                            AutomationException

The driving directions settings for this network source.

Parameters:

sourceDirections - A reference to a com.esri.arcgis.geodatabase.INetworkSourceDirections (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.