|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geodatabase.Replica
public class Replica
ESRI Replica object.
During a check out, information is written to the GDB_REPLICAS table in the master and checkout-out geodatabases. This information is displayed in the check-out manager. The Replica coclass allows you to access this information.
ICheckOut
,
IReplicaValidation
,
ICheckOut.checkOutData(com.esri.arcgis.geodatabase.IReplicaDescription, boolean, String)
,
CheckOut
,
Serialized FormConstructor Summary | |
---|---|
Replica()
Constructs a Replica using ArcGIS Engine. |
|
Replica(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Replica theReplica = (Replica) obj; |
Method Summary | |
---|---|
boolean |
equals(Object o)
Compare this object with another |
int |
getAccessType()
Replica access type. |
IEnumReplicaDataset |
getAllReplicaDatasets()
The replica datasets for the replica. |
static String |
getClsid()
getClsid. |
IWorkspaceName |
getConnectionInfo()
The WorkspaceName object for the master geodatabase. |
IReplicaDescription |
getDescription()
The ReplicaDescription associated with the replica. |
IEnumReplicaLog |
getLog()
Replica log associated with this replica. |
int |
getMyGenerationNumber()
The generation number for a replica. |
String |
getName()
The name of the replica. |
String |
getOwner()
The database user that owns the replica in the workspace. |
int |
getParentID()
The ID of the replica reference in the master geodatabase. |
int |
getReconcilePolicyType()
Replica reconcile policy. |
IEnumReplicaDataset |
getReplicaDatasets()
The replica datasets for this replica. |
double |
getReplicaDate()
The date that the data was checked out. |
String |
getReplicaGuid()
The guid of the replica. |
int |
getReplicaID()
The ID of the replica. |
String |
getReplicaReceivingVersion()
The replica version that recieves the changes. |
int |
getReplicaRole()
Determines if the workspace is the replica geodatabase or the master geodatabase for the replica. |
int |
getReplicaState()
The replica state. |
String |
getSibConnectionString()
The sib connection string for a replica. |
int |
getSibGenerationNumber()
The generation number for a replica's sibling. |
int |
getSibMyGenNumber()
The generation number that the sibling thinks is my generation number. |
String |
getVersion()
The name of the replica version. |
int |
hashCode()
the hashcode for this object |
void |
init(IReplica otherReplica)
Init the replica from other replica. |
void |
init2(IGPReplica gPReplica,
IWorkspace targetWorkspace)
Initializes a replica from a gpreplica. |
boolean |
isHasConflicts()
Indicates if the replica sync has conflicts. |
boolean |
isUseArchiving()
Use archiving instead of versions to track replica changes. |
void |
setAccessType(int rhs1)
Replica access type. |
void |
setAllReplicaDatasetsByRef(IEnumReplicaDataset rhs1)
The replica datasets for this replica. |
void |
setConnectionInfoByRef(IWorkspaceName rhs1)
The connection string for the master geodatabase. |
void |
setDescriptionByRef(IReplicaDescription rhs1)
The replica version description. |
void |
setName(String rhs1)
The name of the replica. |
void |
setOwner(String rhs1)
The master geodatabase login used to create the replica. |
void |
setParentID(int rhs1)
The ID of the replica reference in the master geodatabase. |
void |
setReconcilePolicyType(int rhs1)
Replica reconcile policy. |
void |
setReplicaDatasetsByRef(IEnumReplicaDataset rhs1)
The replica datasets for this replica. |
void |
setReplicaDate(double rhs1)
The date that the data was checked out. |
void |
setReplicaGuid(String rhs1)
The guid of the replica. |
void |
setReplicaID(int rhs1)
The ID of the replica. |
void |
setReplicaRole(int rhs1)
Determines if the workspace is the replica geodatabase or the master geodatabase for the replica. |
void |
setSibConnectionString(String rhs1)
The sib connection string for a replica. |
void |
setSibMyGenNumber(int rhs1)
The generation number that the sibling thinks is my generation number. |
void |
setUseArchiving(boolean useArchiving)
Use archiving instead of versions to track replica changes. |
void |
setVersion(String rhs1)
The name of the replica version. |
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 Replica() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic Replica(Object obj) throws IOException
Replica theReplica = (Replica) obj;
obj
to Replica
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public int getReplicaID() throws IOException, AutomationException
This ReplicaID identifies a check-out in a geodatabase. It is unique only within the geodatabase and not across the master and the check-out geodatabases. For example, the master can have a ReplicaID of 1806 while the check-out geodatabase has a ReplicaID of 1 for the same check-out.
The ParentID property can be used in the check-out geodatabase to find the corresponding ReplicaID in the master geodatabase.
The master geodatabase of a check-out returns -1 for ParentID property. An alternative is to use the ReplicaGuid property, which uniquely identifies the check-out and has the same value in the master and check-out geodatabases.
getReplicaID
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getName() throws IOException, AutomationException
The Name is taken from the string set in the checkoutname parameter of ICheckout::CheckoutData and ICheckout::CheckoutSchema methods.
getName
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getOwner() throws IOException, AutomationException
For two way or one way replicas this property returns the owner of the data in the replica database.
For check-out replicas, if the check-out database is a personal or File geodatabase this property returns a blank string. Otherwise it returns the owner of the checked out data in the check-out geodatabase.
getOwner
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getVersion() throws IOException, AutomationException
For check-out replicas, the name of the version is the same as the name of the checkout; see IReplica::Name. If the check-out database is a personal geodatabase or a File geodatabase, this property is set to the version name on the master geodatabase (parent database).
For two way or one way replicas, this property is set to the version on the replica geodatabase. The child replica will always return the Default version. The parent replica will return the version the replica was created from.
getVersion
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getParentID() throws IOException, AutomationException
Returns the ID of the parent replica. For two way, one way and check-out replicas, this property is only valid for the child replica geodatabase. The parent replica geodatabase returns -1 for this property.
getParentID
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public double getReplicaDate() throws IOException, AutomationException
getReplicaDate
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getReplicaGuid() throws IOException, AutomationException
The ReplicaGuid property uniquely identifies the replica and has the same value in the parent and child replica geodatabases. Unlike the ReplicaID property, it is unique across geodatabases.
getReplicaGuid
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IReplicaDescription getDescription() throws IOException, AutomationException
For check-out replicas this property is only set in the master geodatabase. Nothing is returned for a check-out in a check-out geodatabase.
This property is set on both the parent and child replica geodatabases for two way and one way replicas.
getDescription
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceName getConnectionInfo() throws IOException, AutomationException
For a check-out geodatabase, this property returns a WorkspaceName object for the master geodatabase. This allows you to perform a checkin from the check-out geodatabase without already knowing the connection information for the master. The user name and password are not returned and must be set before connecting.
For master geodatabase, this property returns nothing.
getConnectionInfo
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getReplicaRole() throws IOException, AutomationException
If a geodatabase acts as the master for the Replica, this property returns esriCheckoutTypeParent. If the geodatabase is the check-out geodatabase, esriCheckoutTypeChild is returned. The other enumerations are never returned for valid check-outs.
getReplicaRole
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumReplicaDataset getReplicaDatasets() throws IOException, AutomationException
The ReplicaDataset that is returned can be used to get information about the checked-out datasets.
getReplicaDatasets
in interface IReplica
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMyGenerationNumber() throws IOException, AutomationException
getMyGenerationNumber
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSibGenerationNumber() throws IOException, AutomationException
getSibGenerationNumber
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getSibMyGenNumber() throws IOException, AutomationException
getSibMyGenNumber
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumReplicaLog getLog() throws IOException, AutomationException
getLog
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumReplicaDataset getAllReplicaDatasets() throws IOException, AutomationException
getAllReplicaDatasets
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init2(IGPReplica gPReplica, IWorkspace targetWorkspace) throws IOException, AutomationException
init2
in interface IReplica2
gPReplica
- A reference to a com.esri.arcgis.geodatabase.IGPReplica (in)targetWorkspace
- 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 int getAccessType() throws IOException, AutomationException
getAccessType
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getReconcilePolicyType() throws IOException, AutomationException
getReconcilePolicyType
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasConflicts() throws IOException, AutomationException
isHasConflicts
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getReplicaReceivingVersion() throws IOException, AutomationException
getReplicaReceivingVersion
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getReplicaState() throws IOException, AutomationException
getReplicaState
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getSibConnectionString() throws IOException, AutomationException
getSibConnectionString
in interface IReplica2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isUseArchiving() throws IOException, AutomationException
isUseArchiving
in interface IReplica3
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setUseArchiving(boolean useArchiving) throws IOException, AutomationException
setUseArchiving
in interface IReplica3
useArchiving
- The useArchiving (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReplicaID(int rhs1) throws IOException, AutomationException
setReplicaID
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setName(String rhs1) throws IOException, AutomationException
setName
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOwner(String rhs1) throws IOException, AutomationException
setOwner
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setVersion(String rhs1) throws IOException, AutomationException
setVersion
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setParentID(int rhs1) throws IOException, AutomationException
setParentID
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReplicaDate(double rhs1) throws IOException, AutomationException
setReplicaDate
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReplicaGuid(String rhs1) throws IOException, AutomationException
setReplicaGuid
in interface IReplicaEdit
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDescriptionByRef(IReplicaDescription rhs1) throws IOException, AutomationException
setDescriptionByRef
in interface IReplicaEdit
rhs1
- A reference to a com.esri.arcgis.geodatabase.IReplicaDescription (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setConnectionInfoByRef(IWorkspaceName rhs1) throws IOException, AutomationException
setConnectionInfoByRef
in interface IReplicaEdit
rhs1
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReplicaRole(int rhs1) throws IOException, AutomationException
setReplicaRole
in interface IReplicaEdit
rhs1
- A com.esri.arcgis.geodatabase.esriReplicaType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReplicaDatasetsByRef(IEnumReplicaDataset rhs1) throws IOException, AutomationException
setReplicaDatasetsByRef
in interface IReplicaEdit
rhs1
- A reference to a com.esri.arcgis.geodatabase.IEnumReplicaDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void init(IReplica otherReplica) throws IOException, AutomationException
The Init method allows you to initialize a new check-out based on another check-out. This method along with the IWorkspaceReplicasAdmin::RegisterReplica method can be used to create the meta-data for a new check-out. See the Duplicating Check-outs sample in the ArcObjects help for an example of where this can be used.
init
in interface IReplicaEdit
otherReplica
- A reference to a com.esri.arcgis.geodatabase.IReplica (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSibMyGenNumber(int rhs1) throws IOException, AutomationException
setSibMyGenNumber
in interface IReplicaEdit2
rhs1
- The rhs1 (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAllReplicaDatasetsByRef(IEnumReplicaDataset rhs1) throws IOException, AutomationException
setAllReplicaDatasetsByRef
in interface IReplicaEdit2
rhs1
- A reference to a com.esri.arcgis.geodatabase.IEnumReplicaDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAccessType(int rhs1) throws IOException, AutomationException
setAccessType
in interface IReplicaEdit2
rhs1
- A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReconcilePolicyType(int rhs1) throws IOException, AutomationException
setReconcilePolicyType
in interface IReplicaEdit2
rhs1
- A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSibConnectionString(String rhs1) throws IOException, AutomationException
setSibConnectionString
in interface IReplicaEdit2
rhs1
- The rhs1 (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 |