com.esri.arcgis.schematic
Class SchematicNodeOnLink

java.lang.Object
  com.esri.arcgis.schematic.SchematicNodeOnLink

All Implemented Interfaces:

IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowChanges, IRowCompare, IRowEdit, IRowEvents, IValidate, com.esri.arcgis.interop.RemoteObjRef, ISchematicElement, ISchematicElementAssociatedObject, ISchematicElementAssociation, ISchematicElementAssociationContainer, ISchematicElementRelation, ISchematicNode, ISchematicNodeOnLink, Serializable, EventListener

public class SchematicNodeOnLink
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowCompare, IRowChanges, IRowEdit, IRowEvents, ISchematicElement, ISchematicNode, ISchematicNodeOnLink, ISchematicElementRelation, IValidate, ISchematicElementAssociation, ISchematicElementAssociationContainer, ISchematicElementAssociatedObject

Schematic Node-on-link Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

void	alterAssociation(int dataSourceID, int uCID, int uOID, int uSUBID, int uEID) Changes the schematic element association.
void	alterPropertySet(IPropertySet propertySet) Changes the schematic element PropertySet with the specified PropertySet.
ISchematicElementAssociation	createAssociation(int dataSourceID, int cLSID, int oID, int sUBID, int eID) Create a schematic association.
void	delete() Deletes the row.
void	deleteAssociation() Deletes the schematic element association.
void	deleteSet(ISet rows) Deletes the set of rows.
boolean	equals(Object o) Compare this object with another
IObjectClass	esri_getClass() The Object Class for the row.
IObject	getAssociatedObject() Associated object if exist.
IObjectClass	getAssociatedObjectClass() Associated object class if exist.
IEnumSchematicElement	getChildren(ISchematicDiagram diagram) Children of the schematic element within a diagram.
int	getDataSourceID() Data source ID related to the schematic element assocation.
IEnumSchematicElement	getDisplayedIncidentLinks(int endPointType) List of the schematic incident links for the schematic node that are displayed.
IFields	getFields() The fields Collection for this row buffer.
int	getID() ID of the schematic association.
IEnumSchematicElement	getIncidentLinks(int endPointType) List of the schematic incident links for the schematic node element.
double	getInitialPosition() Initial position of the schematic node-on-link on its reference link.
IFields	getInvalidFields() Returns all invalid fields.
IEnumRule	getInvalidRules() The set of all invalid rules.
IEnumRule	getInvalidRulesByField(String fieldName) The set of all invalid rules for the specified field.
String	getName() Name of the schematic element.
int	getOID() The OID for the row.
Object	getOriginalValue(int index) The value of the field at the specified index immediately after the last call to Store on the Row object.
ISchematicElement	getParent() Parent of the schematic element within the container.
IPropertySet	getPropertySet() PropertySet related to the schematic element.
ISchematicLink	getReferenceLink() Reference link of the schematic node-on-link.
ISchematicDiagram	getSchematicDiagram() Schematic diagram related to the schematic element.
ISchematicElement	getSchematicElement() Schematic element related to the association.
ISchematicElementAssociation	getSchematicElementAssociationByID(int iD) Schematic element association referenced by the specified ID.
IEnumSchematicElementAssociation	getSchematicElementAssociations() Schematic element associations enumeration within the container.
ISchematicElementClass	getSchematicElementClass() Schematic element class related to the schematic element.
ISchematicElement	getSchematicRelation() Schematic element relation ship.
ITable	getTable() The Table for the row.
int	getUCID() Class ID related to the schematic element assocation.
int	getUEID() EID related to the schematic element assocation.
int	getUOID() Object ID related to the schematic element assocation.
int	getUSUBID() SUBID related to the schematic element assocation.
Object	getValue(int index) The value of the field with the specified index.
int	hashCode() the hashcode for this object
boolean	isDisplayed() Indicates if the element is displayed.
boolean	isEqual(IRow otherRow) Indicates if the rows (which may be from two different versions) are the same (oid + values).
boolean	isHasOID() Indicates if the row has an OID.
boolean	isInitial() Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
boolean	isValueChanged(int index) Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.
void	onChanged(IRowEventsOnChangedEvent theEvent) An after event that is fired when a custom object is changed.
void	onDelete(IRowEventsOnDeleteEvent theEvent) An after event that is fired when a custom object is deleted.
void	onInitialize(IRowEventsOnInitializeEvent theEvent) An after event that is fired when a custom object is initialized.
void	onNew(IRowEventsOnNewEvent theEvent) An after event that is fired when a custom object is Stored for the first time.
void	onValidate(IRowEventsOnValidateEvent theEvent) An after event that is fired when a custom object is validated.
void	relatedObjectChanged(IRelationshipClass relationshipClass, IObject objectThatChanged) Notifies this object that a related object changed.
void	relatedObjectMoved(IRelationshipClass relationshipClass, IObject objectThatChanged, ILine moveVector) Notifies this object that a related object moved.
void	relatedObjectRotated(IRelationshipClass relationshipClass, IObject objectThatChanged, IPoint origin, double angle) Notifies this object that a related object rotated.
void	relatedObjectSetMoved(IRelationshipClass relationshipClass, ISet objectsThatNeedToChange, ISet objectsThatChanged, ILine moveVector) Notifies this object that a set of objects with relationships to the input set of objects moved.
void	relatedObjectSetRotated(IRelationshipClass relationshipClass, ISet objectsThatNeedToChange, ISet objectsThatChanged, IPoint origin, double angle) Notifies this object that a set of objects with relationships to the input set of objects rotated.
void	setDisplayed(boolean displayed) Indicates if the element is displayed.
void	setInitial(boolean initial) Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.
void	setInitialPosition(double lambda) Initial position of the schematic node-on-link on its reference link.
void	setParentByRef(ISchematicElement ppParent) Parent of the schematic element within the container.
void	setReferenceLinkByRef(ISchematicLink schematicLink) Reference link of the schematic node-on-link.
void	setSchematicRelationByRef(ISchematicElement schematicElement) Schematic element relation ship.
void	setValue(int index, Object value) The value of the field with the specified index.
void	store() Stores the row.
boolean	validate(String[] errorMessage) Validates the row.

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

SchematicNodeOnLink

public SchematicNodeOnLink(Object obj)
                    throws IOException

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

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

Throws:

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

esri_getClass

public IObjectClass esri_getClass()
                           throws IOException,
                                  AutomationException

The Object Class for the row.

Product Availability

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

Specified by:

esri_getClass in interface IObject

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

Indicates if the row has an OID.

Remarks

If the table has been registered with the geodatabase it will have unique Object ID, automatically created by the register tool, and the HasOID property will be set to True. Tables not registered with the geodatabase will not have an OID column and the HasOID property will be set to False. See the IClassSchemaEdit::RegisterAsObjectClass method for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IRow

Returns:

The hasOID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOID

public int getOID()
           throws IOException,
                  AutomationException

The OID for the row.

Description

Gets the OID for a row in a table that has a unique Object ID, such as tables registered with the geodatabase.

Example:

if (pRow.isHasOID()) {

        System.out.print(pRow.getOID());

      }

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOID in interface IRow

Returns:

The oID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException

The Table for the row.

Description

Returns a pointer to the table the row belongs to.

Example:

ITable pTable;

pTable = pRow.getTable();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTable in interface IRow

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

store

public void store()
           throws IOException,
                  AutomationException

Stores the row.

Remarks

The Store method is called by an application once it has modified the values of a Row. Once Store is called on a Row object, all subsequent queries within the same edit session, using the Geodatabase API, will reflect the modified state of the Row object.

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Calling the Store method triggers the following actions:

- The IRowEvents::OnChanged is called for the row being stored. The OnNew is called if this is a newly created row being stored for the first time. A custom row object can implement the OnChanged method and take some special action when it is called - for example; update a special column in the row

- The IRelatedObjectEvents::RelatedObjectChanged method is called for related objects in a related object class if the table for this row is an object class that participates in relationship classes with notification

Store should not be used for batch operations, such as updates or inserts. For performing a number of inserts or updates using cursors, refer to the ITable::Insert, ITable::Update, ITable::UpdateSearchedRows , IFeatureClass::Update andIFeatureClass::Insert. If an insert or update cursor is used on non-simple features (such as network features), the cursor will revert to using Store.

It is not necessary to explicitly call Connect on network features, this is handled polymorphically when Store is called on the feature. This is also the case with features in a Topology, Dirty Area creation is handled internally when Store is called.

Store should not be called inside of edit events, such as OnCreateFeature, OnChangeFeature or OnDeleteFeature. Even if you are modifying the geometry or other field values, Store will be called once the event is complete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

store in interface IRow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws IOException,
                   AutomationException

Deletes the row.

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

delete in interface IRow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue(int index)
                throws IOException,
                       AutomationException

The value of the field with the specified index.

Product Availability

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

Specified by:

getValue in interface IRowBuffer

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     Object value)
              throws IOException,
                     AutomationException

The value of the field with the specified index.

Product Availability

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

Specified by:

setValue in interface IRowBuffer

Parameters:

index - The index (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields Collection for this row buffer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IRowBuffer

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectChanged

public void relatedObjectChanged(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged)
                          throws IOException,
                                 AutomationException

Notifies this object that a related object changed.

Remarks

The RelatedObjectChanged method is called when a related object has changed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectChanged in interface IRelatedObjectEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectMoved

public void relatedObjectMoved(IRelationshipClass relationshipClass,
                               IObject objectThatChanged,
                               ILine moveVector)
                        throws IOException,
                               AutomationException

Notifies this object that a related object moved.

Remarks

This method is currently reserved and implementations should not define any behavior.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectMoved in interface IRelatedObjectEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)

moveVector - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectSetMoved

public void relatedObjectSetMoved(IRelationshipClass relationshipClass,
                                  ISet objectsThatNeedToChange,
                                  ISet objectsThatChanged,
                                  ILine moveVector)
                           throws IOException,
                                  AutomationException

Notifies this object that a set of objects with relationships to the input set of objects moved.

Remarks

The RelatedObjectSetMoved method is called when a set of objects in the related object class has moved. The objectsThatChanged argument represents the set of objects in the related object classes that have moved.

The objectsThatNeedToChange argument is a set of objects in this object's class that are related to the objects that moved. The object executing this method will itself be a member of the objectsThatNeedToChange set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectSetMoved in interface IRelatedObjectEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectsThatNeedToChange - A reference to a com.esri.arcgis.system.ISet (in)

objectsThatChanged - A reference to a com.esri.arcgis.system.ISet (in)

moveVector - A reference to a com.esri.arcgis.geometry.ILine (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectRotated

public void relatedObjectRotated(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged,
                                 IPoint origin,
                                 double angle)
                          throws IOException,
                                 AutomationException

Notifies this object that a related object rotated.

Remarks

This method is currently reserved and implementations should not define any behavior.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectRotated in interface IRelatedObjectEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectThatChanged - A reference to a com.esri.arcgis.geodatabase.IObject (in)

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectSetRotated

public void relatedObjectSetRotated(IRelationshipClass relationshipClass,
                                    ISet objectsThatNeedToChange,
                                    ISet objectsThatChanged,
                                    IPoint origin,
                                    double angle)
                             throws IOException,
                                    AutomationException

Notifies this object that a set of objects with relationships to the input set of objects rotated.

Remarks

The RelatedObjectSetRotated method is called when a set of objects in the related object class has moved. Its arguments are similar to the arguments for RelatedObjectSetMoved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectSetRotated in interface IRelatedObjectEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectsThatNeedToChange - A reference to a com.esri.arcgis.system.ISet (in)

objectsThatChanged - A reference to a com.esri.arcgis.system.ISet (in)

origin - A reference to a com.esri.arcgis.geometry.IPoint (in)

angle - The angle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IRow otherRow)
                throws IOException,
                       AutomationException

Indicates if the rows (which may be from two different versions) are the same (oid + values).

Product Availability

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

Specified by:

isEqual in interface IRowCompare

Parameters:

otherRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Returns:

The isEqual

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValueChanged

public boolean isValueChanged(int index)
                       throws IOException,
                              AutomationException

Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.

Product Availability

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

Specified by:

isValueChanged in interface IRowChanges

Parameters:

index - The index (in)

Returns:

The changed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOriginalValue

public Object getOriginalValue(int index)
                        throws IOException,
                               AutomationException

The value of the field at the specified index immediately after the last call to Store on the Row object.

Product Availability

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

Specified by:

getOriginalValue in interface IRowChanges

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSet

public void deleteSet(ISet rows)
               throws IOException,
                      AutomationException

Deletes the set of rows.

Remarks

All edits to features that participate in a Topology or Geometric Network must be performed within an edit session and bracketed within an edit operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteSet in interface IRowEdit

Parameters:

rows - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onChanged

public void onChanged(IRowEventsOnChangedEvent theEvent)
               throws IOException,
                      AutomationException

An after event that is fired when a custom object is changed.

Remarks

The OnChanged method is called by the geodatabase when an application program calls Store on an existing Row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onChanged in interface IRowEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onDelete

public void onDelete(IRowEventsOnDeleteEvent theEvent)
              throws IOException,
                     AutomationException

An after event that is fired when a custom object is deleted.

Remarks

The OnDelete method is called by the geodatabase when an application program calls Delete on a Row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onDelete in interface IRowEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onInitialize

public void onInitialize(IRowEventsOnInitializeEvent theEvent)
                  throws IOException,
                         AutomationException

An after event that is fired when a custom object is initialized.

Remarks

The OnInitialize method is called by the geodatabase after hydrating a cocreated Row object with its state (its set of field values) but before handing the Row to an application program. This is an opportunity for the Row object to initialize further state and derived member variables.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onInitialize in interface IRowEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onNew

public void onNew(IRowEventsOnNewEvent theEvent)
           throws IOException,
                  AutomationException

An after event that is fired when a custom object is Stored for the first time.

Remarks

The OnNew method is called by the geodatabase when an application program calls Store on a newly created Row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onNew in interface IRowEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onValidate

public void onValidate(IRowEventsOnValidateEvent theEvent)
                throws IOException,
                       AutomationException

An after event that is fired when a custom object is validated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

onValidate in interface IRowEvents

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic element.

Product Availability

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

Specified by:

getName in interface ISchematicElement

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementClass

public ISchematicElementClass getSchematicElementClass()
                                                throws IOException,
                                                       AutomationException

Schematic element class related to the schematic element.

Product Availability

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

Specified by:

getSchematicElementClass in interface ISchematicElement

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElementClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagram

public ISchematicDiagram getSchematicDiagram()
                                      throws IOException,
                                             AutomationException

Schematic diagram related to the schematic element.

Product Availability

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

Specified by:

getSchematicDiagram in interface ISchematicElement

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitial

public boolean isInitial()
                  throws IOException,
                         AutomationException

Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Specified by:

isInitial in interface ISchematicElement

Returns:

The initial

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitial

public void setInitial(boolean initial)
                throws IOException,
                       AutomationException

Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Product Availability

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

Specified by:

setInitial in interface ISchematicElement

Parameters:

initial - The initial (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayed

public boolean isDisplayed()
                    throws IOException,
                           AutomationException

Indicates if the element is displayed.

Product Availability

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

Specified by:

isDisplayed in interface ISchematicElement

Returns:

The displayed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayed

public void setDisplayed(boolean displayed)
                  throws IOException,
                         AutomationException

Indicates if the element is displayed.

Product Availability

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

Specified by:

setDisplayed in interface ISchematicElement

Parameters:

displayed - The displayed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicRelation

public ISchematicElement getSchematicRelation()
                                       throws IOException,
                                              AutomationException

Schematic element relation ship.

Product Availability

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

Specified by:

getSchematicRelation in interface ISchematicElement

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicRelationByRef

public void setSchematicRelationByRef(ISchematicElement schematicElement)
                               throws IOException,
                                      AutomationException

Schematic element relation ship.

Product Availability

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

Specified by:

setSchematicRelationByRef in interface ISchematicElement

Parameters:

schematicElement - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createAssociation

public ISchematicElementAssociation createAssociation(int dataSourceID,
                                                      int cLSID,
                                                      int oID,
                                                      int sUBID,
                                                      int eID)
                                               throws IOException,
                                                      AutomationException

Create a schematic association.

Product Availability

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

Specified by:

createAssociation in interface ISchematicElement

Parameters:

dataSourceID - The dataSourceID (in)

cLSID - The cLSID (in)

oID - The oID (in)

sUBID - The sUBID (in)

eID - The eID (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElementAssociation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicElementAssociation

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet related to the schematic element.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicElement

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicElement.alterPropertySet(com.esri.arcgis.system.IPropertySet)

alterPropertySet

public void alterPropertySet(IPropertySet propertySet)
                      throws IOException,
                             AutomationException

Changes the schematic element PropertySet with the specified PropertySet.

Product Availability

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

Specified by:

alterPropertySet in interface ISchematicElement

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicElement.getPropertySet()

getIncidentLinks

public IEnumSchematicElement getIncidentLinks(int endPointType)
                                       throws IOException,
                                              AutomationException

List of the schematic incident links for the schematic node element.

Product Availability

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

Specified by:

getIncidentLinks in interface ISchematicNode

Parameters:

endPointType - A com.esri.arcgis.schematic.esriSchematicEndPointType constant (in, optional, pass 3 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayedIncidentLinks

public IEnumSchematicElement getDisplayedIncidentLinks(int endPointType)
                                                throws IOException,
                                                       AutomationException

List of the schematic incident links for the schematic node that are displayed.

Product Availability

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

Specified by:

getDisplayedIncidentLinks in interface ISchematicNode

Parameters:

endPointType - A com.esri.arcgis.schematic.esriSchematicEndPointType constant (in, optional, pass 3 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceLink

public ISchematicLink getReferenceLink()
                                throws IOException,
                                       AutomationException

Reference link of the schematic node-on-link.

Product Availability

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

Specified by:

getReferenceLink in interface ISchematicNodeOnLink

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicLink

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceLinkByRef

public void setReferenceLinkByRef(ISchematicLink schematicLink)
                           throws IOException,
                                  AutomationException

Reference link of the schematic node-on-link.

Product Availability

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

Specified by:

setReferenceLinkByRef in interface ISchematicNodeOnLink

Parameters:

schematicLink - A reference to a com.esri.arcgis.schematic.ISchematicLink (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInitialPosition

public double getInitialPosition()
                          throws IOException,
                                 AutomationException

Initial position of the schematic node-on-link on its reference link.

Product Availability

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

Specified by:

getInitialPosition in interface ISchematicNodeOnLink

Returns:

The lambda

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialPosition

public void setInitialPosition(double lambda)
                        throws IOException,
                               AutomationException

Initial position of the schematic node-on-link on its reference link.

Product Availability

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

Specified by:

setInitialPosition in interface ISchematicNodeOnLink

Parameters:

lambda - The lambda (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public ISchematicElement getParent()
                            throws IOException,
                                   AutomationException

Parent of the schematic element within the container.

Product Availability

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

Specified by:

getParent in interface ISchematicElementRelation

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentByRef

public void setParentByRef(ISchematicElement ppParent)
                    throws IOException,
                           AutomationException

Parent of the schematic element within the container.

Product Availability

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

Specified by:

setParentByRef in interface ISchematicElementRelation

Parameters:

ppParent - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumSchematicElement getChildren(ISchematicDiagram diagram)
                                  throws IOException,
                                         AutomationException

Children of the schematic element within a diagram.

Product Availability

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

Specified by:

getChildren in interface ISchematicElementRelation

Parameters:

diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidFields

public IFields getInvalidFields()
                         throws IOException,
                                AutomationException

Returns all invalid fields.

Description

GetInvalidFields function returns a IFields object containing the invalid fields of the given Row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInvalidFields in interface IValidate

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidRules

public IEnumRule getInvalidRules()
                          throws IOException,
                                 AutomationException

The set of all invalid rules.

Description

GetInvalidRules function returns a IEnumRule object containing all of the invalid rules associated with the given row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInvalidRules in interface IValidate

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidRulesByField

public IEnumRule getInvalidRulesByField(String fieldName)
                                 throws IOException,
                                        AutomationException

The set of all invalid rules for the specified field.

Description

GetInvalidRulesByField function returns a IEnumRule object that contains all of the invalid rules associated with the FieldName parameter for the given row object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getInvalidRulesByField in interface IValidate

Parameters:

fieldName - The fieldName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public boolean validate(String[] errorMessage)
                 throws IOException,
                        AutomationException

Validates the row.

Description

Validate function validates the given row and returns a boolean value of TRUE if the row is valid and FALSE if its not.

Remarks

Validate on a row occurs in five steps:

1. Validate the subtype

2. Validate the attribute rules

3. Validate the network connectivity rules (if network feature)

4. Validate the relationship rules

5. Perform custom validation (using optional class extension)

The validate process stops once a row is found invalid. For example, if a network feature violates an attribute rule, the validation process stops and the feature's network connectivity rules are not evaluated until the attribute rule violation is corrected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

validate in interface IValidate

Parameters:

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

Returns:

The isValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElement

public ISchematicElement getSchematicElement()
                                      throws IOException,
                                             AutomationException

Schematic element related to the association.

Product Availability

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

Specified by:

getSchematicElement in interface ISchematicElementAssociation

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public int getID()
          throws IOException,
                 AutomationException

ID of the schematic association.

Product Availability

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

Specified by:

getID in interface ISchematicElementAssociation

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceID

public int getDataSourceID()
                    throws IOException,
                           AutomationException

Data source ID related to the schematic element assocation.

Product Availability

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

Specified by:

getDataSourceID in interface ISchematicElementAssociation

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUCID

public int getUCID()
            throws IOException,
                   AutomationException

Class ID related to the schematic element assocation.

Product Availability

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

Specified by:

getUCID in interface ISchematicElementAssociation

Returns:

The uCID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUOID

public int getUOID()
            throws IOException,
                   AutomationException

Object ID related to the schematic element assocation.

Product Availability

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

Specified by:

getUOID in interface ISchematicElementAssociation

Returns:

The uOID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUSUBID

public int getUSUBID()
              throws IOException,
                     AutomationException

SUBID related to the schematic element assocation.

Product Availability

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

Specified by:

getUSUBID in interface ISchematicElementAssociation

Returns:

The uSUBID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUEID

public int getUEID()
            throws IOException,
                   AutomationException

EID related to the schematic element assocation.

Product Availability

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

Specified by:

getUEID in interface ISchematicElementAssociation

Returns:

The uEID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterAssociation

public void alterAssociation(int dataSourceID,
                             int uCID,
                             int uOID,
                             int uSUBID,
                             int uEID)
                      throws IOException,
                             AutomationException

Changes the schematic element association.

Product Availability

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

Specified by:

alterAssociation in interface ISchematicElementAssociation

Parameters:

dataSourceID - The dataSourceID (in)

uCID - The uCID (in)

uOID - The uOID (in)

uSUBID - The uSUBID (in)

uEID - The uEID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAssociation

public void deleteAssociation()
                       throws IOException,
                              AutomationException

Deletes the schematic element association.

Product Availability

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

Specified by:

deleteAssociation in interface ISchematicElementAssociation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementAssociations

public IEnumSchematicElementAssociation getSchematicElementAssociations()
                                                                 throws IOException,
                                                                        AutomationException

Schematic element associations enumeration within the container.

Product Availability

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

Specified by:

getSchematicElementAssociations in interface ISchematicElementAssociationContainer

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicElementAssociation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementAssociationByID

public ISchematicElementAssociation getSchematicElementAssociationByID(int iD)
                                                                throws IOException,
                                                                       AutomationException

Schematic element association referenced by the specified ID.

Product Availability

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

Specified by:

getSchematicElementAssociationByID in interface ISchematicElementAssociationContainer

Parameters:

iD - The iD (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElementAssociation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObject

public IObject getAssociatedObject()
                            throws IOException,
                                   AutomationException

Associated object if exist.

Product Availability

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

Specified by:

getAssociatedObject in interface ISchematicElementAssociatedObject

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClass

public IObjectClass getAssociatedObjectClass()
                                      throws IOException,
                                             AutomationException

Associated object class if exist.

Product Availability

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

Specified by:

getAssociatedObjectClass in interface ISchematicElementAssociatedObject

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.