com.esri.arcgis.datasourcesraster

Interface IRasterBuilder

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IRasterBuilder2, IRasterBuilder3

All Known Implementing Classes:

ApplanixBuilder, AsterBuilder, DmciiBuilder, DubaisatBuilder, FrameCameraBuilder, HREBuilder, IkonosBuilder, IRasterBuilder2Proxy, IRasterBuilder3Proxy, IRasterBuilderProxy, ISATBuilder, ISDefBuilder, KompsatBuilder, LandsatBuilder, LandsatMSSBuilder, LandsatSurfaceReflectanceBuilder, LasBuilder, MatchATBuilder, MaxarBuilder, OverviewBuilder, PARMODBuilder, PixFileBuilder, PleiadesBuilder, PythonRasterBuilder, QuickBirdBuilder, RadarBuilder, RapidEyeBuilder, RasterDatasetBuilder, RasterType, RCMBuilder, RPDefBuilder, RPFBuilder, ScientificDataBuilder, SearchBuilder, Sentinel1Builder, Sentinel2Builder, Sentinel3Builder, SkySatBuilder, SocetSetBuilder, SpotBuilder, SuperViewBuilder, TableBuilder, TerrainBuilder, UavUasBuilder

public interface IRasterBuilder
extends java.io.Serializable

COM Interface 'IRasterBuilder'. Generated 9/21/2023 10:01:49 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	beginConstruction(IDataSourceCrawler pCrawler) Initializes the raster builder for URI construction given a valid data source crawler object.
IBuilderItem	build(IItemURI pItemURI) Construct a builder item using the specified item URI.
void	constructURIs(java.lang.Object crawlerItem) Constructs one or more item URI objects given the crawled data source item.
IItemURIArray	endConstruction() Shuts down the raster builder object upon completion of URI construction.
IPropertySet	getAuxiliaryFieldAlias() Optional look-up that maps field names to possile metadata property names.
IFields	getAuxiliaryFields() Fields to be created and populated in the raster catalog when a builder is used.
IItemURI	getNextURI() Returns the next available item URI object.
IPropertySet	getProperties() The raster dataset builder properties.
IDataSourceCrawler	getRecommendedCrawler(IPropertySet pDataSourceProperties) Returns a crawler best suited for data source as recommended by the raster builder.
boolean	isCanBuildInPlace() Indicates whether the raster type can build an item URI as soon as it is contructed.
boolean	isStale(IItemURI pItemURI) Indicates whether the data source referenced by the specified item URI has been updated since the item URI was last constructed.
void	setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap) Optional look-up that maps field names to possile metadata property names.
void	setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields) Fields to be created and populated in the raster catalog when a builder is used.
void	setPropertiesByRef(IPropertySet ppBuilderPoperties) The raster dataset builder properties.

Field Detail

IIDb2e3f2d4_5182_4299_aff5_41e5c9017d4f

static final int IIDb2e3f2d4_5182_4299_aff5_41e5c9017d4f

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

getRecommendedCrawler

IDataSourceCrawler getRecommendedCrawler(IPropertySet pDataSourceProperties)
                                  throws java.io.IOException,
                                         AutomationException

Returns a crawler best suited for data source as recommended by the raster builder.

Parameters:

pDataSourceProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beginConstruction

void beginConstruction(IDataSourceCrawler pCrawler)
                throws java.io.IOException,
                       AutomationException

Initializes the raster builder for URI construction given a valid data source crawler object.

Parameters:

pCrawler - A reference to a com.esri.arcgis.datasourcesraster.IDataSourceCrawler (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

constructURIs

void constructURIs(java.lang.Object crawlerItem)
            throws java.io.IOException,
                   AutomationException

Constructs one or more item URI objects given the crawled data source item.

Parameters:

crawlerItem - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextURI

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

Returns the next available item URI object.

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.

endConstruction

IItemURIArray endConstruction()
                       throws java.io.IOException,
                              AutomationException

Shuts down the raster builder object upon completion of URI construction. Once all item URIs are constructed and returned via repated calls to the GetNextURI, this method might return an array of item URIs possibly created as a result of the shut down process.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStale

boolean isStale(IItemURI pItemURI)
         throws java.io.IOException,
                AutomationException

Indicates whether the data source referenced by the specified item URI has been updated since the item URI was last constructed.

Parameters:

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

Returns:

The pIsStale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

build

IBuilderItem build(IItemURI pItemURI)
            throws java.io.IOException,
                   AutomationException

Construct a builder item using the specified item URI.

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

void setPropertiesByRef(IPropertySet ppBuilderPoperties)
                 throws java.io.IOException,
                        AutomationException

The raster dataset builder properties.

Parameters:

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

getProperties

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

The raster dataset builder properties.

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.

setAuxiliaryFieldsByRef

void setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields)
                      throws java.io.IOException,
                             AutomationException

Fields to be created and populated in the raster catalog when a builder is used.

Parameters:

ppAuxiliaryFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAuxiliaryFields

IFields getAuxiliaryFields()
                    throws java.io.IOException,
                           AutomationException

Fields to be created and populated in the raster catalog when a builder is used.

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryFieldAliasByRef

void setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap)
                          throws java.io.IOException,
                                 AutomationException

Optional look-up that maps field names to possile metadata property names.

Parameters:

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

getAuxiliaryFieldAlias

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

Optional look-up that maps field names to possile metadata property names.

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.

isCanBuildInPlace

boolean isCanBuildInPlace()
                   throws java.io.IOException,
                          AutomationException

Indicates whether the raster type can build an item URI as soon as it is contructed.

Returns:

The pbCanBuildInPlace

Throws:

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

AutomationException - If the ArcObject component throws an exception.