com.esri.arcgis.datasourcesraster
Class BackgroundFilter

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.BackgroundFilter
All Implemented Interfaces:
IBackgroundFilter, IPixelFilter, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class BackgroundFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPixelFilter, IBackgroundFilter

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

Description 'A raster background 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.IBackgroundFilter
IID, IIDb0aacb96_c31c_49b6_be07_a013bbc454e4, xxDummy
 
Constructor Summary
BackgroundFilter()
          Constructs a BackgroundFilter using ArcGIS Engine.
BackgroundFilter(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BackgroundFilter theBackgroundFilter = (BackgroundFilter) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 void filter(IPixelBlock pBlock)
          Filters a pixel block.
 java.lang.Object getBackground()
          The background value to be filtered.
 void getCenterPosition(int[] atColumn, int[] atRow)
          Gets center position of the filter.
static java.lang.String getClsid()
          getClsid.
 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 release()
          Release a BackgroundFilter.
 void setBackground(java.lang.Object value)
          The background value to be filtered.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BackgroundFilter

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

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

BackgroundFilter

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

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

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

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.

getBackground

public java.lang.Object getBackground()
                               throws java.io.IOException,
                                      AutomationException
The background value to be filtered.

Specified by:
getBackground in interface IBackgroundFilter
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(java.lang.Object value)
                   throws java.io.IOException,
                          AutomationException
The background value to be filtered.

Specified by:
setBackground in interface IBackgroundFilter
Parameters:
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.