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, Serializable

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

The ESRI TinValueFilter component.

Description

The TinValueFilter object is used to filter TinElements (nodes, edges, triangles) based on their tag values. Tag values are Long integers that have user defined meaning; a simple form of attribution. They could represent accuracy codes for nodes, landcover codes for triangles, or indicate some flag condition for a custom algorithm.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

TinValueFilter()
Constructs a TinValueFilter using ArcGIS Engine.

TinValueFilter(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(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 String	getClsid() getClsid.
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	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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

TinValueFilter

public TinValueFilter()
               throws IOException,
                      UnknownHostException

Constructs a TinValueFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TinValueFilter

public TinValueFilter(Object obj)
               throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

init

public int init(ITinElement pElement)
         throws IOException,
                AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface ITinDynamicFilter

Parameters:

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

Returns:

The pID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canPass

public boolean canPass(ITinElement pElement)
                throws IOException,
                       AutomationException

Indicates if the specified element meets the filter criteria.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

canPass in interface ITinFilter

Parameters:

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

Returns:

The pbCanPass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataElementsOnly

public void setDataElementsOnly(boolean pbDataElementsOnly)
                         throws IOException,
                                AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDataElementsOnly in interface ITinFilter

Parameters:

pbDataElementsOnly - The pbDataElementsOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDataElementsOnly

public boolean isDataElementsOnly()
                           throws IOException,
                                  AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDataElementsOnly in interface ITinFilter

Returns:

The pbDataElementsOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowerBound

public void setLowerBound(int pLowerBound)
                   throws IOException,
                          AutomationException

The lower bound of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLowerBound in interface ITinValueFilter

Parameters:

pLowerBound - The pLowerBound (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerBound

public int getLowerBound()
                  throws IOException,
                         AutomationException

The lower bound of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLowerBound in interface ITinValueFilter

Returns:

The pLowerBound

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpperBound

public void setUpperBound(int pUpperBound)
                   throws IOException,
                          AutomationException

The upper bound of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUpperBound in interface ITinValueFilter

Parameters:

pUpperBound - The pUpperBound (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperBound

public int getUpperBound()
                  throws IOException,
                         AutomationException

The upper bound of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUpperBound in interface ITinValueFilter

Returns:

The pUpperBound

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassBreaksByRef

public void setClassBreaksByRef(ILongArray ppBreaks)
                         throws IOException,
                                AutomationException

The classification categories of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassBreaksByRef in interface ITinValueFilter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassBreaks

public ILongArray getClassBreaks()
                          throws IOException,
                                 AutomationException

The classification categories of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassBreaks in interface ITinValueFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClassBreakCodesByRef

public void setClassBreakCodesByRef(ILongArray ppCodes)
                             throws IOException,
                                    AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setClassBreakCodesByRef in interface ITinValueFilter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassBreakCodes

public ILongArray getClassBreakCodes()
                              throws IOException,
                                     AutomationException

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassBreakCodes in interface ITinValueFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUniqueValue

public void setUniqueValue(int pValue)
                    throws IOException,
                           AutomationException

The unique value of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUniqueValue in interface ITinValueFilter

Parameters:

pValue - The pValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUniqueValue

public int getUniqueValue()
                   throws IOException,
                          AutomationException

The unique value of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUniqueValue in interface ITinValueFilter

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveBound

public void setActiveBound(int pType)
                    throws IOException,
                           AutomationException

The active boundary of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setActiveBound in interface ITinValueFilter

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActiveBound

public int getActiveBound()
                   throws IOException,
                          AutomationException

The active boundary of the filter.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getActiveBound in interface ITinValueFilter

Returns:

A com.esri.arcgis.geodatabase.esriTinBoundType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZeroTagValueExcluded

public void setZeroTagValueExcluded(boolean pbExcludeZeroTagValue)
                             throws IOException,
                                    AutomationException

Indicates if zero tag value should be excluded.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZeroTagValueExcluded in interface ITinValueFilter2

Parameters:

pbExcludeZeroTagValue - The pbExcludeZeroTagValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZeroTagValueExcluded

public boolean isZeroTagValueExcluded()
                               throws IOException,
                                      AutomationException

Indicates if zero tag value should be excluded.

Description

Determines if elements with tag values of 0 are allowed to pass thru the filter or are blocked.

In some applications it may be desirable to exclude elements that have not had their tag value set explicitly. Since the default tag value for all elements is 0 you can exclude elements that haven't been tagged by setting ZeroTagValueExcluded to TRUE. This is assuming elements that have been tagged explicitly are done so with non-zero values.

The default value is FALSE.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isZeroTagValueExcluded in interface ITinValueFilter2

Returns:

The pbExcludeZeroTagValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.