com.esri.arcgis.datasourcesraster
Class CompositeItemURI

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.CompositeItemURI
All Implemented Interfaces:
ICompositeItemURI, IItemPaths, IItemPaths2, IItemURI, IItemURI2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class CompositeItemURI
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemURI, IItemURI2, IItemPaths, IItemPaths2, ICompositeItemURI

A composite item URI object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
CompositeItemURI()
          Constructs a CompositeItemURI using ArcGIS Engine.
CompositeItemURI(Object obj)
          Construct a CompositeItemURI 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 getAuxiliaryPartNames()
          Additional pieces of non-identifying information associated with the composite item URI object.
 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 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.
 IStringArray getKeyPartNames()
          An array of string phrases that, together, 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.
 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 setAuxiliaryPartNamesByRef(IStringArray ppAuxPartNames)
          Additional pieces of non-identifying information associated with the composite item URI object.
 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 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 setKeyPartNamesByRef(IStringArray ppKeyPartNames)
          An array of string phrases that, together, uniquely identifies the item's data source in the mosaic dataset.
 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

CompositeItemURI

public CompositeItemURI()
                 throws IOException,
                        UnknownHostException
Constructs a CompositeItemURI using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

CompositeItemURI

public CompositeItemURI(Object obj)
                 throws IOException
Construct a CompositeItemURI using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to CompositeItemURI.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems CompositeItemURI theCompositeItemURI = (CompositeItemURI) 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.

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.

setKeyPartNamesByRef

public void setKeyPartNamesByRef(IStringArray ppKeyPartNames)
                          throws IOException,
                                 AutomationException
An array of string phrases that, together, uniquely identifies the item's data source in the mosaic dataset. The values in this property are 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:
setKeyPartNamesByRef in interface ICompositeItemURI
Parameters:
ppKeyPartNames - 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.

getKeyPartNames

public IStringArray getKeyPartNames()
                             throws IOException,
                                    AutomationException
An array of string phrases that, together, uniquely identifies the item's data source in the mosaic dataset. The values in this property are 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:
getKeyPartNames in interface ICompositeItemURI
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.

setAuxiliaryPartNamesByRef

public void setAuxiliaryPartNamesByRef(IStringArray ppAuxPartNames)
                                throws IOException,
                                       AutomationException
Additional pieces of non-identifying information associated with the composite item URI object.

Product Availability

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

Specified by:
setAuxiliaryPartNamesByRef in interface ICompositeItemURI
Parameters:
ppAuxPartNames - 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.

getAuxiliaryPartNames

public IStringArray getAuxiliaryPartNames()
                                   throws IOException,
                                          AutomationException
Additional pieces of non-identifying information associated with the composite item URI object.

Product Availability

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

Specified by:
getAuxiliaryPartNames in interface ICompositeItemURI
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.