com.esri.arcgis.datasourcesraster
Class ItemTemplate

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

All Implemented Interfaces:

IItemTemplate, IItemTemplate2, com.esri.arcgis.interop.RemoteObjRef, IXMLSerialize, IXMLVersionSupport, Serializable

public class ItemTemplate
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemTemplate2, IXMLSerialize, IXMLVersionSupport

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

void	addAncillaryDataset(String sOutputDatasetTag, String sFunctionTemplateName, String sPrimaryChainConnectorVariable) Adds additional outgoing tags for non-primary datasets that can be built using this item template.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	enableEnhancement(boolean bEnableEnhancement) Enable or disable functions that enhance a dataset.
boolean	equals(Object o) Compare this object with another
void	getAncillaryDatasets(IStringArray[] ppOutputDatasetTags, IStringArray[] ppFunctionTemplateNames, IStringArray[] ppPrimaryChainConnectorVariables) Returns a collection of tags and associated function template names and connector variables of all non-primary datasets built by the item template.
static String	getClsid() getClsid.
IGeoTransformationHelper	getGeoTransformationHelper() The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
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	isEnhancementEnabled() Indicates whether the item template will enhance datasets.
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.
boolean	isSensorTemplate() Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).
boolean	isSupportsEnhancement() Indicates whether the item template contains functions that enhance a dataset.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEnabled(boolean pbEnabled) Indicates whether the item template is active.
void	setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper) The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.
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	setIsSensorTemplate(boolean pbIsSensorTemplate) Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).
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.
void	setSupportsEnhancement(boolean pbSupportsEnhancement) Indicates whether the item template contains functions that enhance a dataset.

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

setSupportsEnhancement

public void setSupportsEnhancement(boolean pbSupportsEnhancement)
                            throws IOException,
                                   AutomationException

Indicates whether the item template contains functions that enhance a dataset.

Product Availability

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

Specified by:

setSupportsEnhancement in interface IItemTemplate2

Parameters:

pbSupportsEnhancement - The pbSupportsEnhancement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsEnhancement

public boolean isSupportsEnhancement()
                              throws IOException,
                                     AutomationException

Indicates whether the item template contains functions that enhance a dataset.

Product Availability

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

Specified by:

isSupportsEnhancement in interface IItemTemplate2

Returns:

The pbSupportsEnhancement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

enableEnhancement

public void enableEnhancement(boolean bEnableEnhancement)
                       throws IOException,
                              AutomationException

Enable or disable functions that enhance a dataset.

Product Availability

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

Specified by:

enableEnhancement in interface IItemTemplate2

Parameters:

bEnableEnhancement - The bEnableEnhancement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnhancementEnabled

public boolean isEnhancementEnabled()
                             throws IOException,
                                    AutomationException

Indicates whether the item template will enhance datasets.

Product Availability

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

Specified by:

isEnhancementEnabled in interface IItemTemplate2

Returns:

The pbEnable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsSensorTemplate

public void setIsSensorTemplate(boolean pbIsSensorTemplate)
                         throws IOException,
                                AutomationException

Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Specified by:

setIsSensorTemplate in interface IItemTemplate2

Parameters:

pbIsSensorTemplate - The pbIsSensorTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSensorTemplate

public boolean isSensorTemplate()
                         throws IOException,
                                AutomationException

Indicates whether the item template can be used to build sensor data sources (as opposed to regular raster data sources).

Product Availability

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

Specified by:

isSensorTemplate in interface IItemTemplate2

Returns:

The pbIsSensorTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationHelperByRef

public void setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper)
                                     throws IOException,
                                            AutomationException

The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.

Product Availability

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

Specified by:

setGeoTransformationHelperByRef in interface IItemTemplate2

Parameters:

ppGeoTransformationHelper - A reference to a com.esri.arcgis.datasourcesraster.IGeoTransformationHelper (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeoTransformationHelper

public IGeoTransformationHelper getGeoTransformationHelper()
                                                    throws IOException,
                                                           AutomationException

The geographic tranformation helper object, set by the calling application, that enables the item template to install geotransformation method in to the system's GeoTransformationOperationSet.

Product Availability

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

Specified by:

getGeoTransformationHelper in interface IItemTemplate2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addAncillaryDataset

public void addAncillaryDataset(String sOutputDatasetTag,
                                String sFunctionTemplateName,
                                String sPrimaryChainConnectorVariable)
                         throws IOException,
                                AutomationException

Adds additional outgoing tags for non-primary datasets that can be built using this item template. This method also accepts an optional name of a template function that resides within the primary raster function template associated within this item template wh????&

Product Availability

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

Specified by:

addAncillaryDataset in interface IItemTemplate2

Parameters:

sOutputDatasetTag - The sOutputDatasetTag (in)

sFunctionTemplateName - The sFunctionTemplateName (in)

sPrimaryChainConnectorVariable - The sPrimaryChainConnectorVariable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAncillaryDatasets

public void getAncillaryDatasets(IStringArray[] ppOutputDatasetTags,
                                 IStringArray[] ppFunctionTemplateNames,
                                 IStringArray[] ppPrimaryChainConnectorVariables)
                          throws IOException,
                                 AutomationException

Returns a collection of tags and associated function template names and connector variables of all non-primary datasets built by the item template.

Product Availability

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

Specified by:

getAncillaryDatasets in interface IItemTemplate2

Parameters:

ppOutputDatasetTags - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppFunctionTemplateNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppPrimaryChainConnectorVariables - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.