com.esri.arcgis.geodatabaseextensions
Interface ICadastralFabric

All Superinterfaces:
Serializable
All Known Implementing Classes:
CadastralFabric, ICadastralFabricProxy

public interface ICadastralFabric
extends Serializable

Provides access to members that control a cadastral fabric and its associated cadastral jobs.

Remarks

The cadastral fabric dataset is an extendable data model for the management of parcel data. It comprises a set of fabric classes that support the basis of a land information system.

The cadastral fabric defines 3 key areas of operation:

  1. Core Fabric
  2. Job Management
  3. Feature Adjustment

1. Core Fabric

The core fabric tables are shown in the image below:

By default the accuracy category values are initialized to the following, however these can be changed to fit the values defined by your organization:

Category Bearing Std.Dev. (seconds) Distance Std.Dev. (meters) ppm Description
1 5.00 0.0001 5 1-Highest
2 30.00 0.01 25 2-After 1980
3 60.00 0.02 50 3-1908 to 1980
4 120.00 0.05 125 4-1881 to 1907
5 300.00 0.20 125 5-Before1881
6 3600.00 1.00 1000 6-1800
7 6000.00 10.00 5000 7-Lowest

2. Job Management

The job management tables allow audit trails of edits to parcels in the cadastral fabric, and these 2 tables also help to manage the edits to parcels and prevention of edit conflicts.

3. Feature Adjustment

Anytime changes to coordinates occur, these are tracked as vectors in the cadastral fabric adjustment tables. These vectors are published by the cadasatral fabric for use to adjust standard feature class layers that are associated with the (subscribe to) the cadastral fabric.

Product Availability

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


Method Summary
 void commitJob(String jobName)
          Commits the specified job to the cadastral fabric.
 int createJob(ICadastralJob job)
          Creates a new cadastral job with the properties of the given CadastralJob object.
 void deleteJob(String name)
          Deletes the existing job.
 IXMLStream extractCadastralPacket(String jobName, IProjectedCoordinateSystem outputProjectedCoordSys, ITrackCancel trackCancel)
          Creates/Extracts a cadastral packet for the specified job.
 IEnumBSTR getCadastralJobs(int cadastralJobType)
          The cadastral jobs that have not been committed.
 ITable getCadastralTable(int tableID)
          The cadastral fabric class at the specified enumeration.
 ICadastralJob getJob(String name)
          Retrieves a cadastral job given its name.
 void postCadastralPacket(IXMLStream xMLStream, ITrackCancel cancelTracker)
          Saves the cadastral packet for the job.
 void updateJob(ICadastralJob job)
          Updates the existing job.
 

Method Detail

createJob

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

Remarks

Creates a new Cadastral Job with the properties of the given CadastralJob object.

The CreateJob method can be used to create a new cadastral job with the properties of the given CadastralJob object such as the name, description, owner and participating parcels. The job name must be unique.

Product Availability

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

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

getJob

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

Remarks

Retrieve a Cadastral Job by its name.

The GetJob method can be used to retrieve any active cadastral job of the fabric given the name of the job.

Product Availability

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

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

updateJob

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

Remarks

Apply updates to an existing Cadastral Job.

The UpdateJob method can be used to apply updates to the properties of an existing cadastral job, such as the name, description, owner and participating parcels. Use the GetJob method to retrieve the cadastral job to be updated. Alter the properties of the CadastralJob object using the members of the interface ICadastralJob and then pass the object as the Job parameter of this method.

Product Availability

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

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

deleteJob

void deleteJob(String name)
               throws IOException,
                      AutomationException
Deletes the existing job.

Remarks

Deletes a Cadastral Job from the Cadastral Fabric.

The DeleteJob method can be used to delete a cadastral job given the name of the job to be deleted. The DeleteJob method will delete its record in the cadastral jobs table and the associated references in the JobObjects table.

Product Availability

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

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractCadastralPacket

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

Remarks

Create/Extract a cadastral packet for the specified job. A cadastral packet is a set of data extracted from the Cadastral Fabric dataset that is used in-memory, and represents the editable Cadastral Job.

The ExtractCadastralPacket method creates a packet for the cadastral job that matches the JobName input. This packet is returned as an XMLStream. The XMLStream output can be passed to the cadastral editor via ICadastralExtension::ReadXMLPacket().

The XML stream contains all the parcels (and their associated fabric data) and control points that make up the job.

Product Availability

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

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

postCadastralPacket

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

Remarks

Saves the data in the cadastral packet back into the cadastral fabric dataset. A cadastral packet is a set of data extracted from the Cadastral Fabric dataset that is used in-memory, and represents the editable Cadastral Job.

Product Availability

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

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

commitJob

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

Remarks

Commits the specified job to the cadastral fabric. The Commit method de-references the parcels represented in the JobObjects table.

The CommitJob method can be used to commit the specified job. Committing a job will clear any references to features in the job and change the status of the job to "committed". Once a job is committed, it is no longer available for edits.

A cadastral job cannot be commited if there are unjoined parcels in the job.

Product Availability

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

Parameters:
jobName - The jobName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCadastralJobs

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

Product Availability

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

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

getCadastralTable

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

Product Availability

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

Parameters:
tableID - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.