com.esri.arcgis.geodatabasedistributed
Class DataExtraction

java.lang.Object
  extended by com.esri.arcgis.geodatabasedistributed.DataExtraction
All Implemented Interfaces:
IDataExtraction, IXMLDocumentVersion, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DataExtraction
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataExtraction, IXMLDocumentVersion

Extracts data from one geodatabase to another geodatabase.

Remarks

The DataExtraction coclass extracts data from one geodatabase to another geodatabase. It allows you to apply filters such that only a portion of the geodatabase is copied. The geodatabases involved can be either personal geodatabases or ArcSDE geodatabases.

A data extraction is very similar to a check out only in the data extraction case, you canít edit and check the changes back in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
DataExtraction()
          Constructs a DataExtraction using ArcGIS Engine.
DataExtraction(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataExtraction theDataExtraction = (DataExtraction) obj;
 
Method Summary
 void addIFeatureProgressListener(IFeatureProgress theListener)
          addIFeatureProgressListener.
 void addIReplicaProgressListener(IReplicaProgress theListener)
          addIReplicaProgressListener.
 boolean equals(Object o)
          Compare this object with another
 void extract(IReplicaDescription rDDescription, boolean transferRelObjects)
          Extracts schema and data from one geodatabase to another geodatabase.
 void extractSchema(IReplicaDescription rSDescription, ISpatialReference outputSpatialReference)
          Extracts schema only from one geodatabase to another geodatabase.
static String getClsid()
          getClsid.
 int hashCode()
          the hashcode for this object
 void removeIFeatureProgressListener(IFeatureProgress theListener)
          removeIFeatureProgressListener.
 void removeIReplicaProgressListener(IReplicaProgress theListener)
          removeIReplicaProgressListener.
 void setNamespaceToExportTo(String rhs1)
          The namespace (version) to export to.
 
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

DataExtraction

public DataExtraction()
               throws IOException,
                      UnknownHostException
Constructs a DataExtraction using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

DataExtraction

public DataExtraction(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataExtraction theDataExtraction = (DataExtraction) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

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

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

addIFeatureProgressListener

public void addIFeatureProgressListener(IFeatureProgress theListener)
                                 throws IOException
addIFeatureProgressListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.
Throws:
IOException - If there are communications problems.

removeIFeatureProgressListener

public void removeIFeatureProgressListener(IFeatureProgress theListener)
                                    throws IOException
removeIFeatureProgressListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IFeatureProgress interface.
Throws:
IOException - If there are communications problems.

addIReplicaProgressListener

public void addIReplicaProgressListener(IReplicaProgress theListener)
                                 throws IOException
addIReplicaProgressListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IReplicaProgress interface.
Throws:
IOException - If there are communications problems.

removeIReplicaProgressListener

public void removeIReplicaProgressListener(IReplicaProgress theListener)
                                    throws IOException
removeIReplicaProgressListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabasedistributed.IReplicaProgress interface.
Throws:
IOException - If there are communications problems.

extract

public void extract(IReplicaDescription rDDescription,
                    boolean transferRelObjects)
             throws IOException,
                    AutomationException
Extracts schema and data from one geodatabase to another geodatabase.

Remarks

The extract method extracts schema and data from one geodatabase to another geodatabase. The rDDescription parameter references a ReplicaDescription object which is used to specify the data to check out and the filters applied to this data.

If you set transferRelatedObjects to TRUE, related features/rows from other feature classes/tables will also be checked out. Otherwise, they are not checked out. Note that the schema of the related objects is always included regardless of whether transferRelatedObjects is TRUE or FALSE.

Unlike CheckOut or replication, DataExtraction can move data from a personal geodatabase or file geodatabase to an ArcSDE geodatabase or between personal and file geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extract in interface IDataExtraction
Parameters:
rDDescription - A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)
transferRelObjects - The transferRelObjects (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractSchema

public void extractSchema(IReplicaDescription rSDescription,
                          ISpatialReference outputSpatialReference)
                   throws IOException,
                          AutomationException
Extracts schema only from one geodatabase to another geodatabase.

Remarks

The ExtractSchema method extracts just the schema of the data involved. It also takes a ReplicaDescription object, but in this case it is used to simply define that schema to extract.

The OutputSpatialReference parameter allows you to set the spatial reference of the extracted schema. All spatial data will be assigned this spatial reference. If this parameter is set to nothing, then the spatial reference of the input datasets is used.

When performing an extraction with re-use schema set to TRUE in the ReplicaDescription, setting the spatial reference will result in an error.

Unlike CheckOut, DataExtraction can move data from a personal or file geodatabase to an ArcSDE geodatabase or between personal and file geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractSchema in interface IDataExtraction
Parameters:
rSDescription - A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)
outputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNamespaceToExportTo

public void setNamespaceToExportTo(String rhs1)
                            throws IOException,
                                   AutomationException
The namespace (version) to export to.

Product Availability

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

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