UtilityNetwork (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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, java.io.Serializable

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

A container for describing a utility network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

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.
`IDataset`	`getAsIDataset()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetAnalyze`	`getAsIDatasetAnalyze()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEdit`	`getAsIDatasetEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IDatasetEditInfo`	`getAsIDatasetEditInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetAttributes`	`getAsINetAttributes()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetAttributesEdit`	`getAsINetAttributesEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetElements`	`getAsINetElements()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetSchema`	`getAsINetSchema()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetSchemaEdit`	`getAsINetSchemaEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetTopology`	`getAsINetTopology()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetTopologyEdit`	`getAsINetTopologyEdit()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetwork`	`getAsINetwork()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`INetworkUpdate`	`getAsINetworkUpdate()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISchemaLock`	`getAsISchemaLock()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IUtilityNetworkGEN`	`getAsIUtilityNetworkGEN()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IVersionedObject2`	`getAsIVersionedObject2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`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.
`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`	`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 UtilityNetwork theUtilityNetwork = (UtilityNetwork) obj;
Throws:: java.io.IOException - if there are interop problems

Method Detail