com.esri.arcgis.geodatabase
Class AttributedRelationship

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

All Implemented Interfaces:

java.util.EventListener, IRelationship, IRow, IRowBuffer, IRowChanges, IRowCompare, IRowEdit, IRowEvents, ISupportErrorInfo, IValidate, java.io.Serializable

public class AttributedRelationship

extends java.lang.Object

implements IRow, IRowBuffer, IRowEvents, IValidate, IRowChanges, IRowCompare, IRowEdit, IRelationship, ISupportErrorInfo

ESRI Attributed Relationship.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

AttributedRelationship()
Constructs a AttributedRelationship using ArcGIS Engine.

AttributedRelationship(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	delete() Deletes the row.
void	deleteSet(ISet rows) Deletes the set of rows.
boolean	equals(java.lang.Object o) Compare this object with another
IRelationship	getAsIRelationship() 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.
ISupportErrorInfo	getAsISupportErrorInfo() 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.
static java.lang.String	getClsid()
IObject	getDestinationObject() The destination object.
IFields	getFields() The fields Collection for this row buffer.
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.
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.
IObject	getOriginObject() The origin object.
IRelationshipClass	getRelationshipClass() The relationship class to which this relationship belongs.
ITable	getTable() The Table for the row.
java.lang.Object	getValue(int index) The value of the field with the specified index.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
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	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	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

AttributedRelationship

public AttributedRelationship()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a AttributedRelationship using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

AttributedRelationship

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a AttributedRelationship using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AttributedRelationship.
AttributedRelationship theAttributedRelationship = (AttributedRelationship) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

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.

getAsIRowEvents

public IRowEvents getAsIRowEvents()

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.

getAsIRowChanges

public IRowChanges getAsIRowChanges()

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.

getAsIRowEdit

public IRowEdit getAsIRowEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelationship

public IRelationship getAsIRelationship()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

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

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.

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.

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.

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.

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.

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.

getRelationshipClass

public IRelationshipClass getRelationshipClass()
                                        throws java.io.IOException,
                                               AutomationException

Description copied from interface: IRelationship

The relationship class to which this relationship belongs.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRelationshipClass in interface IRelationship

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOriginObject

public IObject getOriginObject()
                        throws java.io.IOException,
                               AutomationException

Description copied from interface: IRelationship

The origin object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOriginObject in interface IRelationship

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationObject

public IObject getDestinationObject()
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IRelationship

The destination object.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDestinationObject in interface IRelationship

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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