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, java.io.Externalizable, java.io.Serializable

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

COM Class 'ReplicaDescription'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'Defines the datasets in a replica.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaFilterDescription2

IID, IID40f7cb0d_c8a1_413e_9112_c7862db1bee1, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaFilterDescription

IIDf0455780_be29_46e4_a25a_459dcaff6276

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaDescription4

IID, IIDcd9668c2_d755_44fd_97f6_b1649e1c3f6e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaDescription3

IIDb9cfadea_b314_419a_841d_517c6be19e3d

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaDescription2

IIDaa08b5ac_b67e_4e8b_9154_891c3cffcbce

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaDescription

IID3afc1997_7a42_483b_9a6a_ecc00a3ba86a

Fields inherited from interface com.esri.arcgis.geodatabase.IXMLReplicaDescription

IID, IIDd14bb518_5768_4b2e_995d_69190ef369ed, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaFilterDescriptionEdit

IID, IID50befd5a_3978_470f_b6db_15916162c15c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IReplicaDescriptionExtensionManager

IID, IID3f980b98_eb3d_4a29_82ae_a2475701048d, xxDummy

Constructor Summary

ReplicaDescription()
Constructs a ReplicaDescription using ArcGIS Engine.

ReplicaDescription(java.lang.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.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.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(java.lang.String name, java.lang.String database, java.lang.String owner) Gets the relationship class description.
int	findTable(IName datasetName) Gets the index number of a dataset.
int	findTable2(java.lang.String name, java.lang.String database, java.lang.String owner, int type) Gets the index number of a dataset.
int	getAccessType() Gets the Replica access type.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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.
java.lang.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, java.lang.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(java.io.ObjectInput in)
void	registerExtension(IReplicaDescriptionExtension rdExtension) Registers this description extension.
void	release() Release a ReplicaDescription.
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, java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ReplicaDescription

public ReplicaDescription()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a ReplicaDescription using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ReplicaDescription

public ReplicaDescription(java.lang.Object obj)
                   throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ReplicaDescription.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.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 java.io.IOException,
                 AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumName getDatasetNames()
                          throws java.io.IOException,
                                 AutomationException

A list of dataset names to include in a replica.

Specified by:

getDatasetNames in interface IReplicaDescription

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableNameCount

public int getTableNameCount()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

getTableNameCount in interface IReplicaDescription

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableName

public IName getTableName(int index)
                   throws java.io.IOException,
                          AutomationException

The name of a dataset to check out.

Specified by:

getTableName in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableExcluded

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

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

Specified by:

setTableExcluded in interface IReplicaDescription

Parameters:

index - The index (in)

exclude - The exclude (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableExcluded

public boolean isTableExcluded(int index)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

isTableExcluded in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

The exclude

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReplicaModelType

public void setReplicaModelType(int modelType)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setReplicaModelType in interface IReplicaDescription

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaModelType

public int getReplicaModelType()
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

getReplicaModelType in interface IReplicaDescription

Returns:

A com.esri.arcgis.geodatabase.esriReplicaModelType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTable

public int findTable(IName datasetName)
              throws java.io.IOException,
                     AutomationException

Gets the index number of a dataset.

Specified by:

findTable in interface IReplicaDescription

Parameters:

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

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDatasetNames

public void addDatasetNames(IEnumName datasetNames)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

addDatasetNames in interface IReplicaDescription

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsPrivateTable

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

Indicates if a dataset is private or not.

Specified by:

setIsPrivateTable in interface IReplicaDescription

Parameters:

index - The index (in)

isPrivate - The isPrivate (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPrivateTable

public boolean isPrivateTable(int index)
                       throws java.io.IOException,
                              AutomationException

Indicates if a dataset is private or not.

Specified by:

isPrivateTable in interface IReplicaDescription

Parameters:

index - The index (in)

Returns:

The isPrivate

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

getGeometry in interface IReplicaFilterDescription

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelation

public int getSpatialRelation()
                       throws java.io.IOException,
                              AutomationException

The spatial operator used for a replica.

Specified by:

getSpatialRelation in interface IReplicaFilterDescription

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesQueryGeometry

public boolean isTableUsesQueryGeometry(int index)
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:

isTableUsesQueryGeometry in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesSelection

public boolean isTableUsesSelection(int index)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

isTableUsesSelection in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useSelection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTableUsesDefQuery

public boolean isTableUsesDefQuery(int index)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

isTableUsesDefQuery in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The useDefinition

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableSelection

public ISelectionSet getTableSelection(int index)
                                throws java.io.IOException,
                                       AutomationException

The selection set to use when checking out a dataset.

Specified by:

getTableSelection in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableDefQuery

public java.lang.String getTableDefQuery(int index)
                                  throws java.io.IOException,
                                         AutomationException

The definition query to use when checking out a dataset.

Specified by:

getTableDefQuery in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

The defQuery

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRowsType

public int getRowsType(int index)
                throws java.io.IOException,
                       AutomationException

Replica row type options.

Specified by:

getRowsType in interface IReplicaFilterDescription

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.geodatabase.esriRowsType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableSelectionIDs

public IFIDSet getTableSelectionIDs(int index)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

getTableSelectionIDs in interface IReplicaFilterDescription2

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFetchRelatedObjects

public boolean isFetchRelatedObjects()
                              throws java.io.IOException,
                                     AutomationException

Indicates if related objects have been replicated or not.

Specified by:

isFetchRelatedObjects in interface IReplicaDescription2

Returns:

The getRelatedObjects

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findTable2

public int findTable2(java.lang.String name,
                      java.lang.String database,
                      java.lang.String owner,
                      int type)
               throws java.io.IOException,
                      AutomationException

Gets the index number of a dataset.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRelationshipClassInfoByName

public IRelationshipClassInfo findRelationshipClassInfoByName(java.lang.String name,
                                                              java.lang.String database,
                                                              java.lang.String owner)
                                                       throws java.io.IOException,
                                                              AutomationException

Gets the relationship class description.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRelationshipClassInfo

public IRelationshipClassInfo findRelationshipClassInfo(IRelationshipClassName rCName)
                                                 throws java.io.IOException,
                                                        AutomationException

Gets the relationship class description.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassesInfo

public IEnumRelationshipClassInfo getRelationshipClassesInfo()
                                                      throws java.io.IOException,
                                                             AutomationException

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

Specified by:

getRelationshipClassesInfo in interface IReplicaDescription2

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAccessType

public void setAccessType(int accessType)
                   throws java.io.IOException,
                          AutomationException

Gets the Replica access type.

Specified by:

setAccessType in interface IReplicaDescription3

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAccessType

public int getAccessType()
                  throws java.io.IOException,
                         AutomationException

Gets the Replica access type.

Specified by:

getAccessType in interface IReplicaDescription3

Returns:

A com.esri.arcgis.geodatabase.esriReplicaAccessType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseArchiving

public void setUseArchiving(boolean useArchiving)
                     throws java.io.IOException,
                            AutomationException

Gets the Replica UseArchiving Option.

Specified by:

setUseArchiving in interface IReplicaDescription4

Parameters:

useArchiving - The useArchiving (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseArchiving

public boolean isUseArchiving()
                       throws java.io.IOException,
                              AutomationException

Gets the Replica UseArchiving Option.

Specified by:

isUseArchiving in interface IReplicaDescription4

Returns:

The useArchiving

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReplicaEnumNameMapping

public IEnumNameMapping getReplicaEnumNameMapping()
                                           throws java.io.IOException,
                                                  AutomationException

Set the replicated object target name.

Specified by:

getReplicaEnumNameMapping in interface IReplicaDescription4

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init2

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputXMLFile

public java.lang.String getOutputXMLFile()
                                  throws java.io.IOException,
                                         AutomationException

The name of the output XML file.

Specified by:

getOutputXMLFile in interface IXMLReplicaDescription

Returns:

The outputXMLFile

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBinaryGeometry

public boolean isBinaryGeometry()
                         throws java.io.IOException,
                                AutomationException

Indicates if the geometry coordinates are stored in binary

Specified by:

isBinaryGeometry in interface IXMLReplicaDescription

Returns:

The binaryGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCompressed

public boolean isCompressed()
                     throws java.io.IOException,
                            AutomationException

indicates of the output XML file is to be compressed.

Specified by:

isCompressed in interface IXMLReplicaDescription

Returns:

The compressed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry rhs1)
                      throws java.io.IOException,
                             AutomationException

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

Specified by:

setGeometryByRef in interface IReplicaFilterDescriptionEdit

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelation

public void setSpatialRelation(int rhs1)
                        throws java.io.IOException,
                               AutomationException

The spatial operator used for a replica.

Specified by:

setSpatialRelation in interface IReplicaFilterDescriptionEdit

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesQueryGeometry

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

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

Specified by:

setTableUsesQueryGeometry in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesSelection

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

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

Specified by:

setTableUsesSelection in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableUsesDefQuery

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

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

Specified by:

setTableUsesDefQuery in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableSelectionByRef

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

The selection set to use when checking out a dataset.

Specified by:

setTableSelectionByRef in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableDefQuery

public void setTableDefQuery(int index,
                             java.lang.String rhs2)
                      throws java.io.IOException,
                             AutomationException

The definition query to use when checking out a dataset.

Specified by:

setTableDefQuery in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRowsType

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

Replica row type options.

Specified by:

setRowsType in interface IReplicaFilterDescriptionEdit

Parameters:

index - The index (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findExtension

public int findExtension(IUID pGuid)
                  throws java.io.IOException,
                         AutomationException

Finds the specified description extension by its globally unique id.

Specified by:

findExtension in interface IReplicaDescriptionExtensionManager

Parameters:

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

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException

The number of replica description extensions.

Specified by:

getExtensionCount in interface IReplicaDescriptionExtensionManager

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public IReplicaDescriptionExtension getExtension(int index)
                                          throws java.io.IOException,
                                                 AutomationException

The replica description extension at this index.

Specified by:

getExtension in interface IReplicaDescriptionExtensionManager

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

registerExtension

public void registerExtension(IReplicaDescriptionExtension rdExtension)
                       throws java.io.IOException,
                              AutomationException

Registers this description extension.

Specified by:

registerExtension in interface IReplicaDescriptionExtensionManager

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unRegisterExtension

public void unRegisterExtension(IUID pGuid)
                         throws java.io.IOException,
                                AutomationException

UnRegisters this replica description.

Specified by:

unRegisterExtension in interface IReplicaDescriptionExtensionManager

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException