com.esri.arcgis.datasourcesraster

Interface IBuilderItem

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IBuilderItem2, IBuilderItem3

All Known Implementing Classes:

BuilderItem, IBuilderItem2Proxy, IBuilderItem3Proxy, IBuilderItemProxy

public interface IBuilderItem
extends java.io.Serializable

COM Interface 'IBuilderItem'. Generated 9/24/2024 11:01:31 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control a builder item.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID49944736_3dd8_4e4e_b346_46868e0cf13f
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	addVariable(java.lang.String variableName, java.lang.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 that defines regions of valid pixels in the dataset.
IGeometry	getSeamline() The seamline geometry associated with this builder item.
java.lang.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 that defines regions of valid pixels in the dataset.
void	setSeamlineByRef(IGeometry ppSeamline) The seamline geometry associated with this builder item.
void	setStereoID(java.lang.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.

Field Detail

IID49944736_3dd8_4e4e_b346_46868e0cf13f

static final int IID49944736_3dd8_4e4e_b346_46868e0cf13f

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setURIByRef

void setURIByRef(IItemURI ppItemURI)
          throws java.io.IOException,
                 AutomationException

The URI object associated with the builder item.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getURI

IItemURI getURI()
         throws java.io.IOException,
                AutomationException

The URI object associated with the builder item.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDatasetByRef

void setDatasetByRef(IFunctionRasterDataset ppDataset)
              throws java.io.IOException,
                     AutomationException

The function raster dataset associated with builder item.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataset

IFunctionRasterDataset getDataset()
                           throws java.io.IOException,
                                  AutomationException

The function raster dataset associated with builder item.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFootprint

IGeometry getFootprint()
                throws java.io.IOException,
                       AutomationException

The footprint geometry of the function raster dataset that defines regions of valid pixels in the dataset. The footprint geometry may have a coordinate system different from the corresponding dataset.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFootprintByRef

void setFootprintByRef(IGeometry ppFootprint)
                throws java.io.IOException,
                       AutomationException

The footprint geometry of the function raster dataset that defines regions of valid pixels in the dataset. The footprint geometry may have a coordinate system different from the corresponding dataset.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSeamline

IGeometry getSeamline()
               throws java.io.IOException,
                      AutomationException

The seamline geometry associated with this builder item.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSeamlineByRef

void setSeamlineByRef(IGeometry ppSeamline)
               throws java.io.IOException,
                      AutomationException

The seamline geometry associated with this builder item.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStereoID

void setStereoID(java.lang.String pStereoID)
          throws java.io.IOException,
                 AutomationException

The stereo ID associated with this builder item.

Parameters:

pStereoID - The pStereoID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStereoID

java.lang.String getStereoID()
                      throws java.io.IOException,
                             AutomationException

The stereo ID associated with this builder item.

Returns:

The pStereoID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStereoPairsByRef

void setStereoPairsByRef(IStringArray ppStereoPairs)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

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

getStereoPairs

IStringArray getStereoPairs()
                     throws java.io.IOException,
                            AutomationException

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

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.

setVariablesByRef

void setVariablesByRef(IPropertySet ppVariables)
                throws java.io.IOException,
                       AutomationException

The collection of variables associated with this item.

Parameters:

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

getVariables

IPropertySet getVariables()
                   throws java.io.IOException,
                          AutomationException

The collection of variables associated with this item.

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.

addVariable

void addVariable(java.lang.String variableName,
                 java.lang.Object vtVariableValue,
                 boolean bPrefixWithTag)
          throws java.io.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.

Parameters:

variableName - The variableName (in)

vtVariableValue - A Variant (in)

bPrefixWithTag - The bPrefixWithTag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

void setCategory(int pItemCategory)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

int getCategory()
         throws java.io.IOException,
                AutomationException

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

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterCatalogItemCategory constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.