com.esri.arcgis.datasourcesraster
Class ImportGeometryParameters

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.ImportGeometryParameters
All Implemented Interfaces:
IImportGeometryParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'ImportGeometryParameters'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description 'An object that controls how a mosaic dataset's geometry gets imported.' 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
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMosaicDatasetOperationParameters
IID, IID379006f4_6f75_4c3b_b783_0c2e88a7b280, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.ISelectionParameters
IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IImportGeometryParameters
IID, IIDa63cc4b0_375b_4cf1_96d2_76b8eb882749, xxDummy
 
Constructor Summary
ImportGeometryParameters()
          Constructs a ImportGeometryParameters using ArcGIS Engine.
ImportGeometryParameters(java.lang.Object obj)
          Construct a ImportGeometryParameters using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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.
 java.lang.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.
 java.lang.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 release()
          Release a ImportGeometryParameters.
 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(java.lang.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(java.lang.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
 

Constructor Detail

ImportGeometryParameters

public ImportGeometryParameters()
                         throws java.io.IOException,
                                java.net.UnknownHostException
Constructs a ImportGeometryParameters using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ImportGeometryParameters

public ImportGeometryParameters(java.lang.Object obj)
                         throws java.io.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:
java.io.IOException - if there are interop problems ImportGeometryParameters theImportGeometryParameters = (ImportGeometryParameters) obj;
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 ImportGeometryParameters.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setParametersByRef

public void setParametersByRef(IPropertySet ppAllParameters)
                        throws java.io.IOException,
                               AutomationException
All parameters associated with the mosaic dataset operation.

Specified by:
setParametersByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppAllParameters - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParameters

public IPropertySet getParameters()
                           throws java.io.IOException,
                                  AutomationException
All parameters associated with the mosaic dataset operation.

Specified by:
getParameters in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProgressorByRef

public void setProgressorByRef(IProgressor ppProgressor)
                        throws java.io.IOException,
                               AutomationException
The external progressor object associated with the mosaic dataset operation.

Specified by:
setProgressorByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppProgressor - A reference to a com.esri.arcgis.system.IProgressor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws java.io.IOException,
                                 AutomationException
The external progressor object associated with the mosaic dataset operation.

Specified by:
getProgressor in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IProgressor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsDatasetReadOnly

public void setIsDatasetReadOnly(boolean pbIsDatasetReadOnly)
                          throws java.io.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.

Specified by:
setIsDatasetReadOnly in interface IMosaicDatasetOperationParameters
Parameters:
pbIsDatasetReadOnly - The pbIsDatasetReadOnly (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDatasetReadOnly

public boolean isDatasetReadOnly()
                          throws java.io.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.

Specified by:
isDatasetReadOnly in interface IMosaicDatasetOperationParameters
Returns:
The pbIsDatasetReadOnly
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResultsByRef

public void setResultsByRef(IPropertySet ppOperationResults)
                     throws java.io.IOException,
                            AutomationException
The properties of the result associated with the mosaic dataset operation.

Specified by:
setResultsByRef in interface IMosaicDatasetOperationParameters
Parameters:
ppOperationResults - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResults

public IPropertySet getResults()
                        throws java.io.IOException,
                               AutomationException
The properties of the result associated with the mosaic dataset operation.

Specified by:
getResults in interface IMosaicDatasetOperationParameters
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws java.io.IOException,
                                 AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:
setSelectionSetByRef in interface ISelectionParameters
Parameters:
ppSelectionSet - 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.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws java.io.IOException,
                                     AutomationException
The selection set that identifies the collection of catalog items on which to perform the associated operation.

Specified by:
getSelectionSet in interface ISelectionParameters
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.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppQueryFilter)
                         throws java.io.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.

Specified by:
setQueryFilterByRef in interface ISelectionParameters
Parameters:
ppQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws java.io.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.

Specified by:
getQueryFilter in interface ISelectionParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.IQueryFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTarget

public void setTarget(int pImportTarget)
               throws java.io.IOException,
                      AutomationException
The target feature class of this import operation.

Specified by:
setTarget in interface IImportGeometryParameters
Parameters:
pImportTarget - A com.esri.arcgis.datasourcesraster.esriImportGeometryTarget constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTarget

public int getTarget()
              throws java.io.IOException,
                     AutomationException
The target feature class of this import operation.

Specified by:
getTarget in interface IImportGeometryParameters
Returns:
A com.esri.arcgis.datasourcesraster.esriImportGeometryTarget constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTargetJoinField

public void setTargetJoinField(java.lang.String pTargetJoinField)
                        throws java.io.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.

Specified by:
setTargetJoinField in interface IImportGeometryParameters
Parameters:
pTargetJoinField - The pTargetJoinField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTargetJoinField

public java.lang.String getTargetJoinField()
                                    throws java.io.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.

Specified by:
getTargetJoinField in interface IImportGeometryParameters
Returns:
The pTargetJoinField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceTableByRef

public void setSourceTableByRef(IFeatureClass ppSourceTable)
                         throws java.io.IOException,
                                AutomationException
The source feature class from which geometry is imported.

Specified by:
setSourceTableByRef in interface IImportGeometryParameters
Parameters:
ppSourceTable - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceTable

public IFeatureClass getSourceTable()
                             throws java.io.IOException,
                                    AutomationException
The source feature class from which geometry is imported.

Specified by:
getSourceTable in interface IImportGeometryParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSourceJoinField

public void setSourceJoinField(java.lang.String pSourceJoinField)
                        throws java.io.IOException,
                               AutomationException
The name of the field in the source feature class that participates in the table join.

Specified by:
setSourceJoinField in interface IImportGeometryParameters
Parameters:
pSourceJoinField - The pSourceJoinField (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceJoinField

public java.lang.String getSourceJoinField()
                                    throws java.io.IOException,
                                           AutomationException
The name of the field in the source feature class that participates in the table join.

Specified by:
getSourceJoinField in interface IImportGeometryParameters
Returns:
The pSourceJoinField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.