com.esri.arcgis.datasourcesraster

Class BuilderItem

java.lang.Object

com.esri.arcgis.datasourcesraster.BuilderItem

All Implemented Interfaces:

IBuilderItem, IBuilderItem2, IBuilderItem3, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, java.io.Serializable

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

COM Class 'BuilderItem'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'An item built by a raster builder.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.datasourcesraster.IBuilderItem3

IID, IIDe0e41c47_72ec_4e66_8d6c_c6a90f6d1c21, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IBuilderItem2

IID607661ec_f105_4641_be8b_4f1cb0d6f48c

Fields inherited from interface com.esri.arcgis.datasourcesraster.IBuilderItem

IID49944736_3dd8_4e4e_b346_46868e0cf13f

Constructor Summary

Constructors

Constructor and Description
BuilderItem() Constructs a BuilderItem using ArcGIS Engine.
BuilderItem(java.lang.Object obj) Construct a BuilderItem using a reference to such an object returned from ArcGIS Engine or Server.

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.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
IPropertySet	getAuxiliaryFieldValues() The field values corresponding to the AuxiliaryFields of the parent raster builder described by a property set that maps field names to fields values.
int	getCategory() The catagory of builder item.
static java.lang.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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IGeometry	getSeamline() The seamline geometry associated with this builder item.
IPropertySet	getSeamlineProperties() Variables supporting seamline operation.
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.
java.lang.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	release() Release this COM object reference
void	setAuxiliaryFieldValuesByRef(IPropertySet ppAuxiliaryFieldValues) The field values corresponding to the AuxiliaryFields of the parent raster builder described by a property set that maps field names to fields values.
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(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	setThumbnail(java.lang.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

Constructor Detail

BuilderItem

public BuilderItem()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a BuilderItem using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BuilderItem

public BuilderItem(java.lang.Object obj)
            throws java.io.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:

java.io.IOException - if there are interop problems BuilderItem theBuilderItem = (BuilderItem) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setURIByRef

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

The URI object associated with the builder item.

Specified by:

setURIByRef in interface IBuilderItem

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

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

The URI object associated with the builder item.

Specified by:

getURI in interface IBuilderItem

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

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

The function raster dataset associated with builder item.

Specified by:

setDatasetByRef in interface IBuilderItem

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

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

The function raster dataset associated with builder item.

Specified by:

getDataset in interface IBuilderItem

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

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

Specified by:

getFootprint in interface IBuilderItem

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

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

Specified by:

setFootprintByRef in interface IBuilderItem

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

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

The seamline geometry associated with this builder item.

Specified by:

getSeamline in interface IBuilderItem

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

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

The seamline geometry associated with this builder item.

Specified by:

setSeamlineByRef in interface IBuilderItem

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

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

The stereo ID associated with this builder item.

Specified by:

setStereoID in interface IBuilderItem

Parameters:

pStereoID - The pStereoID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStereoID

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

The stereo ID associated with this builder item.

Specified by:

getStereoID in interface IBuilderItem

Returns:

The pStereoID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStereoPairsByRef

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

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

Specified by:

setStereoPairsByRef in interface IBuilderItem

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

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

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

Specified by:

getStereoPairs in interface IBuilderItem

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

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

The collection of variables associated with this item.

Specified by:

setVariablesByRef in interface IBuilderItem

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

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

The collection of variables associated with this item.

Specified by:

getVariables in interface IBuilderItem

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

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

Specified by:

addVariable in interface IBuilderItem

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

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

Specified by:

setCategory in interface IBuilderItem

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

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

Specified by:

getCategory in interface IBuilderItem

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.

setDatasetNameByRef

public void setDatasetNameByRef(IName ppDatasetName)
                         throws java.io.IOException,
                                AutomationException

The raster dataset name associated with builder item.

Specified by:

setDatasetNameByRef in interface IBuilderItem2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetName

public IName getDatasetName()
                     throws java.io.IOException,
                            AutomationException

The raster dataset name associated with builder item.

Specified by:

getDatasetName in interface IBuilderItem2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSeamlinePropertiesByRef

public void setSeamlinePropertiesByRef(IPropertySet ppPropertySet)
                                throws java.io.IOException,
                                       AutomationException

Variables supporting seamline operation.

Specified by:

setSeamlinePropertiesByRef in interface IBuilderItem2

Parameters:

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

getSeamlineProperties

public IPropertySet getSeamlineProperties()
                                   throws java.io.IOException,
                                          AutomationException

Variables supporting seamline operation.

Specified by:

getSeamlineProperties in interface IBuilderItem2

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.

setColorCorrectionPropertiesByRef

public void setColorCorrectionPropertiesByRef(IPropertySet ppPropertySet)
                                       throws java.io.IOException,
                                              AutomationException

Variables supporting color correction operation.

Specified by:

setColorCorrectionPropertiesByRef in interface IBuilderItem2

Parameters:

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

getColorCorrectionProperties

public IPropertySet getColorCorrectionProperties()
                                          throws java.io.IOException,
                                                 AutomationException

Variables supporting color correction operation.

Specified by:

getColorCorrectionProperties in interface IBuilderItem2

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.

isHasThumbnail

public boolean isHasThumbnail()
                       throws java.io.IOException,
                              AutomationException

Indicates whether the builder item has a valid thumbnail.

Specified by:

isHasThumbnail in interface IBuilderItem2

Returns:

The pbHasThumbnail

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setThumbnail

public void setThumbnail(java.lang.Object pvtThumbnailBlob)
                  throws java.io.IOException,
                         AutomationException

The thumbnail associated with the builder item.

Specified by:

setThumbnail in interface IBuilderItem2

Parameters:

pvtThumbnailBlob - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public java.lang.Object getThumbnail()
                              throws java.io.IOException,
                                     AutomationException

The thumbnail associated with the builder item.

Specified by:

getThumbnail in interface IBuilderItem2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryFieldValuesByRef

public void setAuxiliaryFieldValuesByRef(IPropertySet ppAuxiliaryFieldValues)
                                  throws java.io.IOException,
                                         AutomationException

The field values corresponding to the AuxiliaryFields of the parent raster builder described by a property set that maps field names to fields values. These values take precedence over metadata from the BuilderItem's function raster dataset.

Specified by:

setAuxiliaryFieldValuesByRef in interface IBuilderItem3

Parameters:

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

getAuxiliaryFieldValues

public IPropertySet getAuxiliaryFieldValues()
                                     throws java.io.IOException,
                                            AutomationException

The field values corresponding to the AuxiliaryFields of the parent raster builder described by a property set that maps field names to fields values. These values take precedence over metadata from the BuilderItem's function raster dataset.

Specified by:

getAuxiliaryFieldValues in interface IBuilderItem3

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.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.