com.esri.arcgis.datasourcesraster
Interface IBuilderItem

All Superinterfaces:

Serializable

All Known Implementing Classes:

BuilderItem, IBuilderItemProxy

public interface IBuilderItem
extends Serializable

Provides access to members that control a builder item.

Description

The IBuilderItem interface provides access to the members of a builder item. This item is generated by a Raster Builder.

Product Availability

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

Method Summary

void	addVariable(String variableName, Object vtVariableValue, boolean bPrefixWithTag) Adds a variable to this item's collection given the variable name, value, and a flag that indicates whether the item URI's tag is prefixed with the variable name and separated by a period.
int	getCategory() The catagory of builder item.
IFunctionRasterDataset	getDataset() The function raster dataset associated with builder item.
IGeometry	getFootprint() The footprint geometry of the function raster dataset.
IGeometry	getSeamline() The seamline geometry associated with this builder item.
String	getStereoID() The stereo ID associated with this builder item.
IStringArray	getStereoPairs() The stereo IDs of all items that can be paired with this builder item.
IItemURI	getURI() The URI object associated with the builder item.
IPropertySet	getVariables() The collection of variables associated with this item.
void	setCategory(int pItemCategory) The catagory of builder item.
void	setDatasetByRef(IFunctionRasterDataset ppDataset) The function raster dataset associated with builder item.
void	setFootprintByRef(IGeometry ppFootprint) The footprint geometry of the function raster dataset.
void	setSeamlineByRef(IGeometry ppSeamline) The seamline geometry associated with this builder item.
void	setStereoID(String pStereoID) The stereo ID associated with this builder item.
void	setStereoPairsByRef(IStringArray ppStereoPairs) The stereo IDs of all items that can be paired with this builder item.
void	setURIByRef(IItemURI ppItemURI) The URI object associated with the builder item.
void	setVariablesByRef(IPropertySet ppVariables) The collection of variables associated with this item.

Method Detail

setURIByRef

void setURIByRef(IItemURI ppItemURI)
                 throws IOException,
                        AutomationException

The URI object associated with the builder item.

Description

Unique Resource Identifier of the Builder Item.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURI

IItemURI getURI()
                throws IOException,
                       AutomationException

The URI object associated with the builder item.

Description

Unique Resource Identifier of the Builder Item.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetByRef

void setDatasetByRef(IFunctionRasterDataset ppDataset)
                     throws IOException,
                            AutomationException

The function raster dataset associated with builder item.

Product Availability

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

Parameters:

ppDataset - A reference to a com.esri.arcgis.datasourcesraster.IFunctionRasterDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataset

IFunctionRasterDataset getDataset()
                                  throws IOException,
                                         AutomationException

The function raster dataset associated with builder item.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFootprint

IGeometry getFootprint()
                       throws IOException,
                              AutomationException

The footprint geometry of the function raster dataset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFootprintByRef

void setFootprintByRef(IGeometry ppFootprint)
                       throws IOException,
                              AutomationException

The footprint geometry of the function raster dataset.

Product Availability

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

Parameters:

ppFootprint - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeamline

IGeometry getSeamline()
                      throws IOException,
                             AutomationException

The seamline geometry associated with this builder item.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeamlineByRef

void setSeamlineByRef(IGeometry ppSeamline)
                      throws IOException,
                             AutomationException

The seamline geometry associated with this builder item.

Product Availability

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

Parameters:

ppSeamline - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStereoID

void setStereoID(String pStereoID)
                 throws IOException,
                        AutomationException

The stereo ID associated with this builder item.

Product Availability

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

Parameters:

pStereoID - The pStereoID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStereoID

String getStereoID()
                   throws IOException,
                          AutomationException

The stereo ID associated with this builder item.

Product Availability

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

Returns:

The pStereoID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStereoPairsByRef

void setStereoPairsByRef(IStringArray ppStereoPairs)
                         throws IOException,
                                AutomationException

The stereo IDs of all items that can be paired with this builder item.

Product Availability

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

Parameters:

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

getStereoPairs

IStringArray getStereoPairs()
                            throws IOException,
                                   AutomationException

The stereo IDs of all items that can be paired with this builder item.

Product Availability

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

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.

setVariablesByRef

void setVariablesByRef(IPropertySet ppVariables)
                       throws IOException,
                              AutomationException

The collection of variables associated with this item.

Product Availability

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

Parameters:

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

getVariables

IPropertySet getVariables()
                          throws IOException,
                                 AutomationException

The collection of variables associated with this item.

Product Availability

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

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.

addVariable

void addVariable(String variableName,
                 Object vtVariableValue,
                 boolean bPrefixWithTag)
                 throws IOException,
                        AutomationException

Adds a variable to this item's collection given the variable name, value, and a flag that indicates whether the item URI's tag is prefixed with the variable name and separated by a period.

Product Availability

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

Parameters:

variableName - The variableName (in)

vtVariableValue - A Variant (in)

bPrefixWithTag - The bPrefixWithTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(int pItemCategory)
                 throws IOException,
                        AutomationException

The catagory of builder item. The value in this property appears in the Category field of the mosaic catalog.

Product Availability

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

Parameters:

pItemCategory - A com.esri.arcgis.datasourcesraster.esriRasterCatalogItemCategory constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

int getCategory()
                throws IOException,
                       AutomationException

The catagory of builder item. The value in this property appears in the Category field of the mosaic catalog.

Product Availability

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterCatalogItemCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.