|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface IGeoDataServer
Provides access to methods supported by a GeoDataServer Object.
The IGeoDataServer interface exposes methods and properties to perform geodatabase replication operations, make copies using data extraction and query and browse a geodatabase.
| Method Summary | |
|---|---|
IGDSData |
compareReplicaSchema(IGDSData relativeReplicaSchemaDoc,
int transportType)
Compares the schema of a replica with that of its relative, and returns a schema changes XML document. |
IGDSData |
createReplica(String parentVersion,
String replicaName,
IGPReplicaDescription replicaDesc,
IGPReplicaOptions repOptions,
IGDSExportOptions exportOptions,
int transportType)
Creates a Replica. |
IGPReplicaDatasets |
expandReplicaDatasets(IGPReplicaDatasets repDatasets)
Expands a set of replica datasets taking into consideration geodatabase constructs (topologies, relationship classes, etc.). |
IGDSData |
exportAcknowledgement(String replicaName,
int transportType)
Export an acknowledgement message for a replica. |
IGDSData |
exportReplicaDataChanges(String replicaName,
IGDSExportOptions options,
int transportType,
int generationsToExport,
boolean switchRole)
Exports data changes for a replica. |
IGDSData |
exportReplicaSchema(String replicaName,
int transportType)
Exports the schema of a replica to an Xml document. |
IGDSData |
extractData(String versionName,
IGPReplicaDescription replicaDesc,
IGDSExportOptions options,
int transportType)
Extract Data. |
IDataElements |
getDataElements(IDEBrowseOptions pBrowseOptions)
The data elements in the workspace. |
String |
getDefaultWorkingVersion()
The default working version for all operations/methods. |
int |
getMaxRecordCount()
The maximum number of records to be returned by a search. |
IGDSQueryResultPortion |
getNextResultPortion(IResultPortionInfo desiredRange)
Gets the next portion of the results. |
IGPReplicas |
getReplicas()
The replicas in the workspace. |
IGPVersionInfos |
getVersions()
The versions in the workspace. |
int |
getWrappedWorkspaceType()
The type of the geodatabase the geodataserver operates on. |
void |
importAcknowledgement(IGDSData data)
Import an acknowledgement message for a replica. |
void |
importData(IGDSData pData,
int fmt)
Imports data into the workspace. |
boolean |
importReplicaDataChanges(int sourceType,
int reconcilePolicy,
boolean columnLevel,
IGDSData data)
Import the data changes for a replica. |
void |
importReplicaSchemaChanges(IGDSData schemaChangesDoc)
Updates the schema of the replica with the changes in an schema changes XML document. |
IGDSData |
reExportReplicaDataChanges(String replicaName,
IGDSExportOptions options,
int transportType,
int gensToExport)
Re-exports data changes for a replica. |
IGDSQueryResultPortion |
tableSearch(String versionName,
String tableName,
IQueryFilter queryFilter,
IResultPortionInfo queryRange)
Returns the records satisfying the specified query. |
void |
unregisterReplica(String replicaName)
Unregisters the replica. |
| Method Detail |
|---|
int getMaxRecordCount()
throws IOException,
AutomationException
The MaxRecordCount returns the maximum number of records that can be returned at once by a search. This value is stored as a configuration parameter with GeoDataServers publised on ArcGIS for Server. When intializing GeoDataServers from local geodatabases, you can set this value using the IGeoDataServerInit::MaxRecordCount property.
The TableSearch and GetNextResultPortion methods use this value to determine the maximum number of records that can be returned at once.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IDataElements getDataElements(IDEBrowseOptions pBrowseOptions)
throws IOException,
AutomationException
pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGPVersionInfos getVersions()
throws IOException,
AutomationException
If the GeoDataServer references an ArcSDE geodatabase, the Versions property returns the versions in the geodatabase.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGPReplicas getReplicas()
throws IOException,
AutomationException
The Replicas property returns a list of the replicas from the geodatabase referenced by the GeoDataServer.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
String getDefaultWorkingVersion()
throws IOException,
AutomationException
If the GeoDataServer references an ArcSDE geodatabase, the DefaultWorkingVersion property returns the version used by default for GeoDataServer operations. Some methods, such as IGeoDataServer::CreateReplica allow you to reference a different version from which to execute the method.
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
int getWrappedWorkspaceType()
throws IOException,
AutomationException
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData extractData(String versionName,
IGPReplicaDescription replicaDesc,
IGDSExportOptions options,
int transportType)
throws IOException,
AutomationException
The extractData method extracts schema and data from the geodatabase represented by the GeoDataServer in a disconnected environment. To extract data in a connected environment, see IReplicationAgent::ExtractData.
If the GeoDataServer references an ArcSDE geodatabase, the versionName parameter defines the version from which the data will be extracted.
The replicaDesc parameter is a description of the data to extract as well as various settings that define how the data will be extracted. For example, you can set a spatial filter and specify whether or not to include related data. See the GPReplicaDescription coclass for more information.
The options parameter defines the output of the method. This includes the outut format and whether or not the output will be compressed. See GDSExportOptions for more information.
If exporting to XML or FileGDBTransport, the output of this method can be used with the ImportData method to import the data into a destination geodatabase. If exporting to a file geodatabase or personal geodatabase, the output geodatabase can be used directly.
The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
When executed, the method returns a GDSData object. See the GDSData coclass for more information.
versionName - The versionName (in)replicaDesc - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDescription (in)options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData createReplica(String parentVersion,
String replicaName,
IGPReplicaDescription replicaDesc,
IGPReplicaOptions repOptions,
IGDSExportOptions exportOptions,
int transportType)
throws IOException,
AutomationException
This method is used to create a replica in a disconected environment. You may create either a two way replica, a one way replica or a check-out replica. To create replicas in a connected environment, see IReplicationAgent2::CreateReplica2.
The parentVersion parameter is the version on the geodatabase represented by the geodatataserver that the replica will be created from. ReplicaName is the name for the replica.
The replicaDesc parameter is a description of the data to replicate as well as various settings that define how the data will be replicated. For example, you can set a spatial filter, set the replica model type, and specify whether or not to include related data. See the GPReplicaDescription coclass for more information.
The repOptions parameter is used to set various replica options such as the replica access type and the initial data sender. See the GPReplicaOptions coclass for more information.
The exportOptions parameter defines the output of the method. This includes the outut format and whether or not the output will be compressed. See GDSExportOptions for more information.
If exporting to XML or FileGDBTransport, the output of this method is used with the ImportData method to import the replica into a destination geodatabase and complete replica creation. For check-out replicas, you can also choose to replicate directly to a file geodatabase or personal geodatabase. Here the output is the replica geodatabase and therefore no import is required.
FileGDBTransport is not supported when IGPReplicaOptions registerExistingDataOnly flag is set to true. To create a replica by registering existing data only, export to XML instead.
The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
When executed, the method returns a GDSData object. See the GDSData coclass for more information.
parentVersion - The parentVersion (in)replicaName - The replicaName (in)replicaDesc - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDescription (in)repOptions - A reference to a com.esri.arcgis.geodatabase.IGPReplicaOptions (in)exportOptions - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGPReplicaDatasets expandReplicaDatasets(IGPReplicaDatasets repDatasets)
throws IOException,
AutomationException
The ExpandReplicaDatasets method returns the expanded list of datasets to replicate or extract. Data extraction and replica creation apply an expansion process to ensure that all feature classes in a topology or geometric network and related feature classes and tables are included. For example, if you pass in a GPReplicaDataset for a feature class that is involved in a topology, replica creation will include all feature classes in the topology.
This method allows you to set properties for each expanded GPReplicaDataset before creating replicas or extracting data. Unless you use this method, the expanded classes will be given default properties.
repDatasets - A reference to a com.esri.arcgis.geodatabase.IGPReplicaDatasets (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void importData(IGDSData pData,
int fmt)
throws IOException,
AutomationException
The ImportData method imports data into the geodatabase referenced by the GeoDataServer. The pData parameter takes a GDSData object which defines the data to import. The fmt parameter specifies the format of the data.
The data to import may be a XML workspace document or a FileGDB transport file generated from the IGeoDataServer::CreateReplica command. The process of importing these files completes the replica creation process and add a new child replica to the geodatabase.
The data may also be from a personal geodatabase, file geodatabase or an XML workspace document generated outside the context of replication. The IGeoDataServer::ExtractData method, for example, can also be used to generate these files. In these cases, the data is simply copied to the geodatabase.
pData - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)fmt - A com.esri.arcgis.geodatabasedistributed.esriGDSImportFormat constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData exportReplicaDataChanges(String replicaName,
IGDSExportOptions options,
int transportType,
int generationsToExport,
boolean switchRole)
throws IOException,
AutomationException
The ExportReplicaDataChanges method is used to export data changes from a replica. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.
This method should be used in conjunction with the IGeoDataServer::ImportReplicaDataChanges method to complete the transfer of data changes from one replica to it's relative. Note that this method can only be executed for replicas that are data senders. See IGPReplica::ReplicaState for more information.
The ReplicaName is the name of the replica from which to export changes.
The options parameter defines the output of the method. This includes the outut format and whether or not the output will be compressed. See GDSExportOptions for more information.
The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
The generationsToExport parameter uses the esriExportGenerationsOption enumeration to specify what data changes to export. You may choose to export only unacknowledged data change, only new data changes, all data changes, or no data changes. You would export no data changes if you were interested in switching roles (see below). See the esriExportGenerationsOptions enumeration for more information.
Set the switchRole parameter to true if after exporting the data changes, you want to start receiving changes from the relative replica. When set to true, the source replica transitions from a data sender to a data receiver upon export. When the relative replica successfully imports this delta file, it transitions from a data receiver to a data sender. See the ImportReplicaDataChanges method for more information.
When executed, the method returns a GDSData object. See the GDSData coclass for more information.
replicaName - The replicaName (in)options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)generationsToExport - A com.esri.arcgis.geodatabasedistributed.esriExportGenerationsOption constant (in)switchRole - The switchRole (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData reExportReplicaDataChanges(String replicaName,
IGDSExportOptions options,
int transportType,
int gensToExport)
throws IOException,
AutomationException
The ReexportReplicaDataChanges method is used to re-export previously sent data changes from a replica. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.
This method is very similar to the ExportReplicaDataChanges method, except it only allows you to re-export changes that have been previously sent. The paraemters are the same as the ExportReplicaDataChanges method with the gensToExport parameter.
The gensToExport parameter uses the esriReExportGenerationsOption enumeration to specify what data changes to export. You may choose to export all unacknowledged data changes or only the last unacknowledged changes. See the esriReExportGenerationsOptions enumeration for more information.
replicaName - The replicaName (in)options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)gensToExport - A com.esri.arcgis.geodatabasedistributed.esriReExportGenerationsOption constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
boolean importReplicaDataChanges(int sourceType,
int reconcilePolicy,
boolean columnLevel,
IGDSData data)
throws IOException,
AutomationException
The ImportReplicaDataChanges method is used to import replica data change messages. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.
This method should be used in conjunction with the IGeoDataServer::ExportReplicaDataChanges method to complete the transfer to data from one replica to it's relative. Note that this method can only be executed for replicas that are data receivers. See IGPReplica::ReplicaState for more information.
The sourcetype defines the file format used to store the changes.
The reconcilePolicy parameter uses the esriReplicaReconilePolicyType enumeration to define how conflicts will be resolved when the changes are imported. When importing to a replica, changes are first applied to a synchronization version. For 2 way and 1 way replicas, this version is always reconciled and posted with the replica version. For check-out replicas, you can also choose whether or not to reconcile and post. The following describes the meaning of each enumeration:
esriReplicaDetectConflicts -If conflicts occur, the reconcile process is aborted and you must reconcile and post manually after sycnhronization is completed.
esriReplicaResolveConflictsInFavorOfImportedChanges - Automatically resolve conflicts in favor of the changes being imported.
esriReplicaResolveConflictsInFavorOfDatabaseChanges - Automatically resolve conflicts in favor of the database importing the changes.
esriReplicaResolveConflictsNone - This enumeration has meaning for check-out replicas only. It indicates that a reconcile and post should not be applied during synchronization.
The columnLevel parameter defines whether or not to use column level conflict detection. If true, conflicts occur only when specific column values differ. If false, any change to any values in each row can cause a conflict.
The data parameter takes a reference to an GDSData object which is the source of the data changes. See the GDSData coclass for more information.
The method returns TRUE if conflicts were detected. It returns FALSE if no conflicts were detected.
sourceType - A com.esri.arcgis.geodatabasedistributed.esriGDSReplicaImportSource constant (in)reconcilePolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)columnLevel - The columnLevel (in)data - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData exportAcknowledgement(String replicaName,
int transportType)
throws IOException,
AutomationException
The ExportAcknowledgement method is used to export an acknowledgement message from a replica. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.
This method should be used in conjunction with IGeoDataServer::ImportAcknowledgement method where the acknowledgement message can be imported by the relative replica.
The ReplicaName is the name of the replica.
The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
The acknowledgement message is returned as an instance of a GDSData object. Acknowledgement files are always stored in an XMl format. See the GDSData coclass for more information.
replicaName - The replicaName (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void importAcknowledgement(IGDSData data)
throws IOException,
AutomationException
The ImportAcknowledgement method is used to import an acknowledgement message into a replica. Use this method when synchronizing replicas in a disconnected environment. To synchronize replicas in a connected environment, see IReplicationAgent::SynchronizeReplica.
The acknowledgement message must first be generated by calling the GeoDataServer::ExportAcknowledgement method.
The data parameter takes a GDSData object. See the GDSData coclass for more information.
data - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void unregisterReplica(String replicaName)
throws IOException,
AutomationException
The UnregisterReplica method is used to unregister or delete a replica from the geodatabase.
The ReplicaName is the nane of the replica.
replicaName - The replicaName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSQueryResultPortion tableSearch(String versionName,
String tableName,
IQueryFilter queryFilter,
IResultPortionInfo queryRange)
throws IOException,
AutomationException
The TableSearch method is used to query tables and feature classes from the geodatabase referenced by the GeoDataServer. Both attribute and spatial queries can be performed. The method returns an instance of GDSQueryResultPortion, which contains a recordset of features or rows that satisfy the query filter.
The GDSQueryResultPortion can contain up to the number of rows specified by the queryRange parameter. If the query filter returns more rows than the query range allows, subsequent calls to GetNextResultPortion can be used to get the rest of the rows. Results are returned in portions because the GeoDataServer may be from ArcGIS for Server accesed on a network with limited band width.
The maximum number of rows that can be returned by a TableSearch is determined by the IGeoDataServer::MaxRecordCount property.
If the geodatabase referenced by the GeoDataServer is an ArcSDE geodatabase, you can set the versionName parameter to the version on which to execute the query. If no versionName is provided, the version that the GeoDataServer is currently referencing is used. For non-ArcSDE geodatabases, the versionName is ignored.
The tableName and queryFilter parameters define the query and the table or feature class on which to execute the query. The queryRange defines how to return the results.
versionName - The versionName (in)tableName - The tableName (in)queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)queryRange - A reference to a com.esri.arcgis.geodatabase.IResultPortionInfo (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSQueryResultPortion getNextResultPortion(IResultPortionInfo desiredRange)
throws IOException,
AutomationException
The GetNextResultPortion method is used to query table and feature classes. This method is used to get additional records after the initial query has been performed using the IGeoDataServer::TableSearch method.
desiredRange - A reference to a com.esri.arcgis.geodatabase.IResultPortionInfo (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData exportReplicaSchema(String replicaName,
int transportType)
throws IOException,
AutomationException
The ExportReplicaSchema method exports the schema of a replica in XML file.
This method can be used in conjunction with the IGeoDataServer::CompareReplicaSchema method on the relative replica to compare the schemas between a replica pair. The IGeoDataServer::ImportReplicaSchema method can then be used to apply those schema changes to the relative replica database.
The ReplicaName is the name of the replica. The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
This method returns a GDSData object. See the GDSData coclass for more information.
replicaName - The replicaName (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
IGDSData compareReplicaSchema(IGDSData relativeReplicaSchemaDoc,
int transportType)
throws IOException,
AutomationException
The CompareReplicaSchema method is used to compare a replicas schema to its relative replicas schema and returns a schema changes XML document.
This method should be used in conjunction with the IGeoDataServer::ImportReplicaSchemaChanges method to apply the schema changes.
The TransportType indicates the desired transport type. Use esriGDSTransportTypeURL to place the output in a file in the virtual output directory. Use esriGDSTransportTypeEmbedded to have the results embedded in the output GDSData object. If no virtual output directory exists, the results will be embedded regardless of the value set for this parameter.
The relativeReplicaSchemaDoc parameter takes a reference to a GDSData object for the replica schema file of the relative replica. This file must first be created for the relative replica before executing this method. See the IGeoDataServer::ExportReplicaSchema for information on how to generate this file.
This method returns a GDSData object for the schema changes XML document. See the GDSData coclass for more information.
relativeReplicaSchemaDoc - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
void importReplicaSchemaChanges(IGDSData schemaChangesDoc)
throws IOException,
AutomationException
The ImportReplicaSchemaChanges method updates the schema of the replica with the changes in a schema changes XML document.
The schemaChangesDoc is GDSData object which references the schema changes XML document. The schema changes XML document must first be generated by running the IGeoDataServer::CompareReplicaSchema method.
schemaChangesDoc - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (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 | ||||||||