com.esri.arcgis.datasourcesraster
Class ComputePixelAlignmentParameters

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

All Implemented Interfaces:

IComputePixelAlignmentParameters, IMosaicDatasetOperationParameters, ISelectionParameters, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

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

Description 'An object that controls how pixel alignment of mosaic dataset items is computed.' 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.IComputePixelAlignmentParameters

IID, IID4e0e5ba2_1e95_428f_95d5_693d62beb036, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISelectionParameters

IID, IID95627b93_1275_4714_94a7_a55df27e70a2, xxDummy

Constructor Summary

ComputePixelAlignmentParameters()
Constructs a ComputePixelAlignmentParameters using ArcGIS Engine.

ComputePixelAlignmentParameters(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ComputePixelAlignmentParameters theComputePixelAlignmentParameters = (ComputePixelAlignmentParameters) obj;

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.
IPoint	getMaximumCellSize() The optional upper limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment.
IPoint	getMinimumCellSize() The optional lower limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment.
IPoint	getOrigin() The optional origin against which pixel alignment of eligible items is computed.
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.
int	hashCode() the hashcode for this object
boolean	isDatasetReadOnly() Indicates whether the mosaic dataset is in read-only mode.
void	release() Release a ComputePixelAlignmentParameters.
void	setIsDatasetReadOnly(boolean pbIsDatasetReadOnly) Indicates whether the mosaic dataset is in read-only mode.
void	setMaximumCellSizeByRef(IPoint ppMaximumCellSize) The optional upper limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment.
void	setMinimumCellSizeByRef(IPoint ppMinimumCellSize) The optional lower limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment.
void	setOriginByRef(IPoint ppOrigin) The optional origin against which pixel alignment of eligible items is computed.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComputePixelAlignmentParameters

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

Constructs a ComputePixelAlignmentParameters using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ComputePixelAlignmentParameters

public ComputePixelAlignmentParameters(java.lang.Object obj)
                                throws java.io.IOException

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

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

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

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.

setMinimumCellSizeByRef

public void setMinimumCellSizeByRef(IPoint ppMinimumCellSize)
                             throws java.io.IOException,
                                    AutomationException

The optional lower limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment. For a selected item to be eligible, it must be visible between MinimumCellSize and MaximumCellSize and it's cell size must also lie within ?G?^??

Specified by:

setMinimumCellSizeByRef in interface IComputePixelAlignmentParameters

Parameters:

ppMinimumCellSize - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinimumCellSize

public IPoint getMinimumCellSize()
                          throws java.io.IOException,
                                 AutomationException

The optional lower limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment. For a selected item to be eligible, it must be visible between MinimumCellSize and MaximumCellSize and it's cell size must also lie within ?G?^??

Specified by:

getMinimumCellSize in interface IComputePixelAlignmentParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumCellSizeByRef

public void setMaximumCellSizeByRef(IPoint ppMaximumCellSize)
                             throws java.io.IOException,
                                    AutomationException

The optional upper limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment. For a selected item to be eligible, it must be visible between MinimumCellSize and MaximumCellSize and it's cell size must also lie within ?G?^??

Specified by:

setMaximumCellSizeByRef in interface IComputePixelAlignmentParameters

Parameters:

ppMaximumCellSize - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumCellSize

public IPoint getMaximumCellSize()
                          throws java.io.IOException,
                                 AutomationException

The optional upper limit of the visibility of candidate items allowed to participate in the analysis of pixel alignment. For a selected item to be eligible, it must be visible between MinimumCellSize and MaximumCellSize and it's cell size must also lie within ?G?^??

Specified by:

getMaximumCellSize in interface IComputePixelAlignmentParameters

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOriginByRef

public void setOriginByRef(IPoint ppOrigin)
                    throws java.io.IOException,
                           AutomationException

The optional origin against which pixel alignment of eligible items is computed. The parameter defaults to the top-left corner of the first eligible item.

Specified by:

setOriginByRef in interface IComputePixelAlignmentParameters

Parameters:

ppOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOrigin

public IPoint getOrigin()
                 throws java.io.IOException,
                        AutomationException

The optional origin against which pixel alignment of eligible items is computed. The parameter defaults to the top-left corner of the first eligible item.

Specified by:

getOrigin in interface IComputePixelAlignmentParameters

Returns:

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

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.