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, java.io.Serializable

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

COM Class 'ItemTemplate'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An item template.' 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.datasourcesraster.IItemTemplate2

IID, IID63215c2b_86b2_4b41_84fb_50283cad0a7a, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IItemTemplate

IID205b20a1_3bc1_4270_acc9_6f73c1840007

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
ItemTemplate() Constructs a ItemTemplate using ArcGIS Engine.
ItemTemplate(java.lang.Object obj) Construct a ItemTemplate using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
void	addAncillaryDataset(java.lang.String sOutputDatasetTag, java.lang.String sFunctionTemplateName, java.lang.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(java.lang.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 java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
java.lang.String	getName() The name of the item template.
java.lang.String	getOutputDatasetTag() The output dataset tag associated with the item template.
java.lang.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	release() Release this COM object reference
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(java.lang.String pItemTemplateName) The name of the item template.
void	setOutputDatasetTag(java.lang.String pOutputDatasetTag) The output dataset tag associated with the item template.
void	setPrimaryInputDatasetTag(java.lang.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

Constructor Detail

ItemTemplate

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

Constructs a ItemTemplate using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ItemTemplate

public ItemTemplate(java.lang.Object obj)
             throws java.io.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:

java.io.IOException - if there are interop problems ItemTemplate theItemTemplate = (ItemTemplate) obj;

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

setSupportsEnhancement

public void setSupportsEnhancement(boolean pbSupportsEnhancement)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setSupportsEnhancement in interface IItemTemplate2

Parameters:

pbSupportsEnhancement - The pbSupportsEnhancement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsEnhancement

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

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

Specified by:

isSupportsEnhancement in interface IItemTemplate2

Returns:

The pbSupportsEnhancement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

enableEnhancement

public void enableEnhancement(boolean bEnableEnhancement)
                       throws java.io.IOException,
                              AutomationException

Enable or disable functions that enhance a dataset.

Specified by:

enableEnhancement in interface IItemTemplate2

Parameters:

bEnableEnhancement - The bEnableEnhancement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnhancementEnabled

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

Indicates whether the item template will enhance datasets.

Specified by:

isEnhancementEnabled in interface IItemTemplate2

Returns:

The pbEnable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsSensorTemplate

public void setIsSensorTemplate(boolean pbIsSensorTemplate)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setIsSensorTemplate in interface IItemTemplate2

Parameters:

pbIsSensorTemplate - The pbIsSensorTemplate (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSensorTemplate

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

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

Specified by:

isSensorTemplate in interface IItemTemplate2

Returns:

The pbIsSensorTemplate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGeoTransformationHelperByRef

public void setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper)
                                     throws java.io.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.

Specified by:

setGeoTransformationHelperByRef in interface IItemTemplate2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformationHelper

public IGeoTransformationHelper getGeoTransformationHelper()
                                                    throws java.io.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.

Specified by:

getGeoTransformationHelper in interface IItemTemplate2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addAncillaryDataset

public void addAncillaryDataset(java.lang.String sOutputDatasetTag,
                                java.lang.String sFunctionTemplateName,
                                java.lang.String sPrimaryChainConnectorVariable)
                         throws java.io.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

Specified by:

addAncillaryDataset in interface IItemTemplate2

Parameters:

sOutputDatasetTag - The sOutputDatasetTag (in)

sFunctionTemplateName - The sFunctionTemplateName (in)

sPrimaryChainConnectorVariable - The sPrimaryChainConnectorVariable (in)

Throws:

java.io.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 java.io.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.

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:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pItemTemplateName)
             throws java.io.IOException,
                    AutomationException

The name of the item template.

Specified by:

setName in interface IItemTemplate

Parameters:

pItemTemplateName - The pItemTemplateName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the item template.

Specified by:

getName in interface IItemTemplate

Returns:

The pItemTemplateName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnabled

public void setEnabled(boolean pbEnabled)
                throws java.io.IOException,
                       AutomationException

Indicates whether the item template is active.

Specified by:

setEnabled in interface IItemTemplate

Parameters:

pbEnabled - The pbEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnabled

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

Indicates whether the item template is active.

Specified by:

isEnabled in interface IItemTemplate

Returns:

The pbEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterFunctionTemplateByRef

public void setRasterFunctionTemplateByRef(IRasterFunctionTemplate ppFunctionTemplate)
                                    throws java.io.IOException,
                                           AutomationException

The raster function template associated with the item template.

Specified by:

setRasterFunctionTemplateByRef in interface IItemTemplate

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterFunctionTemplate

public IRasterFunctionTemplate getRasterFunctionTemplate()
                                                  throws java.io.IOException,
                                                         AutomationException

The raster function template associated with the item template.

Specified by:

getRasterFunctionTemplate in interface IItemTemplate

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetTag

public void setOutputDatasetTag(java.lang.String pOutputDatasetTag)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setOutputDatasetTag in interface IItemTemplate

Parameters:

pOutputDatasetTag - The pOutputDatasetTag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputDatasetTag

public java.lang.String getOutputDatasetTag()
                                     throws java.io.IOException,
                                            AutomationException

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

Specified by:

getOutputDatasetTag in interface IItemTemplate

Returns:

The pOutputDatasetTag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPrimaryInputDatasetTag

public void setPrimaryInputDatasetTag(java.lang.String pPrimaryInputDatasetTag)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

setPrimaryInputDatasetTag in interface IItemTemplate

Parameters:

pPrimaryInputDatasetTag - The pPrimaryInputDatasetTag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPrimaryInputDatasetTag

public java.lang.String getPrimaryInputDatasetTag()
                                           throws java.io.IOException,
                                                  AutomationException

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

Specified by:

getPrimaryInputDatasetTag in interface IItemTemplate

Returns:

The pPrimaryInputDatasetTag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIntersectFootprints

public void setIntersectFootprints(boolean pbIntersectFootprints)
                            throws java.io.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.

Specified by:

setIntersectFootprints in interface IItemTemplate

Parameters:

pbIntersectFootprints - The pbIntersectFootprints (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIntersectFootprints

public boolean isIntersectFootprints()
                              throws java.io.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.

Specified by:

isIntersectFootprints in interface IItemTemplate

Returns:

The pbIntersectFootprints

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.