com.esri.arcgis.geodatabase
Class NetworkDatasetFDExtension

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

All Implemented Interfaces:

IDatasetContainer, IDatasetContainer2, IDatasetContainer3, IDatasetEdit, IFeatureDatasetExtension, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetworkDatasetFDExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureDatasetExtension, IDatasetContainer3, IDatasetEdit

A container for describing this network dataset's feature dataset extension properties.

Description

The NetworkDatasetFDExtension object contains members that facilitate the creation and browsing of network datasets inside of a geodatabase feature dataset. The IDatasetContainer2 interface contains the CreateDataset method which should be used to create network datasets with a populated data element.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

void	addDataset(IDataset datasetToAdd) Adds a dataset to the dataset collection.
IDataset	createDataset(IDEDataset dataElement) Given a data element, create a dataset in this container.
boolean	equals(Object o) Compare this object with another
IDataset	getDataset(int type, int index) The dataset associated with the specified index value and dataset type.
IDataset	getDatasetByID(int type, int datasetID) The dataset associated with the specified index value and dataset type.
IDataset	getDatasetByName(int type, String name) The dataset of the specified type with the specified name.
int	getDatasetCount(int type) The number of datasets of the specified type in this container.
IEnumDatasetName	getDatasetNames(int type) The names of all the datasets with the specified type.
IEnumDataset	getDatasets(int type) An enumerator over the datasets of the specified type.
IEnumDatasetType	getDatasetTypes() The names of all the datasets with the specified type.
IFeatureDataset	getFeatureDataset() Provides access to the feature dataset containing the extension.
int	hashCode() the hashcode for this object
void	init(IFeatureDataset dataset) Initialize the feature dataset extension.
boolean	isBeingEdited() True if the dataset is being edited.

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

NetworkDatasetFDExtension

public NetworkDatasetFDExtension(Object obj)
                          throws IOException

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

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

Throws:

IOException - if there are interop problems NetworkDatasetFDExtension theNetworkDatasetFDExtension = (NetworkDatasetFDExtension) 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

getFeatureDataset

public IFeatureDataset getFeatureDataset()
                                  throws IOException,
                                         AutomationException

Provides access to the feature dataset containing the extension.

Remarks

The FeatureDataset method returns a reference to the feature dataset associated with the FeatureDatasetExtension.

Product Availability

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

Specified by:

getFeatureDataset in interface IFeatureDatasetExtension

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(IFeatureDataset dataset)
          throws IOException,
                 AutomationException

Initialize the feature dataset extension.

Remarks

The Init method is for internal use only.

Product Availability

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

Specified by:

init in interface IFeatureDatasetExtension

Parameters:

dataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetByID

public IDataset getDatasetByID(int type,
                               int datasetID)
                        throws IOException,
                               AutomationException

The dataset associated with the specified index value and dataset type.

Product Availability

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

Specified by:

getDatasetByID in interface IDatasetContainer3

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

datasetID - The datasetID (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataset

public IDataset getDataset(int type,
                           int index)
                    throws IOException,
                           AutomationException

The dataset associated with the specified index value and dataset type.

Product Availability

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

Specified by:

getDataset in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int type)
                         throws IOException,
                                AutomationException

An enumerator over the datasets of the specified type.

Product Availability

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

Specified by:

getDatasets in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetCount

public int getDatasetCount(int type)
                    throws IOException,
                           AutomationException

The number of datasets of the specified type in this container.

Product Availability

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

Specified by:

getDatasetCount in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetByName

public IDataset getDatasetByName(int type,
                                 String name)
                          throws IOException,
                                 AutomationException

The dataset of the specified type with the specified name.

Product Availability

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

Specified by:

getDatasetByName in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int type)
                                 throws IOException,
                                        AutomationException

The names of all the datasets with the specified type.

Product Availability

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

Specified by:

getDatasetNames in interface IDatasetContainer2

Parameters:

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetTypes

public IEnumDatasetType getDatasetTypes()
                                 throws IOException,
                                        AutomationException

The names of all the datasets with the specified type.

Remarks

The DatasetTypes property returns an enumerator of IEnumDatasetType containing the supported esriDatasetTypes for the container. Use this method to determine the supported datasets for the container.

Product Availability

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

Specified by:

getDatasetTypes in interface IDatasetContainer2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createDataset

public IDataset createDataset(IDEDataset dataElement)
                       throws IOException,
                              AutomationException

Given a data element, create a dataset in this container.

Remarks

The CreateDataset method will create a dataset given a populated data element. Use the DatasetTypes property to determine the supported dataset types.

Product Availability

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

Specified by:

createDataset in interface IDatasetContainer2

Parameters:

dataElement - A reference to a com.esri.arcgis.geodatabase.IDEDataset (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDataset

public void addDataset(IDataset datasetToAdd)
                throws IOException,
                       AutomationException

Adds a dataset to the dataset collection.

Remarks

When calling this method on feature datasets, both the XY and Z spatial reference systems of the dataset (if applicable) must match those of the feature dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addDataset in interface IDatasetContainer

Parameters:

datasetToAdd - A reference to a com.esri.arcgis.geodatabase.IDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws IOException,
                             AutomationException

True if the dataset is being edited.

Remarks

Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.

The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isBeingEdited in interface IDatasetEdit

Returns:

The pIsBeingEdited

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.