com.esri.arcgis.schematic
Class SchematicNode

java.lang.Object
  extended bycom.esri.arcgis.schematic.SchematicNode
All Implemented Interfaces:
java.util.EventListener, IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowChanges, IRowCompare, IRowEdit, IRowEvents, ISchematicDrawing, ISchematicElement, ISchematicElementAssociation, ISchematicElementAssociationContainer, ISchematicElementRelation, ISchematicNode, IValidate, java.io.Serializable

public class SchematicNode
extends java.lang.Object
implements IObject, IRelatedObjectEvents, IRow, IRowBuffer, IRowCompare, IRowChanges, IRowEdit, IRowEvents, ISchematicElement, ISchematicNode, ISchematicDrawing, ISchematicElementRelation, IValidate, ISchematicElementAssociation, ISchematicElementAssociationContainer

Schematic node object.

See Also:
Serialized Form

Constructor Summary
SchematicNode(java.lang.Object obj)
          Construct a SchematicNode 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(java.lang.Object o)
          Compare this object with another
 IObjectClass esri_getClass()
          The Object Class for the row.
 IObject getAsIObject()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRelatedObjectEvents getAsIRelatedObjectEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRow getAsIRow()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowBuffer getAsIRowBuffer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowChanges getAsIRowChanges()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowCompare getAsIRowCompare()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowEdit getAsIRowEdit()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IRowEvents getAsIRowEvents()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicDrawing getAsISchematicDrawing()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElement getAsISchematicElement()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElementAssociation getAsISchematicElementAssociation()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElementAssociationContainer getAsISchematicElementAssociationContainer()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicElementRelation getAsISchematicElementRelation()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 ISchematicNode getAsISchematicNode()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 IValidate getAsIValidate()
          Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
 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 getInitialXPosition()
          Initial X position of the schematic drawing.
 double getInitialYPosition()
          Initial Y position of the schematic drawing.
 IFields getInvalidFields()
          Returns all invalid fields.
 IEnumRule getInvalidRules()
          The set of all invalid rules.
 IEnumRule getInvalidRulesByField(java.lang.String fieldName)
          The set of all invalid rules for the specified field.
 java.lang.String getName()
          Name of the schematic element.
 int getOID()
          The OID for the row.
 java.lang.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.
 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.
 java.lang.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 pOtherRow)
          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 setInitialXPosition(double x)
          Initial X position of the schematic drawing.
 void setInitialYPosition(double y)
          Initial Y position of the schematic drawing.
 void setParentByRef(ISchematicElement ppParent)
          Parent of the schematic element within the container.
 void setSchematicRelationByRef(ISchematicElement schematicElement)
          Schematic element relation ship.
 void setValue(int index, java.lang.Object value)
          The value of the field with the specified index.
 void store()
          Stores the row.
 boolean validate(java.lang.String[] errorMessage)
          Validates the row.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SchematicNode

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

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

Throws:
java.io.IOException - if there are interop problems
Method Detail

getAsIObject

public IObject getAsIObject()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRelatedObjectEvents

public IRelatedObjectEvents getAsIRelatedObjectEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRow

public IRow getAsIRow()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowBuffer

public IRowBuffer getAsIRowBuffer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowCompare

public IRowCompare getAsIRowCompare()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowChanges

public IRowChanges getAsIRowChanges()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowEdit

public IRowEdit getAsIRowEdit()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIRowEvents

public IRowEvents getAsIRowEvents()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElement

public ISchematicElement getAsISchematicElement()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicNode

public ISchematicNode getAsISchematicNode()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicDrawing

public ISchematicDrawing getAsISchematicDrawing()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElementRelation

public ISchematicElementRelation getAsISchematicElementRelation()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsIValidate

public IValidate getAsIValidate()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElementAssociation

public ISchematicElementAssociation getAsISchematicElementAssociation()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


getAsISchematicElementAssociationContainer

public ISchematicElementAssociationContainer getAsISchematicElementAssociationContainer()
Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.


equals

public boolean equals(java.lang.Object o)
Compare this object with another


hashCode

public int hashCode()
the hashcode for this object


esri_getClass

public IObjectClass esri_getClass()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IObject
The Object Class for the row.

Specified by:
esri_getClass in interface IObject
Returns:
A reference to a com.esri.arcgis.geodatabase.IObjectClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isHasOID

public boolean isHasOID()
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IRow
Indicates if the row has an OID.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
isHasOID in interface IRow
Returns:
The hasOID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getOID

public int getOID()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRow
The OID for the row.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getOID in interface IRow
Returns:
The oID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRow
The Table for the row.

Supported Platforms

Windows, Solaris, Linux

Description

Returns a pointer to the table the row belongs to.

Specified by:
getTable in interface IRow
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

store

public void store()
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRow
Stores the row.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
store in interface IRow
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
Description copied from interface: IRow
Deletes the row.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
delete in interface IRow
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getValue

public java.lang.Object getValue(int index)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRowBuffer
The value of the field with the specified index.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Index parameter is a zero based index.

Specified by:
getValue in interface IRowBuffer
Parameters:
index - The index (in)
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setValue

public void setValue(int index,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IRowBuffer
The value of the field with the specified index.

Supported Platforms

Windows, Solaris, Linux

Specified by:
setValue in interface IRowBuffer
Parameters:
index - The index (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRowBuffer
The fields Collection for this row buffer.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFields in interface IRowBuffer
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

relatedObjectChanged

public void relatedObjectChanged(IRelationshipClass relationshipClass,
                                 IObject objectThatChanged)
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object changed.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectMoved

public void relatedObjectMoved(IRelationshipClass relationshipClass,
                               IObject objectThatChanged,
                               ILine moveVector)
                        throws java.io.IOException,
                               AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object moved.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectMoved method is called when a related object has moved.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectSetMoved

public void relatedObjectSetMoved(IRelationshipClass relationshipClass,
                                  ISet objectsThatNeedToChange,
                                  ISet objectsThatChanged,
                                  ILine moveVector)
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a set of objects with relationships to the input set of objects moved.

Supported Platforms

Windows, Solaris, Linux

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 represents the set of objects in the object class of this object that are related to the objects that moved. This object is itself a member of the objectsThatNeedToChange.

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:
java.io.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 java.io.IOException,
                                 AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a related object rotated.

Supported Platforms

Windows, Solaris, Linux

Remarks

The RelatedObjectRotated method is called when a related object has rotated.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

relatedObjectSetRotated

public void relatedObjectSetRotated(IRelationshipClass relationshipClass,
                                    ISet objectsThatNeedToChange,
                                    ISet objectsThatChanged,
                                    IPoint origin,
                                    double angle)
                             throws java.io.IOException,
                                    AutomationException
Description copied from interface: IRelatedObjectEvents
Notifies this object that a set of objects with relationships to the input set of objects rotated.

Supported Platforms

Windows, Solaris, Linux

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.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isEqual

public boolean isEqual(IRow pOtherRow)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRowCompare
Indicates if the rows (which may be from two different versions) are the same (oid + values).

Specified by:
isEqual in interface IRowCompare
Parameters:
pOtherRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
Returns:
The isEqual
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValueChanged

public boolean isValueChanged(int index)
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: IRowChanges
Indicates whether the value of the field at the specified index has changed since the last call to Store on the Row object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isValueChanged in interface IRowChanges
Parameters:
index - The index (in)
Returns:
The changed
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginalValue

public java.lang.Object getOriginalValue(int index)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: IRowChanges
The value of the field at the specified index immediately after the last call to Store on the Row object.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOriginalValue in interface IRowChanges
Parameters:
index - The index (in)
Returns:
A Variant
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteSet

public void deleteSet(ISet rows)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRowEdit
Deletes the set of rows.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
deleteSet in interface IRowEdit
Parameters:
rows - A reference to a com.esri.arcgis.system.ISet (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onChanged

public void onChanged(IRowEventsOnChangedEvent theEvent)
               throws java.io.IOException,
                      AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is changed.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
onChanged in interface IRowEvents
Parameters:
theEvent - The event
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onDelete

public void onDelete(IRowEventsOnDeleteEvent theEvent)
              throws java.io.IOException,
                     AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is deleted.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
onDelete in interface IRowEvents
Parameters:
theEvent - The event
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

onInitialize

public void onInitialize(IRowEventsOnInitializeEvent theEvent)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is initialized.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
onInitialize in interface IRowEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onNew

public void onNew(IRowEventsOnNewEvent theEvent)
           throws java.io.IOException,
                  AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is Stored for the first time.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:
onNew in interface IRowEvents
Parameters:
theEvent - The event
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onValidate

public void onValidate(IRowEventsOnValidateEvent theEvent)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IRowEvents
An after event that is fired when a custom object is validated.

Supported Platforms

Windows, Solaris, Linux

Description

OnValidate maintains information about particular functionality...

Specified by:
onValidate in interface IRowEvents
Parameters:
theEvent - The event
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
Description copied from interface: ISchematicElement
Name of the schematic element.

Specified by:
getName in interface ISchematicElement
Returns:
The name
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicElementClass

public ISchematicElementClass getSchematicElementClass()
                                                throws java.io.IOException,
                                                       AutomationException
Description copied from interface: ISchematicElement
Schematic element class related to the schematic element.

Specified by:
getSchematicElementClass in interface ISchematicElement
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementClass
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicDiagram

public ISchematicDiagram getSchematicDiagram()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: ISchematicElement
Schematic diagram related to the schematic element.

Specified by:
getSchematicDiagram in interface ISchematicElement
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInitial

public boolean isInitial()
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ISchematicElement
Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Specified by:
isInitial in interface ISchematicElement
Returns:
The initial
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setInitial

public void setInitial(boolean initial)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: ISchematicElement
Indicates if the schematic element belongs to the initial list of elements specified for the schematic diagram.

Specified by:
setInitial in interface ISchematicElement
Parameters:
initial - The initial (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

isDisplayed

public boolean isDisplayed()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ISchematicElement
Indicates if the element is displayed.

Specified by:
isDisplayed in interface ISchematicElement
Returns:
The displayed
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setDisplayed

public void setDisplayed(boolean displayed)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: ISchematicElement
Indicates if the element is displayed.

Specified by:
setDisplayed in interface ISchematicElement
Parameters:
displayed - The displayed (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicRelation

public ISchematicElement getSchematicRelation()
                                       throws java.io.IOException,
                                              AutomationException
Description copied from interface: ISchematicElement
Schematic element relation ship.

Specified by:
getSchematicRelation in interface ISchematicElement
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicRelationByRef

public void setSchematicRelationByRef(ISchematicElement schematicElement)
                               throws java.io.IOException,
                                      AutomationException
Description copied from interface: ISchematicElement
Schematic element relation ship.

Specified by:
setSchematicRelationByRef in interface ISchematicElement
Parameters:
schematicElement - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

createAssociation

public ISchematicElementAssociation createAssociation(int dataSourceID,
                                                      int cLSID,
                                                      int oID,
                                                      int sUBID,
                                                      int eID)
                                               throws java.io.IOException,
                                                      AutomationException
Description copied from interface: ISchematicElement
Create a schematic association.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISchematicElement
PropertySet related to the schematic element.

Specified by:
getPropertySet in interface ISchematicElement
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.

alterPropertySet

public void alterPropertySet(IPropertySet propertySet)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: ISchematicElement
Changes the schematic element PropertySet with the specified PropertySet.

Specified by:
alterPropertySet in interface ISchematicElement
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIncidentLinks

public IEnumSchematicElement getIncidentLinks(int endPointType)
                                       throws java.io.IOException,
                                              AutomationException
Description copied from interface: ISchematicNode
List of the schematic incident links for the schematic node element.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayedIncidentLinks

public IEnumSchematicElement getDisplayedIncidentLinks(int endPointType)
                                                throws java.io.IOException,
                                                       AutomationException
Description copied from interface: ISchematicNode
List of the schematic incident links for the schematic node that are displayed.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getInitialXPosition

public double getInitialXPosition()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ISchematicDrawing
Initial X position of the schematic drawing.

Specified by:
getInitialXPosition in interface ISchematicDrawing
Returns:
The x
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitialXPosition

public void setInitialXPosition(double x)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ISchematicDrawing
Initial X position of the schematic drawing.

Specified by:
setInitialXPosition in interface ISchematicDrawing
Parameters:
x - The x (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInitialYPosition

public double getInitialYPosition()
                           throws java.io.IOException,
                                  AutomationException
Description copied from interface: ISchematicDrawing
Initial Y position of the schematic drawing.

Specified by:
getInitialYPosition in interface ISchematicDrawing
Returns:
The y
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitialYPosition

public void setInitialYPosition(double y)
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: ISchematicDrawing
Initial Y position of the schematic drawing.

Specified by:
setInitialYPosition in interface ISchematicDrawing
Parameters:
y - The y (in)
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getParent

public ISchematicElement getParent()
                            throws java.io.IOException,
                                   AutomationException
Description copied from interface: ISchematicElementRelation
Parent of the schematic element within the container.

Specified by:
getParent in interface ISchematicElementRelation
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

setParentByRef

public void setParentByRef(ISchematicElement ppParent)
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ISchematicElementRelation
Parent of the schematic element within the container.

Specified by:
setParentByRef in interface ISchematicElementRelation
Parameters:
ppParent - A reference to a com.esri.arcgis.schematic.ISchematicElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumSchematicElement getChildren(ISchematicDiagram diagram)
                                  throws java.io.IOException,
                                         AutomationException
Description copied from interface: ISchematicElementRelation
Children of the schematic element within a diagram.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInvalidFields

public IFields getInvalidFields()
                         throws java.io.IOException,
                                AutomationException
Description copied from interface: IValidate
Returns all invalid fields.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getInvalidFields in interface IValidate
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getInvalidRules

public IEnumRule getInvalidRules()
                          throws java.io.IOException,
                                 AutomationException
Description copied from interface: IValidate
The set of all invalid rules.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getInvalidRules in interface IValidate
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getInvalidRulesByField

public IEnumRule getInvalidRulesByField(java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException
Description copied from interface: IValidate
The set of all invalid rules for the specified field.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:
getInvalidRulesByField in interface IValidate
Parameters:
fieldName - The fieldName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumRule
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

validate

public boolean validate(java.lang.String[] errorMessage)
                 throws java.io.IOException,
                        AutomationException
Description copied from interface: IValidate
Validates the row.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
validate in interface IValidate
Parameters:
errorMessage - The errorMessage (out: use single element array)
Returns:
The isValid
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicElement

public ISchematicElement getSchematicElement()
                                      throws java.io.IOException,
                                             AutomationException
Description copied from interface: ISchematicElementAssociation
Schematic element related to the association.

Specified by:
getSchematicElement in interface ISchematicElementAssociation
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElement
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getID

public int getID()
          throws java.io.IOException,
                 AutomationException
Description copied from interface: ISchematicElementAssociation
ID of the schematic association.

Specified by:
getID in interface ISchematicElementAssociation
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSourceID

public int getDataSourceID()
                    throws java.io.IOException,
                           AutomationException
Description copied from interface: ISchematicElementAssociation
Data source ID related to the schematic element assocation.

Specified by:
getDataSourceID in interface ISchematicElementAssociation
Returns:
The iD
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUCID

public int getUCID()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ISchematicElementAssociation
Class ID related to the schematic element assocation.

Specified by:
getUCID in interface ISchematicElementAssociation
Returns:
The uCID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getUOID

public int getUOID()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ISchematicElementAssociation
Object ID related to the schematic element assocation.

Specified by:
getUOID in interface ISchematicElementAssociation
Returns:
The uOID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUSUBID

public int getUSUBID()
              throws java.io.IOException,
                     AutomationException
Description copied from interface: ISchematicElementAssociation
SUBID related to the schematic element assocation.

Specified by:
getUSUBID in interface ISchematicElementAssociation
Returns:
The uSUBID
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getUEID

public int getUEID()
            throws java.io.IOException,
                   AutomationException
Description copied from interface: ISchematicElementAssociation
EID related to the schematic element assocation.

Specified by:
getUEID in interface ISchematicElementAssociation
Returns:
The uEID
Throws:
java.io.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 java.io.IOException,
                             AutomationException
Description copied from interface: ISchematicElementAssociation
Changes the schematic element association.

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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

deleteAssociation

public void deleteAssociation()
                       throws java.io.IOException,
                              AutomationException
Description copied from interface: ISchematicElementAssociation
Deletes the schematic element association.

Specified by:
deleteAssociation in interface ISchematicElementAssociation
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicElementAssociations

public IEnumSchematicElementAssociation getSchematicElementAssociations()
                                                                 throws java.io.IOException,
                                                                        AutomationException
Description copied from interface: ISchematicElementAssociationContainer
Schematic element associations enumeration within the container.

Specified by:
getSchematicElementAssociations in interface ISchematicElementAssociationContainer
Returns:
A reference to a com.esri.arcgis.schematic.IEnumSchematicElementAssociation
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

getSchematicElementAssociationByID

public ISchematicElementAssociation getSchematicElementAssociationByID(int iD)
                                                                throws java.io.IOException,
                                                                       AutomationException
Description copied from interface: ISchematicElementAssociationContainer
Schematic element association referenced by the specified ID.

Specified by:
getSchematicElementAssociationByID in interface ISchematicElementAssociationContainer
Parameters:
iD - The iD (in)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicElementAssociation
Throws:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.