com.esri.arcgis.geodatabaseextensions
Class CadastralFabric

java.lang.Object
  extended by com.esri.arcgis.geodatabaseextensions.CadastralFabric
All Implemented Interfaces:
IConnectionPointContainer, IDataset, IDatasetComponent, IDatasetEdit, IGeoDataset, IMetadata, IMetadataEdit, ISchemaLock, IVersionedObject, IVersionedObject2, ICadastralFabric, ICadastralFabric2, ICadastralFabric3, ICadastralFabricLocks, ICadastralFabricLocks2, ICadastralFabricSchemaEdit, ICadastralFabricSchemaEdit2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class CadastralFabric
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IConnectionPointContainer, IDataset, IGeoDataset, ICadastralFabric, ICadastralFabric2, ICadastralFabric3, ICadastralFabricLocks, ICadastralFabricLocks2, IDatasetComponent, IDatasetEdit, ISchemaLock, IVersionedObject2, IMetadata, IMetadataEdit, ICadastralFabricSchemaEdit, ICadastralFabricSchemaEdit2

COM Class 'CadastralFabric'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriGeoDatabaseExtensions.olb'

Description 'A container for querying information about a cadastral fabric.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabric
IID, IIDf9e240b1_d806_4388_afde_b1a5d354171f, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabric2
IID, IIDb6379408_3f07_4836_89f9_67610d2f74ce, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabric3
IID, IID5afce645_3c35_4a29_97d6_36c7524ee750, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabricLocks
IID, IIDc8be9a26_2fd5_4d41_a70b_7e000b644c41, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabricLocks2
IID, IID882005e1_945f_46eb_80c8_2b7a3b0afd4a, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetComponent
IID, IID5f636f00_4b3c_46eb_a684_c2d746357061, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetEdit
IID, IID448c5d21_9746_11d1_89e2_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISchemaLock
IID, IIDdca648e5_0fbb_11d3_80a5_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IVersionedObject2
IID, IID884d388e_8918_443a_8f4a_db5aac5b9d5e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IVersionedObject
IID4a1fb361_b863_11d1_9ce7_0000f8780619
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit
IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabricSchemaEdit
IID, IID8a932661_07b3_4d2e_b02c_ce6092a1b4af, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ICadastralFabricSchemaEdit2
IID, IIDe2930c0e_dd54_4f12_8960_c44e6c08c395, xxDummy
 
Constructor Summary
CadastralFabric(java.lang.Object obj)
          Construct a CadastralFabric using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void acquireLocks(ILongArray pLocks, boolean takeSoftLocks, ILongArray[] ppLocksInConflict, ILongArray[] ppSoftLocksInConflict)
          Acquire locks on the LockingJob.
 void acquireLocks(ILongArray pLocks, boolean takeSoftLocks, ILongArray pLocksInConflict, ILongArray pSoftLocksInConflict)
          Acquire locks on the LockingJob.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canRename()
          True if this dataset can be renamed.
 void changeSchemaLock(int schemaLock)
          Changes a schema lock.
 void commitJob(java.lang.String jobName)
          Commits the specified job to the cadastral fabric.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 IXMLStream createCadastralPacket(IProjectedCoordinateSystem outputProjectedCoordSys, IFIDSet planIDs, ITrackCancel trackCancel)
          Creates a cadastral packet without a linked job.
 int createJob(ICadastralJob job)
          Creates a new cadastral job with the properties of the given CadastralJob object.
 void delete()
          Deletes this dataset.
 void deleteJob(java.lang.String name)
          Deletes the existing job.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 IXMLStream extractCadastralPacket(java.lang.String jobName, IProjectedCoordinateSystem outputProjectedCoordSys, ITrackCancel trackCancel)
          Creates/Extracts a cadastral packet for the specified job.
 IXMLStream extractCadastralPacket(java.lang.String jobName, IProjectedCoordinateSystem outputProjectedCoordSys, ITrackCancel trackCancel, boolean includeWhiteSpace)
          Creates/Extracts a cadastral packet for the specified job.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 java.lang.String getBrowseName()
          The browse name of the dataset.
 IEnumBSTR getCadastralJobs(int cadastralJobType)
          The cadastral jobs that have not been committed.
 ITable getCadastralTable(int tableID)
          The cadastral fabric class at the specified enumeration.
 java.lang.String getCategory()
          The category of the dataset.
 void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
          The list of current locks.
 IDEDataset getDataElement()
          The data element corresponding to the dataset component.
 IEnvelope getExtent()
          The extent of the GeoDataset.
 IName getFullName()
          The associated name object.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 ICadastralJob getJob(java.lang.String name)
          Retrieves a cadastral job given its name.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The name of the Dataset.
 IDataset getParent()
          The containing parent dataset.
 IPropertySet getPropertySet()
          The set of properties for the dataset.
 ISpatialReference getSpatialReference()
          The spatial reference of the GeoDataset.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getType()
          The type of the Dataset.
 IVersion getVersion()
          The object's current version.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 int hashCode()
          the hashcode for this object
 void insertCadastralPacket(ICadastralJob newCadastralJobDefinition, IXMLStream xMLStream, ITrackCancel cancelTracker, IFIDSet[] insertedParcelOIDs)
          Saves the cadastral packet and creates a new job if there are new parcels..
 void insertCadastralPacket(ICadastralJob newCadastralJobDefinition, IXMLStream xMLStream, ITrackCancel cancelTracker, int ePacketSetting, IFIDSet[] insertedParcelOIDs)
          Saves the cadastral packet and creates a new job if there are new parcels..
 boolean isBeingEdited()
          True if the dataset is being edited.
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 boolean isHasUncompressedEdits()
          Indicates if the object has edits that haven't been compressed yet.
 boolean isRegisteredAsVersioned()
          Indicates if the object is registered as versioned.
 boolean lockJob()
          Lock current job.
 void postCadastralPacket(IXMLStream xMLStream, ITrackCancel cancelTracker)
          Saves the cadastral packet for the job.
 void postCadastralPacket(IXMLStream xMLStream, ITrackCancel cancelTracker, IFIDSet[] insertedParcelOIDs)
          Saves the cadastral packet for the job.
 void postCadastralPacket(IXMLStream xMLStream, ITrackCancel cancelTracker, int ePacketSetting, IFIDSet[] insertedParcelOIDs)
          Saves the cadastral packet for the job.
 void registerAsVersioned(boolean isVersioned)
          Register/UnRegister the object as being versioned.
 void release()
          Release a CadastralFabric.
 void releaseJobLock(boolean forceRelease)
          Release current job's lock.
 void releaseReadOnlyFields(ITable pTable, int table)
          Temporarily release the read-only property on system the fields of the given cadastral fabric table.
 void rename(java.lang.String name)
          Renames this Dataset.
 void resetReadOnlyFields(int table)
          Reset the read-only property on system the fields of the cadastral fabric tables.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setLockingJob(java.lang.String rhs1)
          The name of the Job to apply locks on.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 void undoLastAcquiredLocks()
          Rolls back most recent set of acquired locks, until last edit operation.
 void updateJob(ICadastralJob job)
          Updates the existing job.
 void updateSchema(IDECadastralFabric dataElement)
          Updates the schema for the cadastral fabric based upon the given data element.
 void validateJobLock(boolean[] locked, java.lang.String[] lockingMachine, int[] lockingPID)
          Correct orphan job locks for current machine, and return current lock information.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CadastralFabric

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

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

Throws:
java.io.IOException - if there are interop problems CadastralFabric theCadastralFabric = (CadastralFabric) obj;
Method Detail

equals

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

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a CadastralFabric.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
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
The name of the Dataset.

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

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException
The associated name object.

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

getBrowseName

public java.lang.String getBrowseName()
                               throws java.io.IOException,
                                      AutomationException
The browse name of the dataset.

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

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException
The browse name of the dataset.

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

getType

public int getType()
            throws java.io.IOException,
                   AutomationException
The type of the Dataset.

Specified by:
getType in interface IDataset
Returns:
A com.esri.arcgis.geodatabase.esriDatasetType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the dataset.

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

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException
Datasets contained within this dataset.

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

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException
The workspace containing this dataset.

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

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
The set of properties for the dataset.

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

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
True if this dataset can be copied.

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

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException
Copies this dataset to a new dataset with the specified name.

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

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be deleted.

Specified by:
canDelete in interface IDataset
Returns:
The canDelete
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
Deletes this dataset.

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

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
True if this dataset can be renamed.

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

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException
Renames this Dataset.

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the GeoDataset.

Remarks

This property is read only. For layers, when the first layer is added to ArcMap, its spatial reference is read by this property, and the map is set to this spatial reference.

Instances of the esriCarto.GroupLayer class will return null for this property, as a group layer can contain multiple datasets with different spatial references.

Modifications to a spatial reference returned by this property will not be persisted. To modify the spatial reference of a dataset, the IGeoDatasetSchemaEdit and IGeoDatasetSchemaEdit2 interfaces should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the GeoDataset.

Remarks

The IGeoDataset::Extent property returns an envelope representing the maximum extent of data which has been stored in the dataset.

Consider the following scenario. A new feature class has features added to it. The IGeoDataset::Extent is then requested and an envelope is returned. The extents of the envelope returned are represented by the red box in the image below.

The red box represents the IGeoDataset extent

If a portion of the features were then deleted and the extent is again requested an envelope with the exact same extents as during the first request would be returned (see image below). This is because the deletion of features does not shrink the extent. However all additions of features outside the red box would increase the envelope returned to encompass the newly added features.

The red box represents the IGeoDataset extent after some of the features have been deleted

If you would like to update the IGeoDataset::Extent property to reflect the current features in your dataset please see IFeatureClassManage::UpdateExtent (also see IFeatureClassLoad). In the image below the extent has been updated and a new envelope is being returned.

The red box represents the IGeoDataset extent after it has been updated

ESRI's GroupLayer implements this property differently from most other layer coclasses. When you instantiate a new GroupLayer, this property will return a valid envelope with zero height and width. With most other newly instantiated layers (for example FeatureLayer, RasterLayer, TinLayer), this property initally returns Nothing.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

createJob

public int createJob(ICadastralJob job)
              throws java.io.IOException,
                     AutomationException
Creates a new cadastral job with the properties of the given CadastralJob object.

Specified by:
createJob in interface ICadastralFabric
Parameters:
job - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
Returns:
The jobID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJob

public ICadastralJob getJob(java.lang.String name)
                     throws java.io.IOException,
                            AutomationException
Retrieves a cadastral job given its name.

Specified by:
getJob in interface ICadastralFabric
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateJob

public void updateJob(ICadastralJob job)
               throws java.io.IOException,
                      AutomationException
Updates the existing job.

Specified by:
updateJob in interface ICadastralFabric
Parameters:
job - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteJob

public void deleteJob(java.lang.String name)
               throws java.io.IOException,
                      AutomationException
Deletes the existing job.

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

extractCadastralPacket

public IXMLStream extractCadastralPacket(java.lang.String jobName,
                                         IProjectedCoordinateSystem outputProjectedCoordSys,
                                         ITrackCancel trackCancel)
                                  throws java.io.IOException,
                                         AutomationException
Creates/Extracts a cadastral packet for the specified job.

Specified by:
extractCadastralPacket in interface ICadastralFabric
Parameters:
jobName - The jobName (in)
outputProjectedCoordSys - A reference to a com.esri.arcgis.geometry.IProjectedCoordinateSystem (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IXMLStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCadastralPacket

public void postCadastralPacket(IXMLStream xMLStream,
                                ITrackCancel cancelTracker)
                         throws java.io.IOException,
                                AutomationException
Saves the cadastral packet for the job.

Specified by:
postCadastralPacket in interface ICadastralFabric
Parameters:
xMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

commitJob

public void commitJob(java.lang.String jobName)
               throws java.io.IOException,
                      AutomationException
Commits the specified job to the cadastral fabric.

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

getCadastralJobs

public IEnumBSTR getCadastralJobs(int cadastralJobType)
                           throws java.io.IOException,
                                  AutomationException
The cadastral jobs that have not been committed.

Specified by:
getCadastralJobs in interface ICadastralFabric
Parameters:
cadastralJobType - A com.esri.arcgis.geodatabaseextensions.esriCadastralJob constant (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCadastralTable

public ITable getCadastralTable(int tableID)
                         throws java.io.IOException,
                                AutomationException
The cadastral fabric class at the specified enumeration.

Specified by:
getCadastralTable in interface ICadastralFabric
Parameters:
tableID - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
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.

createCadastralPacket

public IXMLStream createCadastralPacket(IProjectedCoordinateSystem outputProjectedCoordSys,
                                        IFIDSet planIDs,
                                        ITrackCancel trackCancel)
                                 throws java.io.IOException,
                                        AutomationException
Creates a cadastral packet without a linked job.

Specified by:
createCadastralPacket in interface ICadastralFabric2
Specified by:
createCadastralPacket in interface ICadastralFabric3
Parameters:
outputProjectedCoordSys - A reference to a com.esri.arcgis.geometry.IProjectedCoordinateSystem (in)
planIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IXMLStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertCadastralPacket

public void insertCadastralPacket(ICadastralJob newCadastralJobDefinition,
                                  IXMLStream xMLStream,
                                  ITrackCancel cancelTracker,
                                  IFIDSet[] insertedParcelOIDs)
                           throws java.io.IOException,
                                  AutomationException
Saves the cadastral packet and creates a new job if there are new parcels..

Specified by:
insertCadastralPacket in interface ICadastralFabric2
Parameters:
newCadastralJobDefinition - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
xMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
insertedParcelOIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractCadastralPacket

public IXMLStream extractCadastralPacket(java.lang.String jobName,
                                         IProjectedCoordinateSystem outputProjectedCoordSys,
                                         ITrackCancel trackCancel,
                                         boolean includeWhiteSpace)
                                  throws java.io.IOException,
                                         AutomationException
Creates/Extracts a cadastral packet for the specified job.

Specified by:
extractCadastralPacket in interface ICadastralFabric2
Specified by:
extractCadastralPacket in interface ICadastralFabric3
Parameters:
jobName - The jobName (in)
outputProjectedCoordSys - A reference to a com.esri.arcgis.geometry.IProjectedCoordinateSystem (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
includeWhiteSpace - The includeWhiteSpace (in)
Returns:
A reference to a com.esri.arcgis.system.IXMLStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCadastralPacket

public void postCadastralPacket(IXMLStream xMLStream,
                                ITrackCancel cancelTracker,
                                IFIDSet[] insertedParcelOIDs)
                         throws java.io.IOException,
                                AutomationException
Saves the cadastral packet for the job.

Specified by:
postCadastralPacket in interface ICadastralFabric2
Parameters:
xMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
insertedParcelOIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertCadastralPacket

public void insertCadastralPacket(ICadastralJob newCadastralJobDefinition,
                                  IXMLStream xMLStream,
                                  ITrackCancel cancelTracker,
                                  int ePacketSetting,
                                  IFIDSet[] insertedParcelOIDs)
                           throws java.io.IOException,
                                  AutomationException
Saves the cadastral packet and creates a new job if there are new parcels..

Specified by:
insertCadastralPacket in interface ICadastralFabric3
Parameters:
newCadastralJobDefinition - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
xMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
ePacketSetting - A com.esri.arcgis.geodatabaseextensions.esriCadastralPacketSetting constant (in)
insertedParcelOIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

postCadastralPacket

public void postCadastralPacket(IXMLStream xMLStream,
                                ITrackCancel cancelTracker,
                                int ePacketSetting,
                                IFIDSet[] insertedParcelOIDs)
                         throws java.io.IOException,
                                AutomationException
Saves the cadastral packet for the job.

Specified by:
postCadastralPacket in interface ICadastralFabric3
Parameters:
xMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
ePacketSetting - A com.esri.arcgis.geodatabaseextensions.esriCadastralPacketSetting constant (in)
insertedParcelOIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLockingJob

public void setLockingJob(java.lang.String rhs1)
                   throws java.io.IOException,
                          AutomationException
The name of the Job to apply locks on.

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

acquireLocks

public void acquireLocks(ILongArray pLocks,
                         boolean takeSoftLocks,
                         ILongArray[] ppLocksInConflict,
                         ILongArray[] ppSoftLocksInConflict)
                  throws java.io.IOException,
                         AutomationException
Acquire locks on the LockingJob. TakeSoftLocks allows locks to be transferred from other jobs in the same version.

Specified by:
acquireLocks in interface ICadastralFabricLocks
Parameters:
pLocks - A reference to a com.esri.arcgis.system.ILongArray (in)
takeSoftLocks - The takeSoftLocks (in)
ppLocksInConflict - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
ppSoftLocksInConflict - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undoLastAcquiredLocks

public void undoLastAcquiredLocks()
                           throws java.io.IOException,
                                  AutomationException
Rolls back most recent set of acquired locks, until last edit operation. Only effective once.

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

lockJob

public boolean lockJob()
                throws java.io.IOException,
                       AutomationException
Lock current job. An existing lock will cause failure.

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

releaseJobLock

public void releaseJobLock(boolean forceRelease)
                    throws java.io.IOException,
                           AutomationException
Release current job's lock.

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

validateJobLock

public void validateJobLock(boolean[] locked,
                            java.lang.String[] lockingMachine,
                            int[] lockingPID)
                     throws java.io.IOException,
                            AutomationException
Correct orphan job locks for current machine, and return current lock information.

Specified by:
validateJobLock in interface ICadastralFabricLocks
Parameters:
locked - The locked (in/out: use single element array)
lockingMachine - The lockingMachine (in/out: use single element array)
lockingPID - The lockingPID (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

acquireLocks

public void acquireLocks(ILongArray pLocks,
                         boolean takeSoftLocks,
                         ILongArray pLocksInConflict,
                         ILongArray pSoftLocksInConflict)
                  throws java.io.IOException,
                         AutomationException
Acquire locks on the LockingJob. TakeSoftLocks allows locks to be transferred from other jobs in the same version.

Specified by:
acquireLocks in interface ICadastralFabricLocks2
Parameters:
pLocks - A reference to a com.esri.arcgis.system.ILongArray (in)
takeSoftLocks - The takeSoftLocks (in)
pLocksInConflict - A reference to a com.esri.arcgis.system.ILongArray (in)
pSoftLocksInConflict - A reference to a com.esri.arcgis.system.ILongArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataElement

public IDEDataset getDataElement()
                          throws java.io.IOException,
                                 AutomationException
The data element corresponding to the dataset component.

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

getParent

public IDataset getParent()
                   throws java.io.IOException,
                          AutomationException
The containing parent dataset.

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

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException
True if the dataset is being edited.

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

changeSchemaLock

public void changeSchemaLock(int schemaLock)
                      throws java.io.IOException,
                             AutomationException
Changes a schema lock.

Specified by:
changeSchemaLock in interface ISchemaLock
Parameters:
schemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentSchemaLocks

public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
                           throws java.io.IOException,
                                  AutomationException
The list of current locks.

Specified by:
getCurrentSchemaLocks in interface ISchemaLock
Parameters:
schemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasUncompressedEdits

public boolean isHasUncompressedEdits()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the object has edits that haven't been compressed yet.

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

getVersion

public IVersion getVersion()
                    throws java.io.IOException,
                           AutomationException
The object's current version.

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

isRegisteredAsVersioned

public boolean isRegisteredAsVersioned()
                                throws java.io.IOException,
                                       AutomationException
Indicates if the object is registered as versioned.

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

registerAsVersioned

public void registerAsVersioned(boolean isVersioned)
                         throws java.io.IOException,
                                AutomationException
Register/UnRegister the object as being versioned.

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

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

Specified by:
getMetadata in interface IMetadata
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.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

Specified by:
setMetadata in interface IMetadata
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.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Indicates if metadata can be edited.

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

updateSchema

public void updateSchema(IDECadastralFabric dataElement)
                  throws java.io.IOException,
                         AutomationException
Updates the schema for the cadastral fabric based upon the given data element.

Specified by:
updateSchema in interface ICadastralFabricSchemaEdit
Parameters:
dataElement - A reference to a com.esri.arcgis.geodatabaseextensions.IDECadastralFabric (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

releaseReadOnlyFields

public void releaseReadOnlyFields(ITable pTable,
                                  int table)
                           throws java.io.IOException,
                                  AutomationException
Temporarily release the read-only property on system the fields of the given cadastral fabric table.

Specified by:
releaseReadOnlyFields in interface ICadastralFabricSchemaEdit2
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
table - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetReadOnlyFields

public void resetReadOnlyFields(int table)
                         throws java.io.IOException,
                                AutomationException
Reset the read-only property on system the fields of the cadastral fabric tables.

Specified by:
resetReadOnlyFields in interface ICadastralFabricSchemaEdit2
Parameters:
table - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.