com.esri.arcgis.datasourcesraster
Class ImportGeometryParameters

java.lang.Object
  com.esri.arcgis.datasourcesraster.ImportGeometryParameters

All Implemented Interfaces:

IImportGeometryParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ImportGeometryParameters
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IMosaicDatasetOperationParameters, ISelectionParameters, IImportGeometryParameters

An object that controls how a mosaic dataset's geometry gets imported.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ImportGeometryParameters()
Constructs a ImportGeometryParameters using ArcGIS Engine.

ImportGeometryParameters(Object obj)
Construct a ImportGeometryParameters using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IPropertySet	getParameters() All parameters associated with the mosaic dataset operation.
IProgressor	getProgressor() The external progressor object associated with the mosaic dataset operation.
IQueryFilter	getQueryFilter() The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
IPropertySet	getResults() The properties of the result associated with the mosaic dataset operation.
ISelectionSet	getSelectionSet() The selection set that identifies the collection of catalog items on which to perform the associated operation.
String	getSourceJoinField() The name of the field in the source feature class that participates in the table join.
IFeatureClass	getSourceTable() The source feature class from which geometry is imported.
int	getTarget() The target feature class of this import operation.
String	getTargetJoinField() The mosaic dataset field name that participates in the table join that attempts to associate a row in the source feature class with every selected row in the target feature class.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setParametersByRef(IPropertySet ppAllParameters) All parameters associated with the mosaic dataset operation.
void	setProgressorByRef(IProgressor ppProgressor) The external progressor object associated with the mosaic dataset operation.
void	setQueryFilterByRef(IQueryFilter ppQueryFilter) The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation.
void	setResultsByRef(IPropertySet ppOperationResults) The properties of the result associated with the mosaic dataset operation.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) The selection set that identifies the collection of catalog items on which to perform the associated operation.
void	setSourceJoinField(String pSourceJoinField) The name of the field in the source feature class that participates in the table join.
void	setSourceTableByRef(IFeatureClass ppSourceTable) The source feature class from which geometry is imported.
void	setTarget(int pImportTarget) The target feature class of this import operation.
void	setTargetJoinField(String pTargetJoinField) The mosaic dataset field name that participates in the table join that attempts to associate a row in the source feature class with every selected row in the target feature class.

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

ImportGeometryParameters

public ImportGeometryParameters()
                         throws IOException,
                                UnknownHostException

Constructs a ImportGeometryParameters using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ImportGeometryParameters

public ImportGeometryParameters(Object obj)
                         throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ImportGeometryParameters theImportGeometryParameters = (ImportGeometryParameters) obj;

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

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws IOException,
                               AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setParametersByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

All parameters associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getParameters in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws IOException,
                               AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setProgressorByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The external progressor object associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getProgressor in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters

Parameters:

pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws IOException,
                                 AutomationException

Indicates whether the mosaic dataset is in read-only mode. Mosaic dataset operations do not perform write operations on a read-only mosaic.

Product Availability

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

Specified by:

isDatasetReadOnly in interface IMosaicDatasetOperationParameters

Returns:

The pbIsDatasetReadOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws IOException,
                            AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

setResultsByRef in interface IMosaicDatasetOperationParameters

Parameters:

ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws IOException,
                               AutomationException

The properties of the result associated with the mosaic dataset operation.

Product Availability

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

Specified by:

getResults in interface IMosaicDatasetOperationParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

setSelectionSetByRef in interface ISelectionParameters

Parameters:

ppSelectionSet - 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.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

The selection set that identifies the collection of catalog items on which to perform the associated operation.

Product Availability

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

Specified by:

getSelectionSet in interface ISelectionParameters

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.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws IOException,
                                AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

setQueryFilterByRef in interface ISelectionParameters

Parameters:

ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException

The query filter applied on the selection set to identify the collection of catalog items on which to perform the associated operation. If no selection is specified, the query filter is applied on the entire catalog.

Product Availability

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

Specified by:

getQueryFilter in interface ISelectionParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTarget

public void setTarget(int pImportTarget)
               throws IOException,
                      AutomationException

The target feature class of this import operation.

Product Availability

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

Specified by:

setTarget in interface IImportGeometryParameters

Parameters:

pImportTarget - A com.esri.arcgis.datasourcesraster.esriImportGeometryTarget constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTarget

public int getTarget()
              throws IOException,
                     AutomationException

The target feature class of this import operation.

Product Availability

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

Specified by:

getTarget in interface IImportGeometryParameters

Returns:

A com.esri.arcgis.datasourcesraster.esriImportGeometryTarget constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetJoinField

public void setTargetJoinField(String pTargetJoinField)
                        throws IOException,
                               AutomationException

The mosaic dataset field name that participates in the table join that attempts to associate a row in the source feature class with every selected row in the target feature class.

Product Availability

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

Specified by:

setTargetJoinField in interface IImportGeometryParameters

Parameters:

pTargetJoinField - The pTargetJoinField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetJoinField

public String getTargetJoinField()
                          throws IOException,
                                 AutomationException

The mosaic dataset field name that participates in the table join that attempts to associate a row in the source feature class with every selected row in the target feature class.

Product Availability

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

Specified by:

getTargetJoinField in interface IImportGeometryParameters

Returns:

The pTargetJoinField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTableByRef

public void setSourceTableByRef(IFeatureClass ppSourceTable)
                         throws IOException,
                                AutomationException

The source feature class from which geometry is imported.

Product Availability

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

Specified by:

setSourceTableByRef in interface IImportGeometryParameters

Parameters:

ppSourceTable - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTable

public IFeatureClass getSourceTable()
                             throws IOException,
                                    AutomationException

The source feature class from which geometry is imported.

Product Availability

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

Specified by:

getSourceTable in interface IImportGeometryParameters

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceJoinField

public void setSourceJoinField(String pSourceJoinField)
                        throws IOException,
                               AutomationException

The name of the field in the source feature class that participates in the table join.

Product Availability

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

Specified by:

setSourceJoinField in interface IImportGeometryParameters

Parameters:

pSourceJoinField - The pSourceJoinField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceJoinField

public String getSourceJoinField()
                          throws IOException,
                                 AutomationException

The name of the field in the source feature class that participates in the table join.

Product Availability

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

Specified by:

getSourceJoinField in interface IImportGeometryParameters

Returns:

The pSourceJoinField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.