com.esri.arcgis.datasourcesraster
Class RasterTypeItemURI

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

All Implemented Interfaces:

IItemPaths, IItemURI, IItemURI2, IRasterTypeItemURI, IRasterTypeItemURI2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterTypeItemURI
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURI, IItemURI2, IItemPaths, IRasterTypeItemURI, IRasterTypeItemURI2

An item URI constructed by the raster type object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterTypeItemURI()
Constructs a RasterTypeItemURI using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
IStringArray	getAuxiliaryPaths() Paths to all auxiliary data source items that aid in the construction of this item.
static String	getClsid() getClsid.
String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
String	getFunctionTemplateName() The name of raster function template associated with the item template that built the raster type item URI.
String	getGroup() The name of the collection to which the item belongs.
IItemURIArray	getItems() The item URI objects associated with this container URI object.
int	getItemTemplateIndex() The index to the item template contained within the parent raster type that corresponds to this item URI.
String	getItemTemplateTag() The originally set output dataset tag associated with the parent raster type item template that created the URI.
String	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
IStringArray	getPaths() Returns all paths associated with the object.
String	getPrimaryChainConnector() In the case where the URI is associated with an ancillary dataset, this property indicates the name of the raster function variable within the primary raster function template onto which the ancillary tepmlate reconnects (as a form of post-processing).
String	getProductName() The name of the sensor product associated with the item's data source.
IPropertySet	getProperties() The item uri properties.
Date	getSourceTimeStamp() The timestamp associated with the data source referenced by this item URI.
String	getTag() The unique identifier of the item within a group.
int	hashCode() the hashcode for this object
void	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
void	setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths) Paths to all auxiliary data source items that aid in the construction of this item.
void	setDisplayName(String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setFunctionTemplateName(String pFunctionTemplateName) The name of raster function template associated with the item template that built the raster type item URI.
void	setGroup(String pItemGroup) The name of the collection to which the item belongs.
void	setItemsByRef(IItemURIArray ppItemURIArray) The item URI objects associated with this container URI object.
void	setItemTemplateIndex(int pTemplateIndex) The index to the item template contained within the parent raster type that corresponds to this item URI.
void	setItemTemplateTag(String pItemTemplateTag) The originally set output dataset tag associated with the parent raster type item template that created the URI.
void	setKey(String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setPrimaryChainConnector(String pPrimaryChainConnector) In the case where the URI is associated with an ancillary dataset, this property indicates the name of the raster function variable within the primary raster function template onto which the ancillary tepmlate reconnects (as a form of post-processing).
void	setProductName(String pProductName) The name of the sensor product associated with the item's data source.
void	setPropertiesByRef(IPropertySet ppBuilderPoperties) The item uri properties.
void	setSourceTimeStamp(Date pSourceTimeStamp) The timestamp associated with the data source referenced by this item URI.
void	setTag(String pItemTag) The unique identifier of the item within a group.

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

RasterTypeItemURI

public RasterTypeItemURI()
                  throws IOException,
                         UnknownHostException

Constructs a RasterTypeItemURI using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterTypeItemURI

public RasterTypeItemURI(Object obj)
                  throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems RasterTypeItemURI theRasterTypeItemURI = (RasterTypeItemURI) 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

setKey

public void setKey(String pKeyString)
            throws IOException,
                   AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Product Availability

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

Specified by:

setKey in interface IItemURI

Parameters:

pKeyString - The pKeyString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKey

public String getKey()
              throws IOException,
                     AutomationException

A phrase that uniquely identifies the item's data source in the mosaic dataset. The value in this property is used for computing a 'signature' that appears in the URIHash field of the mosaic catalog.

Product Availability

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

Specified by:

getKey in interface IItemURI

Returns:

The pKeyString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(String pItemTag)
            throws IOException,
                   AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Product Availability

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

Specified by:

setTag in interface IItemURI

Parameters:

pItemTag - The pItemTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

public String getTag()
              throws IOException,
                     AutomationException

The unique identifier of the item within a group. The value in this property appears in the Tag field of the mosaic catalog.

Product Availability

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

Specified by:

getTag in interface IItemURI

Returns:

The pItemTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(String pItemGroup)
              throws IOException,
                     AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Product Availability

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

Specified by:

setGroup in interface IItemURI

Parameters:

pItemGroup - The pItemGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroup

public String getGroup()
                throws IOException,
                       AutomationException

The name of the collection to which the item belongs. The value in this property appears in the GroupName field of the mosaic catalog.

Product Availability

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

Specified by:

getGroup in interface IItemURI

Returns:

The pItemGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(String pDisplayName)
                    throws IOException,
                           AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Product Availability

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

Specified by:

setDisplayName in interface IItemURI

Parameters:

pDisplayName - The pDisplayName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public String getDisplayName()
                      throws IOException,
                             AutomationException

The friendly-name identifying this item in the mosaic dataset. The value in this property appears in the Name field of the mosaic catalog.

Product Availability

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

Specified by:

getDisplayName in interface IItemURI

Returns:

The pDisplayName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductName

public void setProductName(String pProductName)
                    throws IOException,
                           AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Product Availability

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

Specified by:

setProductName in interface IItemURI

Parameters:

pProductName - The pProductName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductName

public String getProductName()
                      throws IOException,
                             AutomationException

The name of the sensor product associated with the item's data source. The value in this property appears in the ProductName field of the mosaic catalog.

Product Availability

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

Specified by:

getProductName in interface IItemURI

Returns:

The pProductName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTimeStamp

public void setSourceTimeStamp(Date pSourceTimeStamp)
                        throws IOException,
                               AutomationException

The timestamp associated with the data source referenced by this item URI.

Product Availability

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

Specified by:

setSourceTimeStamp in interface IItemURI

Parameters:

pSourceTimeStamp - The pSourceTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceTimeStamp

public Date getSourceTimeStamp()
                        throws IOException,
                               AutomationException

The timestamp associated with the data source referenced by this item URI.

Product Availability

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

Specified by:

getSourceTimeStamp in interface IItemURI

Returns:

The pSourceTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryPathsByRef

public void setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths)
                            throws IOException,
                                   AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Product Availability

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

Specified by:

setAuxiliaryPathsByRef in interface IItemURI

Parameters:

ppAuxiliaryPaths - 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.

getAuxiliaryPaths

public IStringArray getAuxiliaryPaths()
                               throws IOException,
                                      AutomationException

Paths to all auxiliary data source items that aid in the construction of this item.

Product Availability

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

Specified by:

getAuxiliaryPaths in interface IItemURI

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.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppBuilderPoperties)
                        throws IOException,
                               AutomationException

The item uri properties.

Product Availability

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

Specified by:

setPropertiesByRef in interface IItemURI2

Parameters:

ppBuilderPoperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The item uri properties.

Product Availability

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

Specified by:

getProperties in interface IItemURI2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws IOException,
                             AutomationException

Returns all paths associated with the object.

Product Availability

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

Specified by:

getPaths in interface IItemPaths

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.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws IOException,
                         AutomationException

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

Product Availability

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

Specified by:

replacePaths in interface IItemPaths

Parameters:

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

pNewPaths - 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.

setItemsByRef

public void setItemsByRef(IItemURIArray ppItemURIArray)
                   throws IOException,
                          AutomationException

The item URI objects associated with this container URI object.

Product Availability

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

Specified by:

setItemsByRef in interface IRasterTypeItemURI

Parameters:

ppItemURIArray - A reference to a com.esri.arcgis.datasourcesraster.IItemURIArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItems

public IItemURIArray getItems()
                       throws IOException,
                              AutomationException

The item URI objects associated with this container URI object.

Product Availability

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

Specified by:

getItems in interface IRasterTypeItemURI

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemTemplateIndex

public void setItemTemplateIndex(int pTemplateIndex)
                          throws IOException,
                                 AutomationException

The index to the item template contained within the parent raster type that corresponds to this item URI.

Product Availability

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

Specified by:

setItemTemplateIndex in interface IRasterTypeItemURI

Parameters:

pTemplateIndex - The pTemplateIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemTemplateIndex

public int getItemTemplateIndex()
                         throws IOException,
                                AutomationException

The index to the item template contained within the parent raster type that corresponds to this item URI.

Product Availability

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

Specified by:

getItemTemplateIndex in interface IRasterTypeItemURI

Returns:

The pTemplateIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemTemplateTag

public void setItemTemplateTag(String pItemTemplateTag)
                        throws IOException,
                               AutomationException

The originally set output dataset tag associated with the parent raster type item template that created the URI. This property enables the raster type to correctly connect an item template's primary or ancillary properties with a raster type item URI.

Product Availability

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

Specified by:

setItemTemplateTag in interface IRasterTypeItemURI2

Parameters:

pItemTemplateTag - The pItemTemplateTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemTemplateTag

public String getItemTemplateTag()
                          throws IOException,
                                 AutomationException

The originally set output dataset tag associated with the parent raster type item template that created the URI. This property enables the raster type to correctly connect an item template's primary or ancillary properties with a raster type item URI.

Product Availability

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

Specified by:

getItemTemplateTag in interface IRasterTypeItemURI2

Returns:

The pItemTemplateTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFunctionTemplateName

public void setFunctionTemplateName(String pFunctionTemplateName)
                             throws IOException,
                                    AutomationException

The name of raster function template associated with the item template that built the raster type item URI.

Product Availability

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

Specified by:

setFunctionTemplateName in interface IRasterTypeItemURI2

Parameters:

pFunctionTemplateName - The pFunctionTemplateName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunctionTemplateName

public String getFunctionTemplateName()
                               throws IOException,
                                      AutomationException

The name of raster function template associated with the item template that built the raster type item URI.

Product Availability

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

Specified by:

getFunctionTemplateName in interface IRasterTypeItemURI2

Returns:

The pFunctionTemplateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrimaryChainConnector

public void setPrimaryChainConnector(String pPrimaryChainConnector)
                              throws IOException,
                                     AutomationException

In the case where the URI is associated with an ancillary dataset, this property indicates the name of the raster function variable within the primary raster function template onto which the ancillary tepmlate reconnects (as a form of post-processing).

Product Availability

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

Specified by:

setPrimaryChainConnector in interface IRasterTypeItemURI2

Parameters:

pPrimaryChainConnector - The pPrimaryChainConnector (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrimaryChainConnector

public String getPrimaryChainConnector()
                                throws IOException,
                                       AutomationException

In the case where the URI is associated with an ancillary dataset, this property indicates the name of the raster function variable within the primary raster function template onto which the ancillary tepmlate reconnects (as a form of post-processing).

Product Availability

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

Specified by:

getPrimaryChainConnector in interface IRasterTypeItemURI2

Returns:

The pPrimaryChainConnector

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.