com.esri.arcgis.datasourcesraster

Class RCMBuilder

java.lang.Object

com.esri.arcgis.datasourcesraster.RCMBuilder

All Implemented Interfaces:

IRasterBuilder, IRasterBuilder2, IRasterBuilderInit, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RCMBuilder
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterBuilder2, IRasterBuilderInit

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

Description 'A raster builder for RCM data.' 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.IRasterBuilder2

IID, IIDec840d20_97c0_40a6_b86a_05179c79a745, xxDummy

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

IIDb2e3f2d4_5182_4299_aff5_41e5c9017d4f

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

IID, IIDd8e71e5a_401b_43a8_a55d_46881c51134c, xxDummy

Constructor Summary

Constructors

Constructor and Description
RCMBuilder() Constructs a RCMBuilder using ArcGIS Engine.
RCMBuilder(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RCMBuilder theRCMBuilder = (RCMBuilder) obj;

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.
boolean	canBuild(java.lang.Object vtDataSource) Indicates whether the raster builder recognizes the specified data source and is possibly capable of building a valid function raster dataset from it.
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.
boolean	equals(java.lang.Object o) Compare this object with another
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.
static java.lang.String	getClsid() getClsid.
ISpatialReference	getDefaultSpatialReference() The default spatial reference associated with the collection of items built by this raster type.
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.
IMosaicDataset	getMosaicDataset() The mosaic dataset associated with this operation.
IItemURI	getNextURI() Returns the next available item URI object.
IPropertySet	getProperties() The raster dataset builder properties.
IRasterTypeOperation	getRasterTypeOperation() The raster type operation helper object associated with this raster type.
IDataSourceCrawler	getRecommendedCrawler(IPropertySet pDataSourceProperties) Returns a crawler best suited for data source as recommended by the raster builder.
ITrackCancel	getTrackCancel() The cancel tracker associated with this operation.
int	hashCode() the hashcode for this object
boolean	isCanBuildInPlace() Indicates whether the raster type can build an item URI as soon as it is contructed.
boolean	isCanMergeItems() Indicates whether the raster builder is capable of building composite crawled items.
boolean	isMergeItems() Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
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	release() Release this COM object reference
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	setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) The default spatial reference associated with the collection of items built by this raster type.
void	setMergeItems(boolean pbMergeItems) Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
void	setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) The mosaic dataset associated with this operation.
void	setPropertiesByRef(IPropertySet ppBuilderPoperties) The raster dataset builder properties.
void	setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation) The raster type operation helper object associated with this raster type.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The cancel tracker associated with this operation.
void	validate() Validates the raster builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

RCMBuilder

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

Constructs a RCMBuilder using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RCMBuilder

public RCMBuilder(java.lang.Object obj)
           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RCMBuilder theRCMBuilder = (RCMBuilder) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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

canBuild

public boolean canBuild(java.lang.Object vtDataSource)
                 throws java.io.IOException,
                        AutomationException

Indicates whether the raster builder recognizes the specified data source and is possibly capable of building a valid function raster dataset from it.

Specified by:

canBuild in interface IRasterBuilder2

Parameters:

vtDataSource - A Variant (in)

Returns:

The pbCanBuild

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validate

public void validate()
              throws java.io.IOException,
                     AutomationException

Validates the raster builder.

Specified by:

validate in interface IRasterBuilder2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanMergeItems

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

Indicates whether the raster builder is capable of building composite crawled items.

Specified by:

isCanMergeItems in interface IRasterBuilder2

Returns:

The pbCanMergeItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMergeItems

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

Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.

Specified by:

isMergeItems in interface IRasterBuilder2

Returns:

The pbMergeItems

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMergeItems

public void setMergeItems(boolean pbMergeItems)
                   throws java.io.IOException,
                          AutomationException

Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.

Specified by:

setMergeItems in interface IRasterBuilder2

Parameters:

pbMergeItems - The pbMergeItems (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRecommendedCrawler

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

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

Specified by:

getRecommendedCrawler in interface IRasterBuilder

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

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

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

Specified by:

beginConstruction in interface IRasterBuilder

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

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

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

Specified by:

constructURIs in interface IRasterBuilder

Parameters:

crawlerItem - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNextURI

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

Returns the next available item URI object.

Specified by:

getNextURI in interface IRasterBuilder

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

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

Specified by:

endConstruction in interface IRasterBuilder

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

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

Specified by:

isStale in interface IRasterBuilder

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

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

Construct a builder item using the specified item URI.

Specified by:

build in interface IRasterBuilder

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

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

The raster dataset builder properties.

Specified by:

setPropertiesByRef in interface IRasterBuilder

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

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

The raster dataset builder properties.

Specified by:

getProperties in interface IRasterBuilder

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

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

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

Specified by:

setAuxiliaryFieldsByRef in interface IRasterBuilder

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

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

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

Specified by:

getAuxiliaryFields in interface IRasterBuilder

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

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

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

Specified by:

setAuxiliaryFieldAliasByRef in interface IRasterBuilder

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

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

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

Specified by:

getAuxiliaryFieldAlias in interface IRasterBuilder

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

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

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

Specified by:

isCanBuildInPlace in interface IRasterBuilder

Returns:

The pbCanBuildInPlace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMosaicDatasetByRef

public void setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
                           throws java.io.IOException,
                                  AutomationException

The mosaic dataset associated with this operation.

Specified by:

setMosaicDatasetByRef in interface IRasterBuilderInit

Parameters:

ppMosaicDataset - A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMosaicDataset

public IMosaicDataset getMosaicDataset()
                                throws java.io.IOException,
                                       AutomationException

The mosaic dataset associated with this operation.

Specified by:

getMosaicDataset in interface IRasterBuilderInit

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws java.io.IOException,
                                AutomationException

The cancel tracker associated with this operation.

Specified by:

setTrackCancelByRef in interface IRasterBuilderInit

Parameters:

ppTrackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws java.io.IOException,
                                   AutomationException

The cancel tracker associated with this operation.

Specified by:

getTrackCancel in interface IRasterBuilderInit

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSpatialReferenceByRef

public void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
                                     throws java.io.IOException,
                                            AutomationException

The default spatial reference associated with the collection of items built by this raster type. A raster type applies the default spatial reference to every incoming dataset that doesn't have an associated spatial reference.

Specified by:

setDefaultSpatialReferenceByRef in interface IRasterBuilderInit

Parameters:

ppDefaultSrs - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

public ISpatialReference getDefaultSpatialReference()
                                             throws java.io.IOException,
                                                    AutomationException

The default spatial reference associated with the collection of items built by this raster type. A raster type applies the default spatial reference to every incoming dataset that doesn't have an associated spatial reference.

Specified by:

getDefaultSpatialReference in interface IRasterBuilderInit

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterTypeOperationByRef

public void setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation)
                                 throws java.io.IOException,
                                        AutomationException

The raster type operation helper object associated with this raster type. It provides the raster type with functions that aid construction of URIs and builder items.

Specified by:

setRasterTypeOperationByRef in interface IRasterBuilderInit

Parameters:

ppRasterTypeOperation - A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeOperation (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterTypeOperation

public IRasterTypeOperation getRasterTypeOperation()
                                            throws java.io.IOException,
                                                   AutomationException

The raster type operation helper object associated with this raster type. It provides the raster type with functions that aid construction of URIs and builder items.

Specified by:

getRasterTypeOperation in interface IRasterBuilderInit

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.