com.esri.arcgis.geodatabase
Class ReplicaDescription

java.lang.Object
  com.esri.arcgis.geodatabase.ReplicaDescription

All Implemented Interfaces:

IReplicaDescription, IReplicaDescription2, IReplicaDescription3, IReplicaDescription4, IReplicaDescriptionExtensionManager, IReplicaFilterDescription, IReplicaFilterDescription2, IReplicaFilterDescriptionEdit, IXMLReplicaDescription, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, Externalizable, Serializable

public class ReplicaDescription
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IReplicaDescription, IReplicaFilterDescription, IReplicaFilterDescription2, IReplicaDescription2, IReplicaDescription3, IReplicaDescription4, IXMLReplicaDescription, IReplicaFilterDescriptionEdit, IReplicaDescriptionExtensionManager, IDocumentVersionSupportGEN, Externalizable

Defines the datasets in a replica.

Remarks

This coclass is used to define the data to be checked out or extracted. It can also be returned from existing check-outs and used to determine the conditions applied on check out.

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

ReplicaDescription()
Constructs a ReplicaDescription using ArcGIS Engine.

ReplicaDescription(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ReplicaDescription theReplicaDescription = (ReplicaDescription) obj;

Method Summary

void	addDatasetNames(IEnumName datasetNames) Adding dataset names to the existing list of replica description dataset names.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
int	findExtension(IUID pGUID) Finds the specified description extension by its globally unique id.
IRelationshipClassInfo	findRelationshipClassInfo(IRelationshipClassName rCName) Gets the relationship class description.
IRelationshipClassInfo	findRelationshipClassInfoByName(String name, String database, String owner) Gets the relationship class description.
int	findTable(IName datasetName) Gets the index number of a dataset.
int	findTable2(String name, String database, String owner, int type) Gets the index number of a dataset.
int	getAccessType() Gets the Replica access type.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IEnumName	getDatasetNames() A list of dataset names to include in a replica.
IReplicaDescriptionExtension	getExtension(int index) The replica description extension at this index.
int	getExtensionCount() The number of replica description extensions.
IGeometry	getGeometry() The geometry used to determine which features to extract or check out.
String	getOutputXMLFile() The name of the output XML file.
IEnumRelationshipClassInfo	getRelationshipClassesInfo() An enumeration that describes settings for each relationship class in the replica.
IEnumNameMapping	getReplicaEnumNameMapping() Set the replicated object target name.
int	getReplicaModelType() Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.
int	getRowsType(int index) Replica row type options.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSpatialRelation() The spatial operator used for a replica.
String	getTableDefQuery(int index) The definition query to use when checking out a dataset.
IName	getTableName(int index) The name of a dataset to check out.
int	getTableNameCount() The number of table type objects that will be checked out.
ISelectionSet	getTableSelection(int index) The selection set to use when checking out a dataset.
IFIDSet	getTableSelectionIDs(int index) The ID's of the rows and features that are replicated when a selection set id ussd.
int	hashCode() the hashcode for this object
void	init(IEnumName enumNames, IWorkspaceName outputWSName, boolean reuseSchema, int deType) Defines the datasets to replica or extract and the output geodatabase.
void	init2(IEnumName enumNames, String outputXMLFile, boolean binaryGeometry, boolean compressed, int deType) Provides access to members that define the datasets to check-out or extract to am XML file.
boolean	isBinaryGeometry() Indicates if the geometry coordinates are stored in binary
boolean	isCompressed() indicates of the output XML file is to be compressed.
void	isDirty() isDirty
boolean	isFetchRelatedObjects() Indicates if related objects have been replicated or not.
boolean	isPrivateTable(int index) Indicates if a dataset is private or not.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
boolean	isTableExcluded(int index) Indicates if a table is to be excluded from a replica.
boolean	isTableUsesDefQuery(int index) Indicates if a definition query will be used when checking out a dataset.
boolean	isTableUsesQueryGeometry(int index) Indicates if a spatial extent will be used when checking out a dataset.
boolean	isTableUsesSelection(int index) Indicates if a selection will be used when checking out a dataset.
boolean	isUseArchiving() Gets the Replica UseArchiving Option.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	registerExtension(IReplicaDescriptionExtension rdExtension) Registers this description extension.
void	save(IStream pstm, int fClearDirty) save
void	setAccessType(int accessType) Gets the Replica access type.
void	setGeometryByRef(IGeometry rhs1) The geometry used to determine which features to extract or check out.
void	setIsPrivateTable(int index, boolean isPrivate) Indicates if a dataset is private or not.
void	setReplicaModelType(int modelType) Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.
void	setRowsType(int index, int rhs2) Replica row type options.
void	setSpatialRelation(int rhs1) The spatial operator used for a replica.
void	setTableDefQuery(int index, String rhs2) The definition query to use when checking out a dataset.
void	setTableExcluded(int index, boolean exclude) Indicates if a table is to be excluded from a replica.
void	setTableSelectionByRef(int index, ISelectionSet rhs2) The selection set to use when checking out a dataset.
void	setTableUsesDefQuery(int index, boolean rhs2) Indicates if a definition query will be used when checking out a dataset.
void	setTableUsesQueryGeometry(int index, boolean rhs2) Indicates if a spatial extent will be used when checking out a dataset.
void	setTableUsesSelection(int index, boolean rhs2) Indicates if a selection will be used when checking out a dataset.
void	setUseArchiving(boolean useArchiving) Gets the Replica UseArchiving Option.
void	unRegisterExtension(IUID pGUID) UnRegisters this replica description.
void	writeExternal(ObjectOutput out)

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

ReplicaDescription

public ReplicaDescription()
                   throws IOException,
                          UnknownHostException

Constructs a ReplicaDescription using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ReplicaDescription

public ReplicaDescription(Object obj)
                   throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ReplicaDescription theReplicaDescription = (ReplicaDescription) obj;

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

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

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(IEnumName enumNames,
                 IWorkspaceName outputWSName,
                 boolean reuseSchema,
                 int deType)
          throws IOException,
                 AutomationException

Defines the datasets to replica or extract and the output geodatabase.

Remarks

When defining a ReplicaDescription object to use in a check out or a data extraction, this method must be called before using any of the other properties and methods.

The Init method expands the enumNames list to include related datasets that may not already be in the enumNames list. For example, if the enumNames list includes a FeatureClass involved in a RelationshipClass, the Init method adds the related table to the check-out. This is done to maintain the integrity of the geodatabase. The FindTable method and the TableNameCount, TableName and TableExcluded properties apply to the expanded enumNames list.

The expanded list only contains objects that implement ITableName such as FeatureClasses, Tables and AttributedRelationshipClasses. Objects such as GeometricNetworks and FeatureDatasets are included in the checkout, but are not returned from this list. The properties of the objects returned can be used to get these objects if needed.

For the current release, all esriDataExtraction types are valid except esriDataReplication for the detype parameter. The OutputWSName parameter must be a workspacename for a personal or ArcSDE geodatabase.

Set ReuseSchema to True if you intend to check out or extract data to a workspace that already has a schema to match the data to be checked out or extracted.

To add a FeatureClass from a FeatureDataset, you must first add the FeatureDataset to the enumNames and call Init. This expands the description to include all FeatureClasses from the FeatureDataset. You can then set the IReplicaDescripion::TableExcluded property to false for any feature classes that you don't want to inlcluce in the check-out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IReplicaDescription

Parameters:

enumNames - A reference to a com.esri.arcgis.system.IEnumName (in)

outputWSName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

reuseSchema - The reuseSchema (in)

deType - A com.esri.arcgis.geodatabase.esriDataExtractionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumName getDatasetNames()
                          throws IOException,
                                 AutomationException

A list of dataset names to include in a replica.

Remarks

This enumeration is the unexpanded enumNames enumeration that was passed into the Init method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDatasetNames in interface IReplicaDescription

Returns:

A reference to a com.esri.arcgis.system.IEnumName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableNameCount

public int getTableNameCount()
                      throws IOException,
                             AutomationException

The number of table type objects that will be checked out.

Remarks

This value returned may be different from the number of datasets passed into the Init method. This is because the Init method expands the list of datasets to ensure database integrity.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTableNameCount in interface IReplicaDescription

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableName

public IName getTableName(int index)
                   throws IOException,
                          AutomationException

The name of a dataset to check out.

Product Availability

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

Specified by:

getTableName in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableExcluded

public void setTableExcluded(int index,
                             boolean exclude)
                      throws IOException,
                             AutomationException

Indicates if a table is to be excluded from a replica.

Product Availability

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

Specified by:

setTableExcluded in interface IReplicaDescription

Parameters:

index - The index (in)

exclude - The exclude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableExcluded

public boolean isTableExcluded(int index)
                        throws IOException,
                               AutomationException

Indicates if a table is to be excluded from a replica.

Product Availability

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

Specified by:

isTableExcluded in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

The exclude

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaModelType

public void setReplicaModelType(int modelType)
                         throws IOException,
                                AutomationException

Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReplicaModelType in interface IReplicaDescription

Parameters:

modelType - A com.esri.arcgis.geodatabase.esriReplicaModelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaModelType

public int getReplicaModelType()
                        throws IOException,
                               AutomationException

Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.

Remarks

The ReplicaModelType property defines whether to output the data as simple datasets (esriModelTypeSimple) or as they are defined in the master geodatabase (esriModelTypeFullGeodatabase).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getReplicaModelType in interface IReplicaDescription

Returns:

A com.esri.arcgis.geodatabase.esriReplicaModelType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTable

public int findTable(IName datasetName)
              throws IOException,
                     AutomationException

Gets the index number of a dataset.

Remarks

This property may return indexes for Name objects that were not passed into the Init method. This is because the Init method expands the list of datasets to ensure database integrity. The index returned can be used with the TableName property to get name object back from the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findTable in interface IReplicaDescription

Parameters:

datasetName - A reference to a com.esri.arcgis.system.IName (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDatasetNames

public void addDatasetNames(IEnumName datasetNames)
                     throws IOException,
                            AutomationException

Adding dataset names to the existing list of replica description dataset names.

Remarks

The AddDatasetNames method can be used to add dataset names to the replica description after the init method has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addDatasetNames in interface IReplicaDescription

Parameters:

datasetNames - A reference to a com.esri.arcgis.system.IEnumName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateTable

public void setIsPrivateTable(int index,
                              boolean isPrivate)
                       throws IOException,
                              AutomationException

Indicates if a dataset is private or not.

Product Availability

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

Specified by:

setIsPrivateTable in interface IReplicaDescription

Parameters:

index - The index (in)

isPrivate - The isPrivate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivateTable

public boolean isPrivateTable(int index)
                       throws IOException,
                              AutomationException

Indicates if a dataset is private or not.

Product Availability

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

Specified by:

isPrivateTable in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

The isPrivate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws IOException,
                             AutomationException

The geometry used to determine which features to extract or check out.

Remarks

This property returns the shape that is used to determine which features are to be checked out. The SpatialRelation property returns how this shape is applied as a filter. For example, if the Geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

If a geometry is not used for the check-out, nothing is returned.

By default, the geometry is applied to all datasets in the replica description during a check out or extraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGeometry in interface IReplicaFilterDescription

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelation

public int getSpatialRelation()
                       throws IOException,
                              AutomationException

The spatial operator used for a replica.

Remarks

This property defines how the shape returned by the Geometry property is applied during check out. For example, if the geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialRelation in interface IReplicaFilterDescription

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesQueryGeometry

public boolean isTableUsesQueryGeometry(int index)
                                 throws IOException,
                                        AutomationException

Indicates if a spatial extent will be used when checking out a dataset.

Product Availability

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

Specified by:

isTableUsesQueryGeometry in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesSelection

public boolean isTableUsesSelection(int index)
                             throws IOException,
                                    AutomationException

Indicates if a selection will be used when checking out a dataset.

Product Availability

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

Specified by:

isTableUsesSelection in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesDefQuery

public boolean isTableUsesDefQuery(int index)
                            throws IOException,
                                   AutomationException

Indicates if a definition query will be used when checking out a dataset.

Product Availability

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

Specified by:

isTableUsesDefQuery in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useDefinition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableSelection

public ISelectionSet getTableSelection(int index)
                                throws IOException,
                                       AutomationException

The selection set to use when checking out a dataset.

Product Availability

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

Specified by:

getTableSelection in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableDefQuery

public String getTableDefQuery(int index)
                        throws IOException,
                               AutomationException

The definition query to use when checking out a dataset.

Product Availability

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

Specified by:

getTableDefQuery in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The defQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowsType

public int getRowsType(int index)
                throws IOException,
                       AutomationException

Replica row type options.

Product Availability

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

Specified by:

getRowsType in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geodatabase.esriRowsType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableSelectionIDs

public IFIDSet getTableSelectionIDs(int index)
                             throws IOException,
                                    AutomationException

The ID's of the rows and features that are replicated when a selection set id ussd.

Product Availability

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

Specified by:

getTableSelectionIDs in interface IReplicaFilterDescription2

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFetchRelatedObjects

public boolean isFetchRelatedObjects()
                              throws IOException,
                                     AutomationException

Indicates if related objects have been replicated or not.

Product Availability

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

Specified by:

isFetchRelatedObjects in interface IReplicaDescription2

Returns:

The getRelatedObjects

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTable2

public int findTable2(String name,
                      String database,
                      String owner,
                      int type)
               throws IOException,
                      AutomationException

Gets the index number of a dataset.

Product Availability

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

Specified by:

findTable2 in interface IReplicaDescription2

Parameters:

name - The name (in)

database - The database (in)

owner - The owner (in)

type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRelationshipClassInfoByName

public IRelationshipClassInfo findRelationshipClassInfoByName(String name,
                                                              String database,
                                                              String owner)
                                                       throws IOException,
                                                              AutomationException

Gets the relationship class description.

Product Availability

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

Specified by:

findRelationshipClassInfoByName in interface IReplicaDescription2

Parameters:

name - The name (in)

database - The database (in)

owner - The owner (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRelationshipClassInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRelationshipClassInfo

public IRelationshipClassInfo findRelationshipClassInfo(IRelationshipClassName rCName)
                                                 throws IOException,
                                                        AutomationException

Gets the relationship class description.

Product Availability

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

Specified by:

findRelationshipClassInfo in interface IReplicaDescription2

Parameters:

rCName - A reference to a com.esri.arcgis.geodatabase.IRelationshipClassName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRelationshipClassInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassesInfo

public IEnumRelationshipClassInfo getRelationshipClassesInfo()
                                                      throws IOException,
                                                             AutomationException

An enumeration that describes settings for each relationship class in the replica.

Product Availability

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

Specified by:

getRelationshipClassesInfo in interface IReplicaDescription2

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumRelationshipClassInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessType

public void setAccessType(int accessType)
                   throws IOException,
                          AutomationException

Gets the Replica access type.

Product Availability

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

Specified by:

setAccessType in interface IReplicaDescription3

Parameters:

accessType - A com.esri.arcgis.geodatabase.esriReplicaAccessType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccessType

public int getAccessType()
                  throws IOException,
                         AutomationException

Gets the Replica access type.

Product Availability

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

Specified by:

getAccessType in interface IReplicaDescription3

Returns:

A com.esri.arcgis.geodatabase.esriReplicaAccessType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseArchiving

public void setUseArchiving(boolean useArchiving)
                     throws IOException,
                            AutomationException

Gets the Replica UseArchiving Option.

Product Availability

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

Specified by:

setUseArchiving in interface IReplicaDescription4

Parameters:

useArchiving - The useArchiving (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseArchiving

public boolean isUseArchiving()
                       throws IOException,
                              AutomationException

Gets the Replica UseArchiving Option.

Product Availability

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

Specified by:

isUseArchiving in interface IReplicaDescription4

Returns:

The useArchiving

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaEnumNameMapping

public IEnumNameMapping getReplicaEnumNameMapping()
                                           throws IOException,
                                                  AutomationException

Set the replicated object target name.

Product Availability

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

Specified by:

getReplicaEnumNameMapping in interface IReplicaDescription4

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumNameMapping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init2

public void init2(IEnumName enumNames,
                  String outputXMLFile,
                  boolean binaryGeometry,
                  boolean compressed,
                  int deType)
           throws IOException,
                  AutomationException

Provides access to members that define the datasets to check-out or extract to am XML file.

Product Availability

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

Specified by:

init2 in interface IXMLReplicaDescription

Parameters:

enumNames - A reference to a com.esri.arcgis.system.IEnumName (in)

outputXMLFile - The outputXMLFile (in)

binaryGeometry - The binaryGeometry (in)

compressed - The compressed (in)

deType - A com.esri.arcgis.geodatabase.esriDataExtractionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputXMLFile

public String getOutputXMLFile()
                        throws IOException,
                               AutomationException

The name of the output XML file.

Product Availability

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

Specified by:

getOutputXMLFile in interface IXMLReplicaDescription

Returns:

The outputXMLFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBinaryGeometry

public boolean isBinaryGeometry()
                         throws IOException,
                                AutomationException

Indicates if the geometry coordinates are stored in binary

Product Availability

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

Specified by:

isBinaryGeometry in interface IXMLReplicaDescription

Returns:

The binaryGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCompressed

public boolean isCompressed()
                     throws IOException,
                            AutomationException

indicates of the output XML file is to be compressed.

Product Availability

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

Specified by:

isCompressed in interface IXMLReplicaDescription

Returns:

The compressed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry rhs1)
                      throws IOException,
                             AutomationException

The geometry used to determine which features to extract or check out.

Remarks

Set this property if you want to add an association with the specified shape to determine the features to check out or extract. The association is defined by the SpatialRelation property. For example, if the Geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

The SpatialReference of the geometry is significant. Data from the check-out feature classes gets projected into this spatial reference when the geometry association is applied. If the spatial reference of the geometry is not set, the features you expect to get checked out or extracted may not be included.

By default, the geometry is applied to all datasets in the replica description during a check out or extraction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometryByRef in interface IReplicaFilterDescriptionEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelation

public void setSpatialRelation(int rhs1)
                        throws IOException,
                               AutomationException

The spatial operator used for a replica.

Remarks

This property defines how the shape set for the Geometry property is applied during check out. For example, if the geometry is a polygon and the SpatialRelation is esriSpatialRelIntersects, any features that intersect the polygon are checked out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSpatialRelation in interface IReplicaFilterDescriptionEdit

Parameters:

rhs1 - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesQueryGeometry

public void setTableUsesQueryGeometry(int index,
                                      boolean rhs2)
                               throws IOException,
                                      AutomationException

Indicates if a spatial extent will be used when checking out a dataset.

Product Availability

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

Specified by:

setTableUsesQueryGeometry in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesSelection

public void setTableUsesSelection(int index,
                                  boolean rhs2)
                           throws IOException,
                                  AutomationException

Indicates if a selection will be used when checking out a dataset.

Product Availability

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

Specified by:

setTableUsesSelection in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesDefQuery

public void setTableUsesDefQuery(int index,
                                 boolean rhs2)
                          throws IOException,
                                 AutomationException

Indicates if a definition query will be used when checking out a dataset.

Product Availability

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

Specified by:

setTableUsesDefQuery in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableSelectionByRef

public void setTableSelectionByRef(int index,
                                   ISelectionSet rhs2)
                            throws IOException,
                                   AutomationException

The selection set to use when checking out a dataset.

Remarks

This property allows you to set a SelectionSet as a filter.

The IReplicaDescription::FindTable method can be used to return the index of a specific dataset. The IReplicaDescription::TableName and IReplicaDescription::TableNameCount properties can be used to cycle through all checked out datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTableSelectionByRef in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableDefQuery

public void setTableDefQuery(int index,
                             String rhs2)
                      throws IOException,
                             AutomationException

The definition query to use when checking out a dataset.

Product Availability

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

Specified by:

setTableDefQuery in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRowsType

public void setRowsType(int index,
                        int rhs2)
                 throws IOException,
                        AutomationException

Replica row type options.

Product Availability

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

Specified by:

setRowsType in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - A com.esri.arcgis.geodatabase.esriRowsType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtension

public int findExtension(IUID pGUID)
                  throws IOException,
                         AutomationException

Finds the specified description extension by its globally unique id.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findExtension in interface IReplicaDescriptionExtensionManager

Parameters:

pGUID - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws IOException,
                             AutomationException

The number of replica description extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtensionCount in interface IReplicaDescriptionExtensionManager

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public IReplicaDescriptionExtension getExtension(int index)
                                          throws IOException,
                                                 AutomationException

The replica description extension at this index.

Product Availability

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

Specified by:

getExtension in interface IReplicaDescriptionExtensionManager

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IReplicaDescriptionExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerExtension

public void registerExtension(IReplicaDescriptionExtension rdExtension)
                       throws IOException,
                              AutomationException

Registers this description extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

registerExtension in interface IReplicaDescriptionExtensionManager

Parameters:

rdExtension - A reference to a com.esri.arcgis.geodatabase.IReplicaDescriptionExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unRegisterExtension

public void unRegisterExtension(IUID pGUID)
                         throws IOException,
                                AutomationException

UnRegisters this replica description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

unRegisterExtension in interface IReplicaDescriptionExtensionManager

Parameters:

pGUID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException