com.esri.arcgis.geodatabase
Class TinValueFilter

java.lang.Object
  com.esri.arcgis.geodatabase.TinValueFilter

All Implemented Interfaces:

ITinDynamicFilter, ITinFilter, ITinValueFilter, ITinValueFilter2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class TinValueFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinDynamicFilter, ITinValueFilter, ITinValueFilter2, ISupportErrorInfo

COM Class 'TinValueFilter'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'The Esri TinValueFilter component.' 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.geodatabase.ITinDynamicFilter

IID, IID0122c788_fd32_11d3_a0d6_00c04f8ece27, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITinValueFilter2

IID, IID3110a889_298b_4849_8abb_7a3383fd1a4e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.ITinValueFilter

IID4eee3277_fa94_11d2_ae10_000000000000

Fields inherited from interface com.esri.arcgis.geodatabase.ITinFilter

IID4eee3270_fa94_11d2_ae10_000000000000

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

TinValueFilter()
Constructs a TinValueFilter using ArcGIS Engine.

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

Method Summary

boolean	canPass(ITinElement pElement) Indicates if the specified element meets the filter criteria.
boolean	equals(java.lang.Object o) Compare this object with another
int	getActiveBound() The active boundary of the filter.
ILongArray	getClassBreakCodes() The filter's numeric values used to represent each class.
ILongArray	getClassBreaks() The classification categories of the filter.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLowerBound() The lower bound of the filter.
int	getUniqueValue() The unique value of the filter.
int	getUpperBound() The upper bound of the filter.
int	hashCode() the hashcode for this object
int	init(ITinElement pElement) Re/establishes the filter; determines and returns an ID for the subset of elements represented by the index.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isDataElementsOnly() Indicates whether the returned elements should be inside the data area.
boolean	isZeroTagValueExcluded() Indicates if zero tag value should be excluded.
void	release() Release a TinValueFilter.
void	setActiveBound(int pType) The active boundary of the filter.
void	setClassBreakCodesByRef(ILongArray ppCodes) The filter's numeric values used to represent each class.
void	setClassBreaksByRef(ILongArray ppBreaks) The classification categories of the filter.
void	setDataElementsOnly(boolean pbDataElementsOnly) Indicates whether the returned elements should be inside the data area.
void	setLowerBound(int pLowerBound) The lower bound of the filter.
void	setUniqueValue(int pValue) The unique value of the filter.
void	setUpperBound(int pUpperBound) The upper bound of the filter.
void	setZeroTagValueExcluded(boolean pbExcludeZeroTagValue) Indicates if zero tag value should be excluded.

Methods inherited from class java.lang.Object

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

Constructor Detail

TinValueFilter

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

Constructs a TinValueFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TinValueFilter

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

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

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

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

Specified by:

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

init

public int init(ITinElement pElement)
         throws java.io.IOException,
                AutomationException

Re/establishes the filter; determines and returns an ID for the subset of elements represented by the index.

Specified by:

init in interface ITinDynamicFilter

Parameters:

pElement - A reference to a com.esri.arcgis.geodatabase.ITinElement (in)

Returns:

The pID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canPass

public boolean canPass(ITinElement pElement)
                throws java.io.IOException,
                       AutomationException

Indicates if the specified element meets the filter criteria.

Specified by:

canPass in interface ITinFilter

Parameters:

pElement - A reference to a com.esri.arcgis.geodatabase.ITinElement (in)

Returns:

The pbCanPass

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataElementsOnly

public void setDataElementsOnly(boolean pbDataElementsOnly)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the returned elements should be inside the data area.

Specified by:

setDataElementsOnly in interface ITinFilter

Parameters:

pbDataElementsOnly - The pbDataElementsOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataElementsOnly

public boolean isDataElementsOnly()
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the returned elements should be inside the data area.

Specified by:

isDataElementsOnly in interface ITinFilter

Returns:

The pbDataElementsOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLowerBound

public void setLowerBound(int pLowerBound)
                   throws java.io.IOException,
                          AutomationException

The lower bound of the filter.

Specified by:

setLowerBound in interface ITinValueFilter

Parameters:

pLowerBound - The pLowerBound (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLowerBound

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

The lower bound of the filter.

Specified by:

getLowerBound in interface ITinValueFilter

Returns:

The pLowerBound

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUpperBound

public void setUpperBound(int pUpperBound)
                   throws java.io.IOException,
                          AutomationException

The upper bound of the filter.

Specified by:

setUpperBound in interface ITinValueFilter

Parameters:

pUpperBound - The pUpperBound (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUpperBound

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

The upper bound of the filter.

Specified by:

getUpperBound in interface ITinValueFilter

Returns:

The pUpperBound

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClassBreaksByRef

public void setClassBreaksByRef(ILongArray ppBreaks)
                         throws java.io.IOException,
                                AutomationException

The classification categories of the filter.

Specified by:

setClassBreaksByRef in interface ITinValueFilter

Parameters:

ppBreaks - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassBreaks

public ILongArray getClassBreaks()
                          throws java.io.IOException,
                                 AutomationException

The classification categories of the filter.

Specified by:

getClassBreaks in interface ITinValueFilter

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClassBreakCodesByRef

public void setClassBreakCodesByRef(ILongArray ppCodes)
                             throws java.io.IOException,
                                    AutomationException

The filter's numeric values used to represent each class.

Specified by:

setClassBreakCodesByRef in interface ITinValueFilter

Parameters:

ppCodes - A reference to a com.esri.arcgis.system.ILongArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassBreakCodes

public ILongArray getClassBreakCodes()
                              throws java.io.IOException,
                                     AutomationException

The filter's numeric values used to represent each class.

Specified by:

getClassBreakCodes in interface ITinValueFilter

Returns:

A reference to a com.esri.arcgis.system.ILongArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUniqueValue

public void setUniqueValue(int pValue)
                    throws java.io.IOException,
                           AutomationException

The unique value of the filter.

Specified by:

setUniqueValue in interface ITinValueFilter

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUniqueValue

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

The unique value of the filter.

Specified by:

getUniqueValue in interface ITinValueFilter

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setActiveBound

public void setActiveBound(int pType)
                    throws java.io.IOException,
                           AutomationException

The active boundary of the filter.

Specified by:

setActiveBound in interface ITinValueFilter

Parameters:

pType - A com.esri.arcgis.geodatabase.esriTinBoundType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveBound

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

The active boundary of the filter.

Specified by:

getActiveBound in interface ITinValueFilter

Returns:

A com.esri.arcgis.geodatabase.esriTinBoundType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZeroTagValueExcluded

public void setZeroTagValueExcluded(boolean pbExcludeZeroTagValue)
                             throws java.io.IOException,
                                    AutomationException

Indicates if zero tag value should be excluded.

Specified by:

setZeroTagValueExcluded in interface ITinValueFilter2

Parameters:

pbExcludeZeroTagValue - The pbExcludeZeroTagValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isZeroTagValueExcluded

public boolean isZeroTagValueExcluded()
                               throws java.io.IOException,
                                      AutomationException

Indicates if zero tag value should be excluded.

Specified by:

isZeroTagValueExcluded in interface ITinValueFilter2

Returns:

The pbExcludeZeroTagValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.