com.esri.arcgis.datasourcesraster
Class URIProductNameFilter

java.lang.Object
  com.esri.arcgis.datasourcesraster.URIProductNameFilter

All Implemented Interfaces:

IItemURIFilter, IURIProductNameFilter, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class URIProductNameFilter
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURIFilter, IURIProductNameFilter

A URI filter object for product names.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

URIProductNameFilter()
Constructs a URIProductNameFilter using ArcGIS Engine.

URIProductNameFilter(Object obj)
Construct a URIProductNameFilter using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	applyFilter(IItemURI pItemURI) Indicates whether the specified item URI object pass through the filter.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getName() The name of the item URI filter.
IStringArray	getProductNames() The product names of item URIs allowed to pass through the filter.
IStringArray	getSupportedTemplateNames() The list of supported template names.
int	hashCode() the hashcode for this object
boolean	isSupportsOrthorectification() Indicates whether the item URI filter supports ortho-rectification.
void	setName(String pFilterName) The name of the item URI filter.
void	setProductNamesByRef(IStringArray ppProductNames) The product names of item URIs allowed to pass through the filter.
void	setSupportedTemplateNamesByRef(IStringArray ppTemplateNames) The list of supported template names.
void	setSupportsOrthorectification(boolean pbSupportsOrthorectification) Indicates whether the item URI filter supports ortho-rectification.

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

URIProductNameFilter

public URIProductNameFilter()
                     throws IOException,
                            UnknownHostException

Constructs a URIProductNameFilter using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

URIProductNameFilter

public URIProductNameFilter(Object obj)
                     throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems URIProductNameFilter theURIProductNameFilter = (URIProductNameFilter) obj;

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

setName

public void setName(String pFilterName)
             throws IOException,
                    AutomationException

The name of the item URI filter.

Product Availability

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

Specified by:

setName in interface IItemURIFilter

Parameters:

pFilterName - The pFilterName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the item URI filter.

Product Availability

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

Specified by:

getName in interface IItemURIFilter

Returns:

The pFilterName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportedTemplateNamesByRef

public void setSupportedTemplateNamesByRef(IStringArray ppTemplateNames)
                                    throws IOException,
                                           AutomationException

The list of supported template names.

Product Availability

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

Specified by:

setSupportedTemplateNamesByRef in interface IItemURIFilter

Parameters:

ppTemplateNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedTemplateNames

public IStringArray getSupportedTemplateNames()
                                       throws IOException,
                                              AutomationException

The list of supported template names.

Product Availability

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

Specified by:

getSupportedTemplateNames in interface IItemURIFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsOrthorectification

public void setSupportsOrthorectification(boolean pbSupportsOrthorectification)
                                   throws IOException,
                                          AutomationException

Indicates whether the item URI filter supports ortho-rectification.

Product Availability

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

Specified by:

setSupportsOrthorectification in interface IItemURIFilter

Parameters:

pbSupportsOrthorectification - The pbSupportsOrthorectification (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsOrthorectification

public boolean isSupportsOrthorectification()
                                     throws IOException,
                                            AutomationException

Indicates whether the item URI filter supports ortho-rectification.

Product Availability

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

Specified by:

isSupportsOrthorectification in interface IItemURIFilter

Returns:

The pbSupportsOrthorectification

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyFilter

public boolean applyFilter(IItemURI pItemURI)
                    throws IOException,
                           AutomationException

Indicates whether the specified item URI object pass through the filter.

Product Availability

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

Specified by:

applyFilter in interface IItemURIFilter

Parameters:

pItemURI - A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)

Returns:

The pIncludeItemURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductNamesByRef

public void setProductNamesByRef(IStringArray ppProductNames)
                          throws IOException,
                                 AutomationException

The product names of item URIs allowed to pass through the filter. Calls to IItemURIFilter.ApplyFilter method will return FALSE for those item URIs with product names that don't appear in this array.

Product Availability

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

Specified by:

setProductNamesByRef in interface IURIProductNameFilter

Parameters:

ppProductNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductNames

public IStringArray getProductNames()
                             throws IOException,
                                    AutomationException

The product names of item URIs allowed to pass through the filter. Calls to IItemURIFilter.ApplyFilter method will return FALSE for those item URIs with product names that don't appear in this array.

Product Availability

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

Specified by:

getProductNames in interface IURIProductNameFilter

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.