com.esri.arcgis.datasourcesraster
Class IBuilderItemProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.datasourcesraster.IBuilderItemProxy

All Implemented Interfaces:

IBuilderItem, Externalizable, Serializable

public class IBuilderItemProxy
extends com.esri.arcgis.interop.Dispatch
implements IBuilderItem, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IBuilderItemProxy()
	IBuilderItemProxy(Object obj)
protected	IBuilderItemProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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 that defines regions of valid pixels in the 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	removeListener(String iidStr, Object theListener)
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(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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IBuilderItemProxy

public IBuilderItemProxy()

IBuilderItemProxy

public IBuilderItemProxy(Object obj)
                  throws IOException

Throws:

IOException

IBuilderItemProxy

protected IBuilderItemProxy(Object obj,
                            String iid)
                     throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setURIByRef

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

Specified by:

setURIByRef in interface IBuilderItem

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

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

Specified by:

getURI in interface IBuilderItem

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

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

Specified by:

setDatasetByRef in interface IBuilderItem

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

public IFunctionRasterDataset getDataset()
                                  throws IOException,
                                         AutomationException

The function raster dataset associated with builder item.

Product Availability

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

Specified by:

getDataset in interface IBuilderItem

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

public IGeometry getFootprint()
                       throws 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.

Product Availability

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

Specified by:

getFootprint in interface IBuilderItem

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

public void setFootprintByRef(IGeometry ppFootprint)
                       throws 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.

Product Availability

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

Specified by:

setFootprintByRef in interface IBuilderItem

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

public IGeometry getSeamline()
                      throws IOException,
                             AutomationException

The seamline geometry associated with this builder item.

Product Availability

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

Specified by:

getSeamline in interface IBuilderItem

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

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

Specified by:

setSeamlineByRef in interface IBuilderItem

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

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

Specified by:

setStereoID in interface IBuilderItem

Parameters:

pStereoID - The pStereoID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStereoID

public String getStereoID()
                   throws IOException,
                          AutomationException

The stereo ID associated with this builder item.

Product Availability

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

Specified by:

getStereoID in interface IBuilderItem

Returns:

The pStereoID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStereoPairsByRef

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

Specified by:

setStereoPairsByRef in interface IBuilderItem

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

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

Specified by:

getStereoPairs in interface IBuilderItem

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

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

Specified by:

setVariablesByRef in interface IBuilderItem

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

public IPropertySet getVariables()
                          throws IOException,
                                 AutomationException

The collection of variables associated with this item.

Product Availability

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

Specified by:

getVariables in interface IBuilderItem

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

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

Specified by:

addVariable in interface IBuilderItem

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

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

Specified by:

setCategory in interface IBuilderItem

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

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

Specified by:

getCategory in interface IBuilderItem

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterCatalogItemCategory constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.