com.esri.arcgis.datasourcesraster

Class ClipFilter

java.lang.Object

com.esri.arcgis.datasourcesraster.ClipFilter

All Implemented Interfaces:

IClipFilter, IClipFilter2, IPixelFilter, IPixelFilter2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ClipFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IPixelFilter2, IClipFilter, IClipFilter2

COM Class 'ClipFilter'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for clipping filter.' 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.IPixelFilter

IID, IID90e3de9d_4fff_4575_b833_3ad29a57eeca, xxDummy

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

IID, IIDed30705b_437a_4ff4_93b3_f1947c70668b, xxDummy

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

IID, IIDd7d83c7a_a9f0_4a47_bedb_f4fe8bd45907, xxDummy

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

IID37be075c_faea_43ee_9314_16140d101f8d

Constructor Summary

Constructors

Constructor and Description
ClipFilter() Constructs a ClipFilter using ArcGIS Engine.
ClipFilter(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ClipFilter theClipFilter = (ClipFilter) obj;

Method Summary

Modifier and Type	Method and Description
void	add(IGeometry pClippingGeometry) Adds a clipping geometry.
void	empty() Removes all clipping geometries.
boolean	equals(java.lang.Object o) Compare this object with another
void	filter(IPixelBlock pBlock) Filters a pixel block.
void	getCenterPosition(int[] atColumn, int[] atRow) Gets center position of the filter.
int	getClippingType() The raster clipping type.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
void	getSize(int[] columns, int[] rows) Gets dimension of the filter.
int	hashCode() the hashcode for this object
void	init(int nCols, int nRows, IEnvelope pExtent) Initializes this filter for a given area of interest.
void	initBlock(IPnt pTopLeft, int nBlkCols, int nBlkRows) Initialize this filter for a given pixel block.
void	release() Release this COM object reference
void	setClippingType(int pClippingType) The raster clipping type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClipFilter

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

Constructs a ClipFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ClipFilter

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getSize

public void getSize(int[] columns,
                    int[] rows)
             throws java.io.IOException,
                    AutomationException

Gets dimension of the filter.

Specified by:

getSize in interface IPixelFilter

Parameters:

columns - The columns (in/out: use single element array)

rows - The rows (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCenterPosition

public void getCenterPosition(int[] atColumn,
                              int[] atRow)
                       throws java.io.IOException,
                              AutomationException

Gets center position of the filter.

Specified by:

getCenterPosition in interface IPixelFilter

Parameters:

atColumn - The atColumn (in/out: use single element array)

atRow - The atRow (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

filter

public void filter(IPixelBlock pBlock)
            throws java.io.IOException,
                   AutomationException

Filters a pixel block.

Specified by:

filter in interface IPixelFilter

Parameters:

pBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

init

public void init(int nCols,
                 int nRows,
                 IEnvelope pExtent)
          throws java.io.IOException,
                 AutomationException

Initializes this filter for a given area of interest.

Specified by:

init in interface IPixelFilter2

Parameters:

nCols - The nCols (in)

nRows - The nRows (in)

pExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initBlock

public void initBlock(IPnt pTopLeft,
                      int nBlkCols,
                      int nBlkRows)
               throws java.io.IOException,
                      AutomationException

Initialize this filter for a given pixel block.

Specified by:

initBlock in interface IPixelFilter2

Parameters:

pTopLeft - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

nBlkCols - The nBlkCols (in)

nBlkRows - The nBlkRows (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IGeometry pClippingGeometry)
         throws java.io.IOException,
                AutomationException

Adds a clipping geometry.

Specified by:

add in interface IClipFilter

Parameters:

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

empty

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

Removes all clipping geometries.

Specified by:

empty in interface IClipFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClippingType

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

The raster clipping type.

Specified by:

getClippingType in interface IClipFilter2

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClippingType

public void setClippingType(int pClippingType)
                     throws java.io.IOException,
                            AutomationException

The raster clipping type.

Specified by:

setClippingType in interface IClipFilter2

Parameters:

pClippingType - A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.