com.esri.arcgis.datasourcesraster
Class BuilderItem

java.lang.Object
  com.esri.arcgis.datasourcesraster.BuilderItem

All Implemented Interfaces:

IBuilderItem, IBuilderItem2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, Serializable

public class BuilderItem
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBuilderItem, IBuilderItem2, IDocumentVersionSupportGEN

An item built by a raster builder.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

BuilderItem()
Constructs a BuilderItem using ArcGIS Engine.

BuilderItem(Object obj)
Construct a BuilderItem using a reference to such an object returned from ArcGIS Engine or 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.
Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
int	getCategory() The catagory of builder item.
static String	getClsid() getClsid.
IPropertySet	getColorCorrectionProperties() Variables supporting color correction operation.
IFunctionRasterDataset	getDataset() The function raster dataset associated with builder item.
IName	getDatasetName() The raster dataset name 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.
IPropertySet	getSeamlineProperties() Variables supporting seamline operation.
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.
Object	getThumbnail() The thumbnail associated with the builder item.
IItemURI	getURI() The URI object associated with the builder item.
IPropertySet	getVariables() The collection of variables associated with this item.
int	hashCode() the hashcode for this object
boolean	isHasThumbnail() Indicates whether the builder item has a valid thumbnail.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	setCategory(int pItemCategory) The catagory of builder item.
void	setColorCorrectionPropertiesByRef(IPropertySet ppPropertySet) Variables supporting color correction operation.
void	setDatasetByRef(IFunctionRasterDataset ppDataset) The function raster dataset associated with builder item.
void	setDatasetNameByRef(IName ppDatasetName) The raster dataset name 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	setSeamlinePropertiesByRef(IPropertySet ppPropertySet) Variables supporting seamline operation.
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	setThumbnail(Object pvtThumbnailBlob) The thumbnail associated with the 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 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

BuilderItem

public BuilderItem()
            throws IOException,
                   UnknownHostException

Constructs a BuilderItem using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BuilderItem

public BuilderItem(Object obj)
            throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems BuilderItem theBuilderItem = (BuilderItem) 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

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.

setDatasetNameByRef

public void setDatasetNameByRef(IName ppDatasetName)
                         throws IOException,
                                AutomationException

The raster dataset name associated with builder item.

Product Availability

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

Specified by:

setDatasetNameByRef in interface IBuilderItem2

Parameters:

ppDatasetName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetName

public IName getDatasetName()
                     throws IOException,
                            AutomationException

The raster dataset name associated with builder item.

Product Availability

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

Specified by:

getDatasetName in interface IBuilderItem2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSeamlinePropertiesByRef

public void setSeamlinePropertiesByRef(IPropertySet ppPropertySet)
                                throws IOException,
                                       AutomationException

Variables supporting seamline operation.

Product Availability

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

Specified by:

setSeamlinePropertiesByRef in interface IBuilderItem2

Parameters:

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

getSeamlineProperties

public IPropertySet getSeamlineProperties()
                                   throws IOException,
                                          AutomationException

Variables supporting seamline operation.

Product Availability

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

Specified by:

getSeamlineProperties in interface IBuilderItem2

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.

setColorCorrectionPropertiesByRef

public void setColorCorrectionPropertiesByRef(IPropertySet ppPropertySet)
                                       throws IOException,
                                              AutomationException

Variables supporting color correction operation.

Product Availability

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

Specified by:

setColorCorrectionPropertiesByRef in interface IBuilderItem2

Parameters:

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

getColorCorrectionProperties

public IPropertySet getColorCorrectionProperties()
                                          throws IOException,
                                                 AutomationException

Variables supporting color correction operation.

Product Availability

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

Specified by:

getColorCorrectionProperties in interface IBuilderItem2

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.

isHasThumbnail

public boolean isHasThumbnail()
                       throws IOException,
                              AutomationException

Indicates whether the builder item has a valid thumbnail.

Product Availability

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

Specified by:

isHasThumbnail in interface IBuilderItem2

Returns:

The pbHasThumbnail

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setThumbnail

public void setThumbnail(Object pvtThumbnailBlob)
                  throws IOException,
                         AutomationException

The thumbnail associated with the builder item.

Product Availability

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

Specified by:

setThumbnail in interface IBuilderItem2

Parameters:

pvtThumbnailBlob - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public Object getThumbnail()
                    throws IOException,
                           AutomationException

The thumbnail associated with the builder item.

Product Availability

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

Specified by:

getThumbnail in interface IBuilderItem2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.