com.esri.arcgis.geodatabaseextensions.CadastralFabric
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class CadastralFabric
A container for querying information about a cadastral fabric.
| Constructor Summary | |
|---|---|
CadastralFabric(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(String jobName)
Commits the specified job to the cadastral fabric. |
IDataset |
copy(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(String name)
Deletes the existing job. |
void |
enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
enumConnectionPoints |
boolean |
equals(Object o)
Compare this object with another |
IXMLStream |
extractCadastralPacket(String jobName,
IProjectedCoordinateSystem outputProjectedCoordSys,
ITrackCancel trackCancel)
Creates/Extracts a cadastral packet for the specified job. |
IXMLStream |
extractCadastralPacket(String jobName,
IProjectedCoordinateSystem outputProjectedCoordSys,
ITrackCancel trackCancel,
boolean includeWhiteSpace)
Creates/Extracts a cadastral packet for the specified job. |
void |
findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
findConnectionPoint |
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. |
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. |
ICadastralJob |
getJob(String name)
Retrieves a cadastral job given its name. |
IPropertySet |
getMetadata()
The PropertySet containing metadata. |
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 |
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(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(String name)
The browse name of the dataset. |
void |
setLockingJob(String rhs1)
The name of the Job to apply locks on. |
void |
setMetadata(IPropertySet ppPropertySet)
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,
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 |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public CadastralFabric(Object obj)
throws IOException
obj to CadastralFabric. *
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
IOException - if there are interop problems
CadastralFabric theCadastralFabric = (CadastralFabric) obj;| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
enumConnectionPoints in interface IConnectionPointContainerppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void findConnectionPoint(GUID riid,
IConnectionPoint[] ppCP)
throws IOException,
AutomationException
IConnectionPointContainer is a Microsoft interface. Please refer to MSDN for information about this interface.
findConnectionPoint in interface IConnectionPointContainerriid - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getName()
throws IOException,
AutomationException
getName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws IOException,
AutomationException
getFullName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBrowseName()
throws IOException,
AutomationException
getBrowseName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(String name)
throws IOException,
AutomationException
setBrowseName in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getType()
throws IOException,
AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDataset getSubsets()
throws IOException,
AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspace getWorkspace()
throws IOException,
AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getPropertySet()
throws IOException,
AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canCopy()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
canCopy in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataset copy(String copyName,
IWorkspace copyWorkspace)
throws IOException,
AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy in interface IDatasetcopyName - The copyName (in)copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canDelete()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delete()
throws IOException,
AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canRename()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void rename(String name)
throws IOException,
AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ISpatialReference getSpatialReference()
throws IOException,
AutomationException
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.
getSpatialReference in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnvelope getExtent()
throws IOException,
AutomationException
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.
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.
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.
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.
getExtent in interface IGeoDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int createJob(ICadastralJob job)
throws IOException,
AutomationException
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.
createJob in interface ICadastralFabricjob - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICadastralJob getJob(String name)
throws IOException,
AutomationException
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.
getJob in interface ICadastralFabricname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateJob(ICadastralJob job)
throws IOException,
AutomationException
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.
updateJob in interface ICadastralFabricjob - A reference to a com.esri.arcgis.geodatabaseextensions.ICadastralJob (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void deleteJob(String name)
throws IOException,
AutomationException
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.
deleteJob in interface ICadastralFabricname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IXMLStream extractCadastralPacket(String jobName,
IProjectedCoordinateSystem outputProjectedCoordSys,
ITrackCancel trackCancel)
throws IOException,
AutomationException
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.
extractCadastralPacket in interface ICadastralFabricjobName - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void postCadastralPacket(IXMLStream xMLStream,
ITrackCancel cancelTracker)
throws IOException,
AutomationException
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.
postCadastralPacket in interface ICadastralFabricxMLStream - A reference to a com.esri.arcgis.system.IXMLStream (in)cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void commitJob(String jobName)
throws IOException,
AutomationException
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.
commitJob in interface ICadastralFabricjobName - The jobName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumBSTR getCadastralJobs(int cadastralJobType)
throws IOException,
AutomationException
getCadastralJobs in interface ICadastralFabriccadastralJobType - A com.esri.arcgis.geodatabaseextensions.esriCadastralJob constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable getCadastralTable(int tableID)
throws IOException,
AutomationException
getCadastralTable in interface ICadastralFabrictableID - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IXMLStream createCadastralPacket(IProjectedCoordinateSystem outputProjectedCoordSys,
IFIDSet planIDs,
ITrackCancel trackCancel)
throws IOException,
AutomationException
createCadastralPacket in interface ICadastralFabric2createCadastralPacket in interface ICadastralFabric3outputProjectedCoordSys - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void insertCadastralPacket(ICadastralJob newCadastralJobDefinition,
IXMLStream xMLStream,
ITrackCancel cancelTracker,
IFIDSet[] insertedParcelOIDs)
throws IOException,
AutomationException
insertCadastralPacket in interface ICadastralFabric2newCadastralJobDefinition - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IXMLStream extractCadastralPacket(String jobName,
IProjectedCoordinateSystem outputProjectedCoordSys,
ITrackCancel trackCancel,
boolean includeWhiteSpace)
throws IOException,
AutomationException
extractCadastralPacket in interface ICadastralFabric2extractCadastralPacket in interface ICadastralFabric3jobName - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void postCadastralPacket(IXMLStream xMLStream,
ITrackCancel cancelTracker,
IFIDSet[] insertedParcelOIDs)
throws IOException,
AutomationException
postCadastralPacket in interface ICadastralFabric2xMLStream - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void insertCadastralPacket(ICadastralJob newCadastralJobDefinition,
IXMLStream xMLStream,
ITrackCancel cancelTracker,
int ePacketSetting,
IFIDSet[] insertedParcelOIDs)
throws IOException,
AutomationException
insertCadastralPacket in interface ICadastralFabric3newCadastralJobDefinition - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void postCadastralPacket(IXMLStream xMLStream,
ITrackCancel cancelTracker,
int ePacketSetting,
IFIDSet[] insertedParcelOIDs)
throws IOException,
AutomationException
postCadastralPacket in interface ICadastralFabric3xMLStream - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setLockingJob(String rhs1)
throws IOException,
AutomationException
The Cadastral Job on which all methods will be applied.
When using this interface you need to first set this property, before using any of the other methods.
setLockingJob in interface ICadastralFabricLocksrhs1 - The rhs1 (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void acquireLocks(ILongArray pLocks,
boolean takeSoftLocks,
ILongArray[] ppLocksInConflict,
ILongArray[] ppSoftLocksInConflict)
throws IOException,
AutomationException
Add the given parcel ids as members of the current job.
The array of locks refer to the object ids of parcels in the parcel fabric class.
Soft locks refers to parcels that can be taken and used as an edit parcel in another job.
Soft locks are:
Set the parameter to True if you'd like to automatically get these locks for the current Job.
acquireLocks in interface ICadastralFabricLockspLocks - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void undoLastAcquiredLocks()
throws IOException,
AutomationException
Undo the last set of locks acquired. This action is applied up until the last edit operation.
undoLastAcquiredLocks in interface ICadastralFabricLocksIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean lockJob()
throws IOException,
AutomationException
Enters the MachineName and ProcessID values into the Jobs table.
This method is usually the next call after setting the LockingJob. If the method returns FALSE, then the lock is already held by another machine or process id.
lockJob in interface ICadastralFabricLocksIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void releaseJobLock(boolean forceRelease)
throws IOException,
AutomationException
Removes the MachineName and ProcessID values out of the Jobs table.
releaseJobLock in interface ICadastralFabricLocksforceRelease - The forceRelease (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void validateJobLock(boolean[] locked,
String[] lockingMachine,
int[] lockingPID)
throws IOException,
AutomationException
Validates the MachineName and ProcessID values in the Jobs table.
validateJobLock in interface ICadastralFabricLockslocked - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void acquireLocks(ILongArray pLocks,
boolean takeSoftLocks,
ILongArray pLocksInConflict,
ILongArray pSoftLocksInConflict)
throws IOException,
AutomationException
acquireLocks in interface ICadastralFabricLocks2pLocks - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDEDataset getDataElement()
throws IOException,
AutomationException
The DataElement method is used to access the data element for this dataset component.
getDataElement in interface IDatasetComponentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataset getParent()
throws IOException,
AutomationException
Returns the parent of the dataset component. For example, for geodatabase network datasets this will return the containing feature dataset.
getParent in interface IDatasetComponentIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isBeingEdited()
throws IOException,
AutomationException
Once an edit session has been started on a workspace, the IsBeingEdited method on the IDatasetEdit interface can be used to determine if a particular dataset is participating in the edit session.
The reasons why a dataset may not participate include the connected user has no privileges or permission to edit the dataset, the connected user is not licensed to edit this type of dataset, or the dataset is not versioned but a versioned edit session has been started (or vice versa).
isBeingEdited in interface IDatasetEditIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void changeSchemaLock(int schemaLock)
throws IOException,
AutomationException
changeSchemaLock in interface ISchemaLockschemaLock - A com.esri.arcgis.geodatabase.esriSchemaLock constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getCurrentSchemaLocks(IEnumSchemaLockInfo[] schemaLockInfo)
throws IOException,
AutomationException
The ISchemaLockInfo interface is used in concert with ISchemaLock to provide information about a schema lock, for example, whether it is shared or exclusive and for ArcSDE geodatabases, the name of the user who has the lock. Note that there will always be at least one schema lock on the dataset. Also note that by checking the schema locks on a dataset a shared schema lock is applied to the data.
getCurrentSchemaLocks in interface ISchemaLockschemaLockInfo - A reference to a com.esri.arcgis.geodatabase.IEnumSchemaLockInfo (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isHasUncompressedEdits()
throws IOException,
AutomationException
The HasUncompressedEdits method returns a boolean value that represents if the dataset contains versioned edits that have not been compressed to the base state.
Knowing if the dataset contains any edits is important prior to unregistering the dataset as versioned.
isHasUncompressedEdits in interface IVersionedObject2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IVersion getVersion()
throws IOException,
AutomationException
The Version method returns an IVersion object that is the current version the object references. This provides a mechanism to easily detect the version of the database that an object references.
getVersion in interface IVersionedObjectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isRegisteredAsVersioned()
throws IOException,
AutomationException
Returns if the underlying dataset is registered as versioned. This only applies to datasets that exist in versioned workspaces.
isRegisteredAsVersioned in interface IVersionedObjectIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void registerAsVersioned(boolean isVersioned)
throws IOException,
AutomationException
The RegisterAsVersioned method registers or unregisters datasets. Feature classes that participate in feature datasets can be registered or unregistered, although it is highly recomended that the operation be performed on the entire feature dataset. The method requires a boolean argument, true to register or false to unregister the object.
Unregistering an object class as versioned permanently drops the object's delta tables. To preserve the edits, perform a compress prior to unregistering as versioned. See IVersionedWorkspace.Compress and IVersionedObject2 for additional information.
Only the owner can register or unregister the object.
By programmatically registering a class participating in a geometric network as versioned it does not guarantee the entire geometric network including other participating classes will also be registered. It is then recommended the registration take place at the feature dataset level rather than on the individual feature class. This workflow is exposed by default through the user interface in ArcCatalog. If there is a need to register individual classes as versioned within a feature dataset without registering the entire dataset it is crucial the every class participating in a geometric network, including the geometric network itself, is explicitly registered individually.
Archiving must first be disabaled on a class before it can be unregistered as versioned. This situation only applies to classes that have been registered as versioned with the MoveEditsToBase option set to false through the IVersionObject3.RegisterAsVersioned3 method.
registerAsVersioned in interface IVersionedObjectisVersioned - The isVersioned (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getMetadata()
throws IOException,
AutomationException
The variable to hold the data must be of IPropertySet data type.
The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.
getMetadata in interface IMetadataIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setMetadata(IPropertySet ppPropertySet)
throws IOException,
AutomationException
setMetadata in interface IMetadatappPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void synchronize(int action,
int interval)
throws IOException,
AutomationException
The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.
The following actions will result in synchronization given each of the listed conditions:
| Action | Metadata status | Esri/Sync element | Interval parameter |
|---|---|---|---|
| esriMSAAccessed | Doesn't matter | Must not be FALSE | Must be less than actual interval |
| esriMSAAlways | Doesn't matter | Doesn't matter | Doesn't matter |
| esriMSACreated | Must not exist | Must not be FALSE | Must be less than actual interval |
| esriMSANotCreated | Must exist | Must not be FALSE | Must be less than actual interval |
| esriMSAOverwrite | Doesn't matter | Doesn't matter | Doesn't matter |
The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.
synchronize in interface IMetadataaction - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval - The interval (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isCanEditMetadata()
throws IOException,
AutomationException
This property is available to those objects that support metadata.
isCanEditMetadata in interface IMetadataEditIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void updateSchema(IDECadastralFabric dataElement)
throws IOException,
AutomationException
Updates the schema for the cadastral fabric based upon the given data element.
Use the UpdateSchema method to update the cadastral fabric schema in one operation. The DataElement may contain schema changes such as modifications to the extended attribute fields or changes to the accuracy category values for the cadastral fabric.
Any custom updates to the schema of the cadastral fabric must occur via ICadastralFabricSchemaEdit::UpdateSchema() to properly persist the changes to the dataset.
As the developer, you're responsible for ensuring the integrity of the data element when it’s supplied to the UpdateSchema method.
updateSchema in interface ICadastralFabricSchemaEditdataElement - A reference to a com.esri.arcgis.geodatabaseextensions.IDECadastralFabric (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void releaseReadOnlyFields(ITable pTable,
int table)
throws IOException,
AutomationException
releaseReadOnlyFields in interface ICadastralFabricSchemaEdit2pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)table - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void resetReadOnlyFields(int table)
throws IOException,
AutomationException
resetReadOnlyFields in interface ICadastralFabricSchemaEdit2table - A com.esri.arcgis.geodatabaseextensions.esriCadastralFabricTable constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||