com.esri.arcgis.datasourcesraster

Class FileItemURI

java.lang.Object

com.esri.arcgis.datasourcesraster.FileItemURI

All Implemented Interfaces:

IFileItemURI, IItemPaths, IItemPaths2, IItemURI, IItemURI2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class FileItemURI
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURI, IItemURI2, IItemPaths, IItemPaths2, IFileItemURI

COM Class 'FileItemURI'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An item URI that identifes a file.' 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.IItemURI2

IID, IID441dbe58_23ee_4296_9a3b_fdb44027b828, xxDummy

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

IID0fc1719b_b1aa_4d23_af07_932490a18075

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

IID, IID9c76b127_61ac_4e66_99b0_8c14a9a386ea, xxDummy

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

IIDcafd4e87_0672_43e0_b92d_175306c1a309

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

IID, IID522e65b4_ff5e_4e61_ac22_a5ba51a73f12, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.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 java.lang.String	getClsid() getClsid.
java.lang.String	getDisplayName() The friendly-name identifying this item in the mosaic dataset.
java.lang.String	getFilePath() The path to the file associated with this item URI.
java.lang.String	getGroup() The name of the collection to which the item belongs.
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	getKey() A phrase that uniquely identifies the item's data source in the mosaic dataset.
IStringArray	getPaths() Returns all paths associated with the object.
IStringArray	getPathsEx(IItemPathsOptions pOptions) Returns all paths associated with the object.
java.lang.String	getProductName() The name of the sensor product associated with the item's data source.
IPropertySet	getProperties() The item uri properties.
java.util.Date	getSourceTimeStamp() The timestamp associated with the data source referenced by this item URI.
java.lang.String	getTag() The unique identifier of the item within a group.
int	hashCode() the hashcode for this object
void	release() Release this COM object reference
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(java.lang.String pDisplayName) The friendly-name identifying this item in the mosaic dataset.
void	setFilePath(java.lang.String pFilePath) The path to the file associated with this item URI.
void	setGroup(java.lang.String pItemGroup) The name of the collection to which the item belongs.
void	setKey(java.lang.String pKeyString) A phrase that uniquely identifies the item's data source in the mosaic dataset.
void	setProductName(java.lang.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(java.util.Date pSourceTimeStamp) The timestamp associated with the data source referenced by this item URI.
void	setTag(java.lang.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

Constructor Detail

FileItemURI

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

Constructs a FileItemURI using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FileItemURI

public FileItemURI(java.lang.Object obj)
            throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems FileItemURI theFileItemURI = (FileItemURI) 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

setKey

public void setKey(java.lang.String pKeyString)
            throws java.io.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.

Specified by:

setKey in interface IItemURI

Parameters:

pKeyString - The pKeyString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKey

public java.lang.String getKey()
                        throws java.io.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.

Specified by:

getKey in interface IItemURI

Returns:

The pKeyString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTag

public void setTag(java.lang.String pItemTag)
            throws java.io.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.

Specified by:

setTag in interface IItemURI

Parameters:

pItemTag - The pItemTag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTag

public java.lang.String getTag()
                        throws java.io.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.

Specified by:

getTag in interface IItemURI

Returns:

The pItemTag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGroup

public void setGroup(java.lang.String pItemGroup)
              throws java.io.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.

Specified by:

setGroup in interface IItemURI

Parameters:

pItemGroup - The pItemGroup (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGroup

public java.lang.String getGroup()
                          throws java.io.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.

Specified by:

getGroup in interface IItemURI

Returns:

The pItemGroup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)
                    throws java.io.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.

Specified by:

setDisplayName in interface IItemURI

Parameters:

pDisplayName - The pDisplayName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.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.

Specified by:

getDisplayName in interface IItemURI

Returns:

The pDisplayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProductName

public void setProductName(java.lang.String pProductName)
                    throws java.io.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.

Specified by:

setProductName in interface IItemURI

Parameters:

pProductName - The pProductName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProductName

public java.lang.String getProductName()
                                throws java.io.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.

Specified by:

getProductName in interface IItemURI

Returns:

The pProductName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSourceTimeStamp

public void setSourceTimeStamp(java.util.Date pSourceTimeStamp)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:

setSourceTimeStamp in interface IItemURI

Parameters:

pSourceTimeStamp - The pSourceTimeStamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceTimeStamp

public java.util.Date getSourceTimeStamp()
                                  throws java.io.IOException,
                                         AutomationException

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

Specified by:

getSourceTimeStamp in interface IItemURI

Returns:

The pSourceTimeStamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryPathsByRef

public void setAuxiliaryPathsByRef(IStringArray ppAuxiliaryPaths)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

setAuxiliaryPathsByRef in interface IItemURI

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAuxiliaryPaths

public IStringArray getAuxiliaryPaths()
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

getAuxiliaryPaths in interface IItemURI

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppBuilderPoperties)
                        throws java.io.IOException,
                               AutomationException

The item uri properties.

Specified by:

setPropertiesByRef in interface IItemURI2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

The item uri properties.

Specified by:

getProperties in interface IItemURI2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws java.io.IOException,
                             AutomationException

Returns all paths associated with the object.

Specified by:

getPaths in interface IItemPaths

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws java.io.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.

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:

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

AutomationException - If the ArcObject component throws an exception.

getPathsEx

public IStringArray getPathsEx(IItemPathsOptions pOptions)
                        throws java.io.IOException,
                               AutomationException

Returns all paths associated with the object.

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:

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

AutomationException - If the ArcObject component throws an exception.

setFilePath

public void setFilePath(java.lang.String pFilePath)
                 throws java.io.IOException,
                        AutomationException

The path to the file associated with this item URI.

Specified by:

setFilePath in interface IFileItemURI

Parameters:

pFilePath - The pFilePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFilePath

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

The path to the file associated with this item URI.

Specified by:

getFilePath in interface IFileItemURI

Returns:

The pFilePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.