com.esri.arcgis.geodatabase
Class ReplicaDataset

java.lang.Object
  extended by com.esri.arcgis.geodatabase.ReplicaDataset
All Implemented Interfaces:
IReplicaDataset, IReplicaDatasetEdit, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ReplicaDataset
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReplicaDataset, IReplicaDatasetEdit

ESRI Replica Dataset object.

Remarks

This class contains properties for getting information about each dataset in a replica (Check-out). Like the information returned by the Replica coClass, this information is written to the database during check out. Only datasets that implement ITable, such as a featureclass, table or attributed relationshipclass are returned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ICheckOut, IReplicaValidation, ICheckOut.checkOutData(com.esri.arcgis.geodatabase.IReplicaDescription, boolean, String), CheckOut, Serialized Form

Constructor Summary
ReplicaDataset()
          Constructs a ReplicaDataset using ArcGIS Engine.
ReplicaDataset(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ReplicaDataset theReplicaDataset = (ReplicaDataset) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getDatasetID()
          The ID of the dataset.
 String getName()
          The name of the dataset.
 String getParentDatabase()
          The name of the master geodatabase the dataset was checked out from.
 String getParentOwner()
          The owner of the dataset in the master geodatabase.
 int getReplicaID()
          The ID of the replica associated with this dataset.
 int getType()
          The type of the dataset.
 int hashCode()
          the hashcode for this object
 void setDatasetID(int rhs1)
          The ID of the dataset.
 void setName(String rhs1)
          The name of the dataset.
 void setParentDatabase(String rhs1)
          The name of the master geodatabase the dataset was checked out from.
 void setParentOwner(String rhs1)
          The owner of the dataset in the master geodatabase.
 void setReplicaID(int rhs1)
          The ID of the check-out associated with this dataset.
 void setType(int rhs1)
          The type of the dataset.
 
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

ReplicaDataset

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

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

ReplicaDataset

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getType

public int getType()
            throws IOException,
                   AutomationException
The type of the dataset.

Remarks

The Type property will return one of the following:

EsriDTFeatureClass
EsriDTTable
EsriDTRelationshipClass

From these objects, you can determine the associated feature datasets, geometric networks or topologies.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDatasetID

public int getDatasetID()
                 throws IOException,
                        AutomationException
The ID of the dataset.

Description

The DatasetID uniquely identifies the dataset (i.e. feature class, table or attributed relationship class) within the context of the workspace. This ID differs for corresponding datasets on the master and the check-out workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDatasetID in interface IReplicaDataset
Returns:
The datasetID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParentOwner

public String getParentOwner()
                      throws IOException,
                             AutomationException
The owner of the dataset in the master geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getParentOwner in interface IReplicaDataset
Returns:
The dsParentOwner
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParentDatabase

public String getParentDatabase()
                         throws IOException,
                                AutomationException
The name of the master geodatabase the dataset was checked out from.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getParentDatabase in interface IReplicaDataset
Returns:
The dsParentDatabase
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaID

public int getReplicaID()
                 throws IOException,
                        AutomationException
The ID of the replica associated with this dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getReplicaID in interface IReplicaDataset
Returns:
The rID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String rhs1)
             throws IOException,
                    AutomationException
The name of the dataset.

Product Availability

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

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

setType

public void setType(int rhs1)
             throws IOException,
                    AutomationException
The type of the dataset.

Product Availability

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

Specified by:
setType in interface IReplicaDatasetEdit
Parameters:
rhs1 - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatasetID

public void setDatasetID(int rhs1)
                  throws IOException,
                         AutomationException
The ID of the dataset.

Product Availability

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

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

setParentOwner

public void setParentOwner(String rhs1)
                    throws IOException,
                           AutomationException
The owner of the dataset in the master geodatabase.

Product Availability

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

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

setParentDatabase

public void setParentDatabase(String rhs1)
                       throws IOException,
                              AutomationException
The name of the master geodatabase the dataset was checked out from.

Product Availability

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

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

setReplicaID

public void setReplicaID(int rhs1)
                  throws IOException,
                         AutomationException
The ID of the check-out associated with this dataset.

Product Availability

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

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