com.esri.arcgis.geodatabase
Class NetworkDatasetWorkspaceExtension

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

All Implemented Interfaces:

IDatasetContainer, IDatasetContainer2, IDatasetContainer3, IDatasetEdit, IWorkspaceExtension, IWorkspaceExtension2, IWorkspaceExtensionControl, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class NetworkDatasetWorkspaceExtension
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceExtension2, IWorkspaceExtensionControl, IDatasetContainer3, IDatasetEdit

COM Class 'NetworkDatasetWorkspaceExtension'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for describing this network dataset's workspace extension properties.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceExtension2

IID, IID727f1038_6df0_4972_b504_4a44cfea2b57, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceExtension

IIDda10c1c2_09a3_11d4_9faa_00c04f6bdf0c

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceExtensionControl

IID, IIDda10c1c0_09a3_11d4_9faa_00c04f6bdf0c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetContainer3

IID, IID1b7498c6_f47b_4ac6_a716_835b702a9cac, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetContainer2

IIDc826e861_dbfa_4b86_95fe_8352e287e284

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetContainer

IIDbd770969_efb7_11d3_9fa2_00c04f6bdf0c

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEdit

IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy

Constructor Summary

NetworkDatasetWorkspaceExtension(java.lang.Object obj)
Construct a NetworkDatasetWorkspaceExtension 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(java.lang.Object o) Compare this object with another
IEnumBSTR	getDataDictionaryTableNames() Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.
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, java.lang.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.
IUID	getGUID() The GUID that identifies this Workspace Extension.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The Name for this Workspace Extension.
IEnumBSTR	getPrivateDatasetNames(int dtype) The private datasets that should not be exposed to browsers.
IWorkspace	getWorkspace() The workspace associated with this Workspace Extension.
int	hashCode() the hashcode for this object
void	init(IWorkspaceHelper workspaceHelper) Initializes the extension, passing in a reference to its workspace helper.
boolean	isBeingEdited() True if the dataset is being edited.
boolean	ownsDatasetType(int datasetType) Indicates if the workspace extension owns the dataset type.
void	release() Release a NetworkDatasetWorkspaceExtension.
void	shutdown() Informs the extension that its workspace helper (and workspace) are going away.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkDatasetWorkspaceExtension

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

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

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

Throws:

java.io.IOException - if there are interop problems NetworkDatasetWorkspaceExtension theNetworkDatasetWorkspaceExtension = (NetworkDatasetWorkspaceExtension) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a NetworkDatasetWorkspaceExtension.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

ownsDatasetType

public boolean ownsDatasetType(int datasetType)
                        throws java.io.IOException,
                               AutomationException

Indicates if the workspace extension owns the dataset type.

Specified by:

ownsDatasetType in interface IWorkspaceExtension2

Parameters:

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

Returns:

The ownsType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace associated with this Workspace Extension.

Specified by:

getWorkspace in interface IWorkspaceExtension2

Returns:

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

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

The Name for this Workspace Extension.

Specified by:

getName in interface IWorkspaceExtension

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGUID

public IUID getGUID()
             throws java.io.IOException,
                    AutomationException

The GUID that identifies this Workspace Extension.

Specified by:

getGUID in interface IWorkspaceExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrivateDatasetNames

public IEnumBSTR getPrivateDatasetNames(int dtype)
                                 throws java.io.IOException,
                                        AutomationException

The private datasets that should not be exposed to browsers.

Specified by:

getPrivateDatasetNames in interface IWorkspaceExtension

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataDictionaryTableNames

public IEnumBSTR getDataDictionaryTableNames()
                                      throws java.io.IOException,
                                             AutomationException

Any data dictionary tables that should not be exposed to browsers and should not participate in edit sessions.

Specified by:

getDataDictionaryTableNames in interface IWorkspaceExtension

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

init

public void init(IWorkspaceHelper workspaceHelper)
          throws java.io.IOException,
                 AutomationException

Initializes the extension, passing in a reference to its workspace helper.

Specified by:

init in interface IWorkspaceExtensionControl

Parameters:

workspaceHelper - A reference to a com.esri.arcgis.geodatabase.IWorkspaceHelper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

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

Informs the extension that its workspace helper (and workspace) are going away.

Specified by:

shutdown in interface IWorkspaceExtensionControl

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetByID

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getDataset

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int type)
                         throws java.io.IOException,
                                AutomationException

An enumerator over the datasets of the specified type.

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:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetCount

public int getDatasetCount(int type)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getDatasetCount in interface IDatasetContainer2

Parameters:

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

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetByName

public IDataset getDatasetByName(int type,
                                 java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The dataset of the specified type with the specified name.

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:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int type)
                                 throws java.io.IOException,
                                        AutomationException

The names of all the datasets with the specified type.

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:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetTypes

public IEnumDatasetType getDatasetTypes()
                                 throws java.io.IOException,
                                        AutomationException

The names of all the datasets with the specified type.

Specified by:

getDatasetTypes in interface IDatasetContainer2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createDataset

public IDataset createDataset(IDEDataset dataElement)
                       throws java.io.IOException,
                              AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

addDataset

public void addDataset(IDataset datasetToAdd)
                throws java.io.IOException,
                       AutomationException

Adds a dataset to the dataset collection.

Specified by:

addDataset in interface IDatasetContainer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBeingEdited

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

True if the dataset is being edited.

Specified by:

isBeingEdited in interface IDatasetEdit

Returns:

The isBeingEdited

Throws:

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

AutomationException - If the ArcObject component throws an exception.