com.esri.arcgis.datasourcesraster
Class PixelFilterCollection

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.PixelFilterCollection
All Implemented Interfaces:
IMultibandFilter, IPixelFilter, IPixelFilter2, IPixelFilter3, IPixelFilterCollection, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class PixelFilterCollection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IPixelFilter2, IPixelFilter3, IPixelFilterCollection, IMultibandFilter

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

Description 'A raster filter collection.' 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.IPixelFilter3
IID, IID0ed41a27_9699_4b09_b3af_7cffd9f57c28, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IPixelFilterCollection
IID, IID9e73cb76_57e8_4d93_bb45_1f4552a9c8de, xxDummy
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IMultibandFilter
IID, IIDb6c6883c_5487_4b5a_9162_ac8e2da34f5a, xxDummy
 
Constructor Summary
PixelFilterCollection()
          Constructs a PixelFilterCollection using ArcGIS Engine.
PixelFilterCollection(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PixelFilterCollection thePixelFilterCollection = (PixelFilterCollection) obj;
 
Method Summary
 void append(IPixelFilter pFilter)
          Appends a raster filter to the end.
 void empty()
          Empties this raster filter collection.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void filter(IPixelBlock pBlock)
          Filters a pixel block.
 int find(IPixelFilter pFilter)
          Finds a given raster filter and returns its index position.
 IPixelFilter get(int index)
          Gets the raster filter at a given index position.
 void getCenterPosition(int[] atColumn, int[] atRow)
          Gets center position of the filter.
static java.lang.String getClsid()
          getClsid.
 IPixelFilter getFilter(int iBand)
          Gets a given pixel filter.
 int getFilterCount()
          The number of filters in this collection.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 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 insert(int index, IPixelFilter pFilter)
          Inserts a raster filter at a given index.
 void release()
          Release a PixelFilterCollection.
 void remove(int index)
          Removes a raster filter at a given index.
 void set(int index, IPixelFilter pFilter)
          Sets the raster filter at a given index position.
 void synchronize(IRaster pRaster)
          Synchronizes this filter when raster properties are changed.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PixelFilterCollection

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

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

PixelFilterCollection

public PixelFilterCollection(java.lang.Object obj)
                      throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PixelFilterCollection thePixelFilterCollection = (PixelFilterCollection) obj;

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

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

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.

synchronize

public void synchronize(IRaster pRaster)
                 throws java.io.IOException,
                        AutomationException
Synchronizes this filter when raster properties are changed.

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

getFilterCount

public int getFilterCount()
                   throws java.io.IOException,
                          AutomationException
The number of filters in this collection.

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

insert

public void insert(int index,
                   IPixelFilter pFilter)
            throws java.io.IOException,
                   AutomationException
Inserts a raster filter at a given index.

Specified by:
insert in interface IPixelFilterCollection
Parameters:
index - The index (in)
pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

append

public void append(IPixelFilter pFilter)
            throws java.io.IOException,
                   AutomationException
Appends a raster filter to the end.

Specified by:
append in interface IPixelFilterCollection
Parameters:
pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException
Removes a raster filter at a given index.

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

find

public int find(IPixelFilter pFilter)
         throws java.io.IOException,
                AutomationException
Finds a given raster filter and returns its index position.

Specified by:
find in interface IPixelFilterCollection
Parameters:
pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (in)
Returns:
The index
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

get

public IPixelFilter get(int index)
                 throws java.io.IOException,
                        AutomationException
Gets the raster filter at a given index position.

Specified by:
get in interface IPixelFilterCollection
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

set

public void set(int index,
                IPixelFilter pFilter)
         throws java.io.IOException,
                AutomationException
Sets the raster filter at a given index position.

Specified by:
set in interface IPixelFilterCollection
Parameters:
index - The index (in)
pFilter - A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter (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
Empties this raster filter collection.

Specified by:
empty in interface IPixelFilterCollection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilter

public IPixelFilter getFilter(int iBand)
                       throws java.io.IOException,
                              AutomationException
Gets a given pixel filter.

Specified by:
getFilter in interface IMultibandFilter
Parameters:
iBand - The iBand (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IPixelFilter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.