com.esri.arcgis.geodatabase
Class UtilityNetwork

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

All Implemented Interfaces:

IDataset, IDatasetAnalyze, IDatasetEdit, IDatasetEditInfo, INetAttributes, INetAttributesEdit, INetElements, INetSchema, INetSchemaEdit, INetTopology, INetTopologyEdit, INetwork, INetworkUpdate, ISchemaLock, IUtilityNetworkGEN, IVersionedObject, IVersionedObject2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class UtilityNetwork
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IUtilityNetworkGEN, INetwork, INetworkUpdate, INetElements, INetSchema, INetSchemaEdit, INetTopology, INetTopologyEdit, INetAttributes, INetAttributesEdit, IDataset, IDatasetEdit, IDatasetEditInfo, ISchemaLock, IVersionedObject2, IDatasetAnalyze

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

Description 'A container for describing a utility network.' 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.IUtilityNetworkGEN

IID, IID32012812_0631_4d1e_b92f_13cad1502edf, xxDummy

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

IID19f99c80_a089_11d0_9cc9_00805f74d243

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

IID, IID051c9860_1880_11d2_b289_0000f878229e, xxDummy

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

IID, IID5db91db3_afb4_11d0_9ccd_00805f74d243, xxDummy

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

IID, IID5db91db1_afb4_11d0_9ccd_00805f74d243, xxDummy

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

IID5db91dbb_afb4_11d0_9ccd_00805f74d243

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

IID, IID2395087d_02d5_11d1_9cd5_00805f74d243, xxDummy

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

IID803b5ff1_0ab3_11d1_9cd6_00805f74d243

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

IID, IIDda7fd2c0_0794_11d1_9cd6_00805f74d243, xxDummy

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

IID027e7417_981b_11d1_b264_0000f878229e

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy

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

IID, IID234c31c1_9740_11d1_89e2_006097aff44e, xxDummy

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

IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy

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

IID, IID884d388e_8918_443a_8f4a_db5aac5b9d5e, xxDummy

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

IID4a1fb361_b863_11d1_9ce7_0000f8780619

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

IID, IID60262917_d53f_4e0b_86ff_a916c3fb26bc, xxDummy

Constructor Summary

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

Method Summary

int	addEdgeByEndEIDs(INetElementDescription edgeDescription, int fromJunctionEID, int toJunctionEID) Adds an edge element to the logical network between the specified junction elements.
INetElementClass	addElementClass(int userClassID) Adds a new element class to the network.
int	addJunction(INetElementDescription junctionDescription) Adds a junction element to the logical network.
void	addWeight(INetWeight networkWeight) Adds a new weight to the network.
void	addWeightAssociation(INetWeightAssociation weightSource) Adds a new weight association to the network.
void	analyze(int tableComponents) Analyze the data to update/generate DBMS statistics.
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	changeSchemaLock(int schemaLock) Changes a schema lock.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IForwardStar	createForwardStar(boolean honorState, INetWeight junctionWeight, INetWeight fromToEdgeWeight, INetWeight toFromEdgeWeight, INetWeight turnWeight) Creates a forward star cursor on the network index.
IEnumNetEID	createNetBrowser(int elementType) Creates a network index element browser.
void	delete() Deletes this dataset.
void	deleteByEID(int eID, int elementType) Deletes the specified network element from the logical network.
void	deleteByEIDs(int elementType, int elementCount, int[] elementEIDs) Deletes the specified network elements from the logical network.
void	deleteByID(int userClassID, int userID, int userSubID, int elementType) Deletes the specified network element from the logical network.
boolean	equals(java.lang.Object o) Compare this object with another
void	establishFlowDirection(int[] sourceEIDs, int[] sinkEIDs) Sets the flow direction of all edge elements based on the placement of sources and sinks.
void	getAdjacentEdge(int atJunctionEID, int index, int[] adjacentEdge, boolean[] reverseOrientation) Returns the network element ID of the index'th adjacent edge to the specified junction.
int	getAdjacentEdgeCount(int atJunctionEID) Returns the number of edges adjacent to the specified junction.
void	getAdjacentEdges(int atJunctionEID, int adjacentEdgesCount, int[] adjacentEdges, boolean[] reverseOrientation) Returns the network element IDs of all the edges adjacent to the specified junction.
int	getAllowableComponents() The allowable components to be analyzed.
void	getAncillaryRole(int userClassID, int[] ancillaryRole, java.lang.String[] ancillaryRoleFieldName) Returns the ancillary role type and the name of the field containing the ancillary role information.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
void	getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo) The list of current locks.
boolean	getDisabledState(int eID, int elementType) Returns the disabled state of the specified network element.
int	getEdgeCount() Number of edges in the network.
int	getEID(int userClassID, int userID, int userSubID, int elementType) Returns the network element ID (EID).
int	getEIDCount(int userClassID, int userID, int elementType) Returns the number of network element IDs (EIDs) corresponding to the specified user class ID and user ID.
IEnumNetEID	getEIDs(int userClassID, int userID, int elementType) Returns the network element IDs (EIDs) corresponding to the specified user classID and user ID.
INetElementClass	getElementClass(int index) Element class by index.
INetElementClass	getElementClassByUserID(int elementclassUserID) Element class corresponding to the specified user class ID.
int	getElementClassCount() Number of element classes in the network.
java.lang.String	getEnabledDisabledFieldName(int userClassID) Returns the name of the filed containing the enabled/disabled information for the specified user class.
int	getFlowDirection(int edgeEID) Returns the flow direction of the specified edge element.
void	getFromToJunctionEIDs(int edgeEID, int[] fromJunctionEID, int[] toJunctionEID) Returns the network element IDs of the junctions adjacent to the specified edge.
IName	getFullName() The associated name object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getJunctionCount() Number of junctions in the network.
int	getMaxDegree() Maximum degree of a junction.
int	getMaxTurn() Maximum number of turns associated with a junction.
java.lang.String	getName() The name of the Dataset.
IPropertySet	getPropertySet() The set of properties for the dataset.
int	getStatus() Status of the network.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getTurnCount() Number of turns in the network.
int	getType() The type of the Dataset.
IVersion	getVersion() The object's current version.
INetWeight	getWeight(int weightInternalID) Network weight corresponding to the specified weight internal ID.
IEnumNetWeightAssociation	getWeightAssociations(int weightInternalID) Network weight associations corresponding to the specified weight internal ID.
IEnumNetWeightAssociation	getWeightAssociationsByTableName(java.lang.String tableName) Network weight associations corresponding to the specified table name.
INetWeight	getWeightByName(java.lang.String weightName) Network weight corresponding to the specified name.
int	getWeightCount() Number of weights in the network.
java.lang.Object	getWeightValue(int eID, int elementType, int weightInternalID) Returns the weight value of the specified network element for the specified weight.
IWorkspace	getWorkspace() The workspace containing this dataset.
int	hashCode() the hashcode for this object
boolean	isAttributesBeingUpdated() Indicates if the attributes of the network are currently being updated.
boolean	isBeingEdited() True if the dataset is being edited.
boolean	isCanEdit() True if the dataset supports edit sessions with the ability to discard edits on save.
boolean	isCanRedo() True if the dataset supports edit sessions with the ability to redo undone operations.
boolean	isCanUndo() True if the dataset supports edit sessions with the ability to undo individual edit operations.
boolean	isHasUncompressedEdits() Indicates if the object has edits that haven't been compressed yet.
boolean	isRegisteredAsVersioned() Indicates if the object is registered as versioned.
boolean	isSchemaBeingUpdated() Indicates if the schema of the network is currently being updated.
boolean	isTopologyBeingUpdated() Indicates if the topology of the network is currently being updated.
boolean	isValidElement(int eID, int elementType) Returns whether the specified element is part of the network.
boolean	isValidFlowDirection() Indicates if the flow direction is valid for this utility network.
void	partialEstablishFlowDirection(int[] sourceEIDs, int[] sinkEIDs) Sets the flow direction of all reachable edge elements based on the placement of sources and sinks.
void	putAncillaryRole(int userClassID, int ancillaryRole, java.lang.String ancillaryRoleFieldName) Sets the ancillary role type and the name of the field containing the ancillary role information for the specified user class.
void	putEnabledDisabledFieldName(int userClassID, java.lang.String enabledDisabledRoleFieldName) Sets the name of the field containing the enabled/disabled information for the specified user class.
void	queryIDs(int eID, int elementType, int[] userClassID, int[] userID, int[] userSubID) Returns the user class ID, user ID, and user sub ID for the specified network element.
void	registerAsVersioned(boolean isVersioned) Register/UnRegister the object as being versioned.
void	release() Release a UtilityNetwork.
void	rename(java.lang.String name) Renames this Dataset.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setDisabledState(int eID, int elementType, boolean disableState) Sets the disabled state of the specified network element.
void	setFlowDirection(int edgeEID, int flowDirection) Sets the flow direction for the specified edge element.
void	setWeightValue(int eID, int elementType, int weightInternalID, java.lang.Object weightValue) Sets the weight value of the specified network element for the specified weight.
void	startAttributesUpdating() Starts a session for updating the attributes of the network.
void	startSchemaUpdating() Starts a session for updating the schema of the network.
void	startTopologyUpdating() Starts a session for updating the topology of the network.
void	stopAttributesUpdating() Ends the session for updating the attributes of the network.
void	stopSchemaUpdating() Ends the session for updating the schema for the network.
void	stopTopologyUpdating() Ends the session for updating the topology of the network.

Methods inherited from class java.lang.Object

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

Constructor Detail

UtilityNetwork

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

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

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

Throws:

java.io.IOException - if there are interop problems UtilityNetwork theUtilityNetwork = (UtilityNetwork) 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 UtilityNetwork.

Specified by:

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

isValidFlowDirection

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

Indicates if the flow direction is valid for this utility network.

Specified by:

isValidFlowDirection in interface IUtilityNetworkGEN

Returns:

The pValidFlowDirection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFlowDirection

public int getFlowDirection(int edgeEID)
                     throws java.io.IOException,
                            AutomationException

Returns the flow direction of the specified edge element.

Specified by:

getFlowDirection in interface IUtilityNetworkGEN

Parameters:

edgeEID - The edgeEID (in)

Returns:

A com.esri.arcgis.geodatabase.esriFlowDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlowDirection

public void setFlowDirection(int edgeEID,
                             int flowDirection)
                      throws java.io.IOException,
                             AutomationException

Sets the flow direction for the specified edge element.

Specified by:

setFlowDirection in interface IUtilityNetworkGEN

Parameters:

edgeEID - The edgeEID (in)

flowDirection - A com.esri.arcgis.geodatabase.esriFlowDirection constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

establishFlowDirection

public void establishFlowDirection(int[] sourceEIDs,
                                   int[] sinkEIDs)
                            throws java.io.IOException,
                                   AutomationException

Sets the flow direction of all edge elements based on the placement of sources and sinks.

Specified by:

establishFlowDirection in interface IUtilityNetworkGEN

Parameters:

sourceEIDs - The sourceEIDs (in)

sinkEIDs - The sinkEIDs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

partialEstablishFlowDirection

public void partialEstablishFlowDirection(int[] sourceEIDs,
                                          int[] sinkEIDs)
                                   throws java.io.IOException,
                                          AutomationException

Sets the flow direction of all reachable edge elements based on the placement of sources and sinks.

Specified by:

partialEstablishFlowDirection in interface IUtilityNetworkGEN

Parameters:

sourceEIDs - The sourceEIDs (in)

sinkEIDs - The sinkEIDs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStatus

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

Status of the network.

Specified by:

getStatus in interface INetwork

Returns:

A com.esri.arcgis.geodatabase.esriNetworkStatus constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getJunctionCount

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

Number of junctions in the network.

Specified by:

getJunctionCount in interface INetwork

Returns:

The junctionCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEdgeCount

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

Number of edges in the network.

Specified by:

getEdgeCount in interface INetwork

Returns:

The edgeCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTurnCount

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

Number of turns in the network.

Specified by:

getTurnCount in interface INetwork

Returns:

The turnCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxDegree

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

Maximum degree of a junction.

Specified by:

getMaxDegree in interface INetwork

Returns:

The maxDegree

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxTurn

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

Maximum number of turns associated with a junction.

Specified by:

getMaxTurn in interface INetwork

Returns:

The maxTurn

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createForwardStar

public IForwardStar createForwardStar(boolean honorState,
                                      INetWeight junctionWeight,
                                      INetWeight fromToEdgeWeight,
                                      INetWeight toFromEdgeWeight,
                                      INetWeight turnWeight)
                               throws java.io.IOException,
                                      AutomationException

Creates a forward star cursor on the network index.

Specified by:

createForwardStar in interface INetwork

Parameters:

honorState - The honorState (in)

junctionWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

fromToEdgeWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

toFromEdgeWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

turnWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createNetBrowser

public IEnumNetEID createNetBrowser(int elementType)
                             throws java.io.IOException,
                                    AutomationException

Creates a network index element browser.

Specified by:

createNetBrowser in interface INetwork

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startSchemaUpdating

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

Starts a session for updating the schema of the network.

Specified by:

startSchemaUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopSchemaUpdating

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

Ends the session for updating the schema for the network.

Specified by:

stopSchemaUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSchemaBeingUpdated

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

Indicates if the schema of the network is currently being updated.

Specified by:

isSchemaBeingUpdated in interface INetworkUpdate

Returns:

The bIsSchemaBeingUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startTopologyUpdating

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

Starts a session for updating the topology of the network.

Specified by:

startTopologyUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopTopologyUpdating

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

Ends the session for updating the topology of the network.

Specified by:

stopTopologyUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTopologyBeingUpdated

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

Indicates if the topology of the network is currently being updated.

Specified by:

isTopologyBeingUpdated in interface INetworkUpdate

Returns:

The bIsTopologyBeingUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startAttributesUpdating

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

Starts a session for updating the attributes of the network.

Specified by:

startAttributesUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopAttributesUpdating

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

Ends the session for updating the attributes of the network.

Specified by:

stopAttributesUpdating in interface INetworkUpdate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAttributesBeingUpdated

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

Indicates if the attributes of the network are currently being updated.

Specified by:

isAttributesBeingUpdated in interface INetworkUpdate

Returns:

The bIsAttributesBeingUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValidElement

public boolean isValidElement(int eID,
                              int elementType)
                       throws java.io.IOException,
                              AutomationException

Returns whether the specified element is part of the network.

Specified by:

isValidElement in interface INetElements

Parameters:

eID - The eID (in)

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

Returns:

The validState

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEID

public int getEID(int userClassID,
                  int userID,
                  int userSubID,
                  int elementType)
           throws java.io.IOException,
                  AutomationException

Returns the network element ID (EID).

Specified by:

getEID in interface INetElements

Parameters:

userClassID - The userClassID (in)

userID - The userID (in)

userSubID - The userSubID (in)

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

Returns:

The eID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEIDCount

public int getEIDCount(int userClassID,
                       int userID,
                       int elementType)
                throws java.io.IOException,
                       AutomationException

Returns the number of network element IDs (EIDs) corresponding to the specified user class ID and user ID.

Specified by:

getEIDCount in interface INetElements

Parameters:

userClassID - The userClassID (in)

userID - The userID (in)

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

Returns:

The eIDCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEIDs

public IEnumNetEID getEIDs(int userClassID,
                           int userID,
                           int elementType)
                    throws java.io.IOException,
                           AutomationException

Returns the network element IDs (EIDs) corresponding to the specified user classID and user ID.

Specified by:

getEIDs in interface INetElements

Parameters:

userClassID - The userClassID (in)

userID - The userID (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryIDs

public void queryIDs(int eID,
                     int elementType,
                     int[] userClassID,
                     int[] userID,
                     int[] userSubID)
              throws java.io.IOException,
                     AutomationException

Returns the user class ID, user ID, and user sub ID for the specified network element.

Specified by:

queryIDs in interface INetElements

Parameters:

eID - The eID (in)

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

userClassID - The userClassID (out: use single element array)

userID - The userID (out: use single element array)

userSubID - The userSubID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementClassCount

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

Number of element classes in the network.

Specified by:

getElementClassCount in interface INetSchema

Returns:

The elementClassCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementClass

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

Element class by index.

Specified by:

getElementClass in interface INetSchema

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementClassByUserID

public INetElementClass getElementClassByUserID(int elementclassUserID)
                                         throws java.io.IOException,
                                                AutomationException

Element class corresponding to the specified user class ID.

Specified by:

getElementClassByUserID in interface INetSchema

Parameters:

elementclassUserID - The elementclassUserID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeightCount

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

Number of weights in the network.

Specified by:

getWeightCount in interface INetSchema

Returns:

The weightCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeight

public INetWeight getWeight(int weightInternalID)
                     throws java.io.IOException,
                            AutomationException

Network weight corresponding to the specified weight internal ID.

Specified by:

getWeight in interface INetSchema

Parameters:

weightInternalID - The weightInternalID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeightByName

public INetWeight getWeightByName(java.lang.String weightName)
                           throws java.io.IOException,
                                  AutomationException

Network weight corresponding to the specified name.

Specified by:

getWeightByName in interface INetSchema

Parameters:

weightName - The weightName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeightAssociations

public IEnumNetWeightAssociation getWeightAssociations(int weightInternalID)
                                                throws java.io.IOException,
                                                       AutomationException

Network weight associations corresponding to the specified weight internal ID.

Specified by:

getWeightAssociations in interface INetSchema

Parameters:

weightInternalID - The weightInternalID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeightAssociationsByTableName

public IEnumNetWeightAssociation getWeightAssociationsByTableName(java.lang.String tableName)
                                                           throws java.io.IOException,
                                                                  AutomationException

Network weight associations corresponding to the specified table name.

Specified by:

getWeightAssociationsByTableName in interface INetSchema

Parameters:

tableName - The tableName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAncillaryRole

public void getAncillaryRole(int userClassID,
                             int[] ancillaryRole,
                             java.lang.String[] ancillaryRoleFieldName)
                      throws java.io.IOException,
                             AutomationException

Returns the ancillary role type and the name of the field containing the ancillary role information.

Specified by:

getAncillaryRole in interface INetSchema

Parameters:

userClassID - The userClassID (in)

ancillaryRole - A com.esri.arcgis.geodatabase.esriNetworkClassAncillaryRole constant (out: use single element array)

ancillaryRoleFieldName - The ancillaryRoleFieldName (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEnabledDisabledFieldName

public java.lang.String getEnabledDisabledFieldName(int userClassID)
                                             throws java.io.IOException,
                                                    AutomationException

Returns the name of the filed containing the enabled/disabled information for the specified user class.

Specified by:

getEnabledDisabledFieldName in interface INetSchema

Parameters:

userClassID - The userClassID (in)

Returns:

The enabledDisabledFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addElementClass

public INetElementClass addElementClass(int userClassID)
                                 throws java.io.IOException,
                                        AutomationException

Adds a new element class to the network.

Specified by:

addElementClass in interface INetSchemaEdit

Parameters:

userClassID - The userClassID (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeight

public void addWeight(INetWeight networkWeight)
               throws java.io.IOException,
                      AutomationException

Adds a new weight to the network.

Specified by:

addWeight in interface INetSchemaEdit

Parameters:

networkWeight - A reference to a com.esri.arcgis.geodatabase.INetWeight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeightAssociation

public void addWeightAssociation(INetWeightAssociation weightSource)
                          throws java.io.IOException,
                                 AutomationException

Adds a new weight association to the network.

Specified by:

addWeightAssociation in interface INetSchemaEdit

Parameters:

weightSource - A reference to a com.esri.arcgis.geodatabase.INetWeightAssociation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putAncillaryRole

public void putAncillaryRole(int userClassID,
                             int ancillaryRole,
                             java.lang.String ancillaryRoleFieldName)
                      throws java.io.IOException,
                             AutomationException

Sets the ancillary role type and the name of the field containing the ancillary role information for the specified user class.

Specified by:

putAncillaryRole in interface INetSchemaEdit

Parameters:

userClassID - The userClassID (in)

ancillaryRole - A com.esri.arcgis.geodatabase.esriNetworkClassAncillaryRole constant (in)

ancillaryRoleFieldName - The ancillaryRoleFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putEnabledDisabledFieldName

public void putEnabledDisabledFieldName(int userClassID,
                                        java.lang.String enabledDisabledRoleFieldName)
                                 throws java.io.IOException,
                                        AutomationException

Sets the name of the field containing the enabled/disabled information for the specified user class.

Specified by:

putEnabledDisabledFieldName in interface INetSchemaEdit

Parameters:

userClassID - The userClassID (in)

enabledDisabledRoleFieldName - The enabledDisabledRoleFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFromToJunctionEIDs

public void getFromToJunctionEIDs(int edgeEID,
                                  int[] fromJunctionEID,
                                  int[] toJunctionEID)
                           throws java.io.IOException,
                                  AutomationException

Returns the network element IDs of the junctions adjacent to the specified edge.

Specified by:

getFromToJunctionEIDs in interface INetTopology

Parameters:

edgeEID - The edgeEID (in)

fromJunctionEID - The fromJunctionEID (out: use single element array)

toJunctionEID - The toJunctionEID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdjacentEdgeCount

public int getAdjacentEdgeCount(int atJunctionEID)
                         throws java.io.IOException,
                                AutomationException

Returns the number of edges adjacent to the specified junction.

Specified by:

getAdjacentEdgeCount in interface INetTopology

Parameters:

atJunctionEID - The atJunctionEID (in)

Returns:

The adjacentEdgesCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdjacentEdge

public void getAdjacentEdge(int atJunctionEID,
                            int index,
                            int[] adjacentEdge,
                            boolean[] reverseOrientation)
                     throws java.io.IOException,
                            AutomationException

Returns the network element ID of the index'th adjacent edge to the specified junction.

Specified by:

getAdjacentEdge in interface INetTopology

Parameters:

atJunctionEID - The atJunctionEID (in)

index - The index (in)

adjacentEdge - The adjacentEdge (out: use single element array)

reverseOrientation - The reverseOrientation (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAdjacentEdges

public void getAdjacentEdges(int atJunctionEID,
                             int adjacentEdgesCount,
                             int[] adjacentEdges,
                             boolean[] reverseOrientation)
                      throws java.io.IOException,
                             AutomationException

Returns the network element IDs of all the edges adjacent to the specified junction.

Specified by:

getAdjacentEdges in interface INetTopology

Parameters:

atJunctionEID - The atJunctionEID (in)

adjacentEdgesCount - The adjacentEdgesCount (in)

adjacentEdges - The adjacentEdges (out: use single element array)

reverseOrientation - The reverseOrientation (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addJunction

public int addJunction(INetElementDescription junctionDescription)
                throws java.io.IOException,
                       AutomationException

Adds a junction element to the logical network.

Specified by:

addJunction in interface INetTopologyEdit

Parameters:

junctionDescription - A reference to a com.esri.arcgis.geodatabase.INetElementDescription (in)

Returns:

The junctionEID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addEdgeByEndEIDs

public int addEdgeByEndEIDs(INetElementDescription edgeDescription,
                            int fromJunctionEID,
                            int toJunctionEID)
                     throws java.io.IOException,
                            AutomationException

Adds an edge element to the logical network between the specified junction elements.

Specified by:

addEdgeByEndEIDs in interface INetTopologyEdit

Parameters:

edgeDescription - A reference to a com.esri.arcgis.geodatabase.INetElementDescription (in)

fromJunctionEID - The fromJunctionEID (in)

toJunctionEID - The toJunctionEID (in)

Returns:

The edgeEID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteByID

public void deleteByID(int userClassID,
                       int userID,
                       int userSubID,
                       int elementType)
                throws java.io.IOException,
                       AutomationException

Deletes the specified network element from the logical network.

Specified by:

deleteByID in interface INetTopologyEdit

Parameters:

userClassID - The userClassID (in)

userID - The userID (in)

userSubID - The userSubID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteByEID

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

Deletes the specified network element from the logical network.

Specified by:

deleteByEID in interface INetTopologyEdit

Parameters:

eID - The eID (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteByEIDs

public void deleteByEIDs(int elementType,
                         int elementCount,
                         int[] elementEIDs)
                  throws java.io.IOException,
                         AutomationException

Deletes the specified network elements from the logical network.

Specified by:

deleteByEIDs in interface INetTopologyEdit

Parameters:

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

elementCount - The elementCount (in)

elementEIDs - The elementEIDs (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisabledState

public boolean getDisabledState(int eID,
                                int elementType)
                         throws java.io.IOException,
                                AutomationException

Returns the disabled state of the specified network element.

Specified by:

getDisabledState in interface INetAttributes

Parameters:

eID - The eID (in)

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

Returns:

The disabledState

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeightValue

public java.lang.Object getWeightValue(int eID,
                                       int elementType,
                                       int weightInternalID)
                                throws java.io.IOException,
                                       AutomationException

Returns the weight value of the specified network element for the specified weight.

Specified by:

getWeightValue in interface INetAttributes

Parameters:

eID - The eID (in)

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

weightInternalID - The weightInternalID (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisabledState

public void setDisabledState(int eID,
                             int elementType,
                             boolean disableState)
                      throws java.io.IOException,
                             AutomationException

Sets the disabled state of the specified network element.

Specified by:

setDisabledState in interface INetAttributesEdit

Parameters:

eID - The eID (in)

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

disableState - The disableState (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWeightValue

public void setWeightValue(int eID,
                           int elementType,
                           int weightInternalID,
                           java.lang.Object weightValue)
                    throws java.io.IOException,
                           AutomationException

Sets the weight value of the specified network element for the specified weight.

Specified by:

setWeightValue in interface INetAttributesEdit

Parameters:

eID - The eID (in)

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

weightInternalID - The weightInternalID (in)

weightValue - A Variant (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

The name of the Dataset.

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the dataset.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

The browse name of the dataset.

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the Dataset.

Specified by:

getType in interface IDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

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.

getWorkspace

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

The workspace containing this dataset.

Specified by:

getWorkspace in interface IDataset

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.

getPropertySet

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

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

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.

canCopy

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

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Copies this dataset to a new dataset with the specified name.

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (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.

canDelete

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

True if this dataset can be deleted.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

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

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Renames this Dataset.

Specified by:

rename in interface IDataset

Parameters:

name - The name (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.

isCanEdit

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

True if the dataset supports edit sessions with the ability to discard edits on save.

Specified by:

isCanEdit in interface IDatasetEditInfo

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUndo

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

True if the dataset supports edit sessions with the ability to undo individual edit operations.

Specified by:

isCanUndo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanRedo

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

True if the dataset supports edit sessions with the ability to redo undone operations.

Specified by:

isCanRedo in interface IDatasetEditInfo

Returns:

The canUndo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException

Changes a schema lock.

Specified by:

changeSchemaLock in interface ISchemaLock

Parameters:

schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException

The list of current locks.

Specified by:

getCurrentSchemaLocks in interface ISchemaLock

Parameters:

schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasUncompressedEdits

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

Indicates if the object has edits that haven't been compressed yet.

Specified by:

isHasUncompressedEdits in interface IVersionedObject2

Returns:

The hasUncompressedEdits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

public IVersion getVersion()
                    throws java.io.IOException,
                           AutomationException

The object's current version.

Specified by:

getVersion in interface IVersionedObject

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRegisteredAsVersioned

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

Indicates if the object is registered as versioned.

Specified by:

isRegisteredAsVersioned in interface IVersionedObject

Returns:

The isRegistered

Throws:

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

AutomationException - If the ArcObject component throws an exception.

registerAsVersioned

public void registerAsVersioned(boolean isVersioned)
                         throws java.io.IOException,
                                AutomationException

Register/UnRegister the object as being versioned.

Specified by:

registerAsVersioned in interface IVersionedObject

Parameters:

isVersioned - The isVersioned (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

analyze

public void analyze(int tableComponents)
             throws java.io.IOException,
                    AutomationException

Analyze the data to update/generate DBMS statistics.

Specified by:

analyze in interface IDatasetAnalyze

Parameters:

tableComponents - The tableComponents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllowableComponents

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

The allowable components to be analyzed.

Specified by:

getAllowableComponents in interface IDatasetAnalyze

Returns:

The allowableComponents

Throws:

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

AutomationException - If the ArcObject component throws an exception.