com.esri.arcgis.datasourcesraster
Class RPFItemURI

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

All Implemented Interfaces:

IFileItemURI, IItemPaths, IItemPaths2, IItemURI, IItemURI2, IItemURICompare, IRPFItemURI, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RPFItemURI
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURI, IItemURI2, IItemPaths, IItemPaths2, IFileItemURI, IRPFItemURI, IItemURICompare

An item URI that identifes aN RPF file.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RPFItemURI()
Constructs a RPFItemURI using ArcGIS Engine.

RPFItemURI(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RPFItemURI theRPFItemURI = (RPFItemURI) obj;

Method Summary

int	compare(IItemURI pItemURI) Compares the object with the specified item URI.
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	getCompilationDate() The data compilation date associated with the DTED file.
String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
String	getDTEDEdition() The data edition associated with the DTED file.
String	getFilePath() The path to the file associated with this item URI.
String	getGroup() The name of the collection to which the item belongs.
String	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
String	getLatitude() The latitude associated with the DTED file.
String	getLongitude() The longitude associated with the DTED file.
String	getMaintenanceDate() The maintenance date associated with the DTED file.
IStringArray	getPaths() Returns all paths associated with the object.
IStringArray	getPathsEx(IItemPathsOptions pOptions) Returns all paths associated with the object.
String	getProductionDate() Production date associated with the RPF file.
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.
String	getVersion() The data version associated with the RPF/DTED file.
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	setCompilationDate(String pCompilationDate) The data compilation date associated with the DTED file.
void	setDisplayName(String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setDTEDEdition(String pEdition) The data edition associated with the DTED file.
void	setFilePath(String pFilePath) The path to the file associated with this item URI.
void	setGroup(String pItemGroup) The name of the collection to which the item belongs.
void	setKey(String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setLatitude(String pLatitude) The latitude associated with the DTED file.
void	setLongitude(String pLongitude) The longitude associated with the DTED file.
void	setMaintenanceDate(String pMaintenanceDate) The maintenance date associated with the DTED file.
void	setProductionDate(String pProductionDate) Production date associated with the RPF file.
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.
void	setVersion(String pVersion) The data version associated with the RPF/DTED file.

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

RPFItemURI

public RPFItemURI()
           throws IOException,
                  UnknownHostException

Constructs a RPFItemURI using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RPFItemURI

public RPFItemURI(Object obj)
           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RPFItemURI theRPFItemURI = (RPFItemURI) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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.

getPathsEx

public IStringArray getPathsEx(IItemPathsOptions pOptions)
                        throws IOException,
                               AutomationException

Returns all paths associated with the object.

Product Availability

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

Specified by:

getPathsEx in interface IItemPaths2

Parameters:

pOptions - A reference to a com.esri.arcgis.datasourcesraster.IItemPathsOptions (in)

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.

setFilePath

public void setFilePath(String pFilePath)
                 throws IOException,
                        AutomationException

The path to the file associated with this item URI.

Product Availability

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

Specified by:

setFilePath in interface IFileItemURI

Parameters:

pFilePath - The pFilePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilePath

public String getFilePath()
                   throws IOException,
                          AutomationException

The path to the file associated with this item URI.

Product Availability

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

Specified by:

getFilePath in interface IFileItemURI

Returns:

The pFilePath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProductionDate

public void setProductionDate(String pProductionDate)
                       throws IOException,
                              AutomationException

Production date associated with the RPF file.

Product Availability

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

Specified by:

setProductionDate in interface IRPFItemURI

Parameters:

pProductionDate - The pProductionDate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProductionDate

public String getProductionDate()
                         throws IOException,
                                AutomationException

Production date associated with the RPF file.

Product Availability

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

Specified by:

getProductionDate in interface IRPFItemURI

Returns:

The pProductionDate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDTEDEdition

public String getDTEDEdition()
                      throws IOException,
                             AutomationException

The data edition associated with the DTED file.

Product Availability

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

Specified by:

getDTEDEdition in interface IRPFItemURI

Returns:

The pEdition

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDTEDEdition

public void setDTEDEdition(String pEdition)
                    throws IOException,
                           AutomationException

The data edition associated with the DTED file.

Product Availability

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

Specified by:

setDTEDEdition in interface IRPFItemURI

Parameters:

pEdition - The pEdition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(String pVersion)
                throws IOException,
                       AutomationException

The data version associated with the RPF/DTED file.

Product Availability

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

Specified by:

setVersion in interface IRPFItemURI

Parameters:

pVersion - The pVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

public String getVersion()
                  throws IOException,
                         AutomationException

The data version associated with the RPF/DTED file.

Product Availability

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

Specified by:

getVersion in interface IRPFItemURI

Returns:

The pVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompilationDate

public void setCompilationDate(String pCompilationDate)
                        throws IOException,
                               AutomationException

The data compilation date associated with the DTED file.

Product Availability

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

Specified by:

setCompilationDate in interface IRPFItemURI

Parameters:

pCompilationDate - The pCompilationDate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompilationDate

public String getCompilationDate()
                          throws IOException,
                                 AutomationException

The data compilation date associated with the DTED file.

Product Availability

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

Specified by:

getCompilationDate in interface IRPFItemURI

Returns:

The pCompilationDate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaintenanceDate

public void setMaintenanceDate(String pMaintenanceDate)
                        throws IOException,
                               AutomationException

The maintenance date associated with the DTED file.

Product Availability

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

Specified by:

setMaintenanceDate in interface IRPFItemURI

Parameters:

pMaintenanceDate - The pMaintenanceDate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaintenanceDate

public String getMaintenanceDate()
                          throws IOException,
                                 AutomationException

The maintenance date associated with the DTED file.

Product Availability

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

Specified by:

getMaintenanceDate in interface IRPFItemURI

Returns:

The pMaintenanceDate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLatitude

public void setLatitude(String pLatitude)
                 throws IOException,
                        AutomationException

The latitude associated with the DTED file.

Product Availability

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

Specified by:

setLatitude in interface IRPFItemURI

Parameters:

pLatitude - The pLatitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLatitude

public String getLatitude()
                   throws IOException,
                          AutomationException

The latitude associated with the DTED file.

Product Availability

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

Specified by:

getLatitude in interface IRPFItemURI

Returns:

The pLatitude

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLongitude

public void setLongitude(String pLongitude)
                  throws IOException,
                         AutomationException

The longitude associated with the DTED file.

Product Availability

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

Specified by:

setLongitude in interface IRPFItemURI

Parameters:

pLongitude - The pLongitude (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLongitude

public String getLongitude()
                    throws IOException,
                           AutomationException

The longitude associated with the DTED file.

Product Availability

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

Specified by:

getLongitude in interface IRPFItemURI

Returns:

The pLongitude

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compare

public int compare(IItemURI pItemURI)
            throws IOException,
                   AutomationException

Compares the object with the specified item URI. Returns 0 if object = pItemURI, -1 if object < pItemURI, and +1 if object > pItemURI.

Product Availability

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

Specified by:

compare in interface IItemURICompare

Parameters:

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

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.