com.esri.arcgis.geodatabaseextensions
Class CadastralTableFieldEdits

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.CadastralTableFieldEdits

All Implemented Interfaces:

ICadastralTableFieldEdits, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class CadastralTableFieldEdits
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICadastralTableFieldEdits, IPersist, IPersistStream, IXMLSerialize, IDocumentVersionSupportGEN, Externalizable

ESRI Cadastral Table Field Edits Object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CadastralTableFieldEdits()
Constructs a CadastralTableFieldEdits using ArcGIS Engine.

CadastralTableFieldEdits(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CadastralTableFieldEdits theCadastralTableFieldEdits = (CadastralTableFieldEdits) obj;

Method Summary

Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
int	getCadastralTable() The enumeration for the table whose fields are being edited.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IFields	getExtendedAttributeFields() The extended attribute fields for the cadastral fabric table.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
String	getTableName() The name of the cadastral table.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCadastralTable(int table) The enumeration for the table whose fields are being edited.
void	setExtendedAttributeFields(IFields fields) The extended attribute fields for the cadastral fabric table.
void	writeExternal(ObjectOutput out)

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

CadastralTableFieldEdits

public CadastralTableFieldEdits()
                         throws IOException,
                                UnknownHostException

Constructs a CadastralTableFieldEdits using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CadastralTableFieldEdits

public CadastralTableFieldEdits(Object obj)
                         throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CadastralTableFieldEdits theCadastralTableFieldEdits = (CadastralTableFieldEdits) obj;

Construct a CadastralTableFieldEdits using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CadastralTableFieldEdits.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

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

getTableName

public String getTableName()
                    throws IOException,
                           AutomationException

The name of the cadastral table.

Remarks

The name of the cadastral table.

Use the TableName property to retrieve the name of the table that the field edits apply to.

Product Availability

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

Specified by:

getTableName in interface ICadastralTableFieldEdits

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCadastralTable

public void setCadastralTable(int table)
                       throws IOException,
                              AutomationException

The enumeration for the table whose fields are being edited.

Product Availability

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

Specified by:

setCadastralTable in interface ICadastralTableFieldEdits

Parameters:

table - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCadastralTable

public int getCadastralTable()
                      throws IOException,
                             AutomationException

The enumeration for the table whose fields are being edited.

Remarks

The enumeration that identifies the cadastral fabric table.

The enumTable value may be one of the following:

esriCFControl

esriCFPoints

esriCFLines

esriCFParcels

esriCFPlans

esriCFJobs

esriCFLinePoints

esriCFHistory

esriCFAdjustments

esriCFAccuracy

Use the DECadastralFabric object to create a new Cadastral Fabric. To update an existing fabric, pass the updated DECadastralFabric object to the method ICadastralFabricSchemaEdit::UpdateSchema().

Product Availability

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

Specified by:

getCadastralTable in interface ICadastralTableFieldEdits

Returns:

A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedAttributeFields

public IFields getExtendedAttributeFields()
                                   throws IOException,
                                          AutomationException

The extended attribute fields for the cadastral fabric table.

Remarks

Get or set the user-defined fields of the specified cadastral fabric table.

The ExtendedAttributeFields property is used to retrieve or set the collection of fields that make up the extended attributes of the cadastral fabric table. The table must be set via the ICadastralTableFieldEdits::CadastralTableID property.

These fields are user-defined fields in addition to the system fields of the cadastral fabric table. Use the Fields collection to add or delete fields. Note that when modifying existing fields, the restrictions that apply in ArcCatalog also apply in ArcObjects; for example, you cannot change the name or type of a field. If an existing field's name is changed in the Fields collection, the field will be considered a new field and the existing one will be deleted.

The names of the fields are unqualified. When assigning new fields, use unqualified names.

Use the DECadastralFabric object to create a new Cadastral Fabric. To update an existing fabric, pass the updated DECadastralFabric object to the method ICadastralFabricSchemaEdit::UpdateSchema().

Product Availability

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

Specified by:

getExtendedAttributeFields in interface ICadastralTableFieldEdits

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.

setExtendedAttributeFields

public void setExtendedAttributeFields(IFields fields)
                                throws IOException,
                                       AutomationException

The extended attribute fields for the cadastral fabric table.

Product Availability

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

Specified by:

setExtendedAttributeFields in interface ICadastralTableFieldEdits

Parameters:

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException