com.esri.arcgis.datasourcesraster
Class ItemTemplate

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

All Implemented Interfaces:

IItemTemplate, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ItemTemplate
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemTemplate

An item template.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ItemTemplate()
Constructs a ItemTemplate using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getName() The name of the item template.
String	getOutputDatasetTag() The output dataset tag associated with the item template.
String	getPrimaryInputDatasetTag() Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.
IRasterFunctionTemplate	getRasterFunctionTemplate() The raster function template associated with the item template.
int	hashCode() the hashcode for this object
boolean	isEnabled() Indicates whether the item template is active.
boolean	isIntersectFootprints() Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.
void	setEnabled(boolean pbEnabled) Indicates whether the item template is active.
void	setIntersectFootprints(boolean pbIntersectFootprints) Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.
void	setName(String pItemTemplateName) The name of the item template.
void	setOutputDatasetTag(String pOutputDatasetTag) The output dataset tag associated with the item template.
void	setPrimaryInputDatasetTag(String pPrimaryInputDatasetTag) Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.
void	setRasterFunctionTemplateByRef(IRasterFunctionTemplate ppFunctionTemplate) The raster function template associated with the item template.

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

ItemTemplate

public ItemTemplate()
             throws IOException,
                    UnknownHostException

Constructs a ItemTemplate using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ItemTemplate

public ItemTemplate(Object obj)
             throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ItemTemplate theItemTemplate = (ItemTemplate) 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 pItemTemplateName)
             throws IOException,
                    AutomationException

The name of the item template.

Product Availability

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

Specified by:

setName in interface IItemTemplate

Parameters:

pItemTemplateName - The pItemTemplateName (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 template.

Product Availability

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

Specified by:

getName in interface IItemTemplate

Returns:

The pItemTemplateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean pbEnabled)
                throws IOException,
                       AutomationException

Indicates whether the item template is active.

Product Availability

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

Specified by:

setEnabled in interface IItemTemplate

Parameters:

pbEnabled - The pbEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates whether the item template is active.

Product Availability

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

Specified by:

isEnabled in interface IItemTemplate

Returns:

The pbEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterFunctionTemplateByRef

public void setRasterFunctionTemplateByRef(IRasterFunctionTemplate ppFunctionTemplate)
                                    throws IOException,
                                           AutomationException

The raster function template associated with the item template.

Product Availability

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

Specified by:

setRasterFunctionTemplateByRef in interface IItemTemplate

Parameters:

ppFunctionTemplate - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterFunctionTemplate

public IRasterFunctionTemplate getRasterFunctionTemplate()
                                                  throws IOException,
                                                         AutomationException

The raster function template associated with the item template.

Product Availability

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

Specified by:

getRasterFunctionTemplate in interface IItemTemplate

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetTag

public void setOutputDatasetTag(String pOutputDatasetTag)
                         throws IOException,
                                AutomationException

The output dataset tag associated with the item template. This property determines the tag of the outgoing item constructed using this template.

Product Availability

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

Specified by:

setOutputDatasetTag in interface IItemTemplate

Parameters:

pOutputDatasetTag - The pOutputDatasetTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputDatasetTag

public String getOutputDatasetTag()
                           throws IOException,
                                  AutomationException

The output dataset tag associated with the item template. This property determines the tag of the outgoing item constructed using this template.

Product Availability

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

Specified by:

getOutputDatasetTag in interface IItemTemplate

Returns:

The pOutputDatasetTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrimaryInputDatasetTag

public void setPrimaryInputDatasetTag(String pPrimaryInputDatasetTag)
                               throws IOException,
                                      AutomationException

Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.

Product Availability

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

Specified by:

setPrimaryInputDatasetTag in interface IItemTemplate

Parameters:

pPrimaryInputDatasetTag - The pPrimaryInputDatasetTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrimaryInputDatasetTag

public String getPrimaryInputDatasetTag()
                                 throws IOException,
                                        AutomationException

Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.

Product Availability

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

Specified by:

getPrimaryInputDatasetTag in interface IItemTemplate

Returns:

The pPrimaryInputDatasetTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntersectFootprints

public void setIntersectFootprints(boolean pbIntersectFootprints)
                            throws IOException,
                                   AutomationException

Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.

Product Availability

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

Specified by:

setIntersectFootprints in interface IItemTemplate

Parameters:

pbIntersectFootprints - The pbIntersectFootprints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIntersectFootprints

public boolean isIntersectFootprints()
                              throws IOException,
                                     AutomationException

Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.

Product Availability

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

Specified by:

isIntersectFootprints in interface IItemTemplate

Returns:

The pbIntersectFootprints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.