com.esri.arcgis.datasourcesraster
Class OverviewBuilder

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

All Implemented Interfaces:

IOverviewBuilder, IRasterBuilder, IRasterBuilder2, IRasterBuilderInit, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class OverviewBuilder
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterBuilder2, IRasterBuilderInit, IOverviewBuilder

A raster builder for overview datasets.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

OverviewBuilder()
Constructs a OverviewBuilder using ArcGIS Engine.

OverviewBuilder(Object obj)
Construct a OverviewBuilder using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

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(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(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(Object o) Compare this object with another
boolean	generateImage(IOverviewItemURI pItemURI) Generates the overview raster dataset associated with the specified overview item URI object.
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.
ICellSizeLevels	getCellSizeLevels() The cell size levels associated with the overview tiling schema.
static String	getClsid() getClsid.
ISpatialReference	getDefaultSpatialReference() The default spatial reference associated with the collection of items built by this raster type.
IMosaicDataset	getMosaicDataset() The mosaic dataset associated with this operation.
IItemURI	getNextURI() Returns the next available item URI object.
IDefineOverviewsParameters	getOverviewParameters() The parameters object that control how overview items are created.
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	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	setCellSizeLevelsByRef(ICellSizeLevels ppCellSizeLevels) The cell size levels associated with the overview tiling schema.
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	setOverviewParametersByRef(IDefineOverviewsParameters ppParameters) The parameters object that control how overview items are created.
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

OverviewBuilder

public OverviewBuilder()
                throws IOException,
                       UnknownHostException

Constructs a OverviewBuilder using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

OverviewBuilder

public OverviewBuilder(Object obj)
                throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

canBuild

public boolean canBuild(Object vtDataSource)
                 throws 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.

Product Availability

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

Specified by:

canBuild in interface IRasterBuilder2

Parameters:

vtDataSource - A Variant (in)

Returns:

The pbCanBuild

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

validate

public void validate()
              throws IOException,
                     AutomationException

Validates the raster builder.

Product Availability

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

Specified by:

validate in interface IRasterBuilder2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanMergeItems

public boolean isCanMergeItems()
                        throws IOException,
                               AutomationException

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

Product Availability

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

Specified by:

isCanMergeItems in interface IRasterBuilder2

Returns:

The pbCanMergeItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMergeItems

public boolean isMergeItems()
                     throws IOException,
                            AutomationException

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

Product Availability

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

Specified by:

isMergeItems in interface IRasterBuilder2

Returns:

The pbMergeItems

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMergeItems

public void setMergeItems(boolean pbMergeItems)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

setMergeItems in interface IRasterBuilder2

Parameters:

pbMergeItems - The pbMergeItems (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRecommendedCrawler

public IDataSourceCrawler getRecommendedCrawler(IPropertySet pDataSourceProperties)
                                         throws IOException,
                                                AutomationException

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

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beginConstruction

public void beginConstruction(IDataSourceCrawler pCrawler)
                       throws IOException,
                              AutomationException

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

Product Availability

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

Specified by:

beginConstruction in interface IRasterBuilder

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

constructURIs

public void constructURIs(Object crawlerItem)
                   throws IOException,
                          AutomationException

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

Product Availability

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

Specified by:

constructURIs in interface IRasterBuilder

Parameters:

crawlerItem - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNextURI

public IItemURI getNextURI()
                    throws IOException,
                           AutomationException

Returns the next available item URI object.

Product Availability

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

Specified by:

getNextURI in interface IRasterBuilder

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.

endConstruction

public IItemURIArray endConstruction()
                              throws 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.????&

Product Availability

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

Specified by:

endConstruction in interface IRasterBuilder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStale

public boolean isStale(IItemURI pItemURI)
                throws IOException,
                       AutomationException

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

Product Availability

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

Specified by:

isStale in interface IRasterBuilder

Parameters:

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

Returns:

The pIsStale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

build

public IBuilderItem build(IItemURI pItemURI)
                   throws IOException,
                          AutomationException

Construct a builder item using the specified item URI.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

public void setPropertiesByRef(IPropertySet ppBuilderPoperties)
                        throws IOException,
                               AutomationException

The raster dataset builder properties.

Product Availability

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

Specified by:

setPropertiesByRef in interface IRasterBuilder

Parameters:

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

getProperties

public IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

The raster dataset builder properties.

Product Availability

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

Specified by:

getProperties in interface IRasterBuilder

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.

setAuxiliaryFieldsByRef

public void setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields)
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Specified by:

setAuxiliaryFieldsByRef in interface IRasterBuilder

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAuxiliaryFields

public IFields getAuxiliaryFields()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

getAuxiliaryFields in interface IRasterBuilder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAuxiliaryFieldAliasByRef

public void setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap)
                                 throws IOException,
                                        AutomationException

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

Product Availability

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

Specified by:

setAuxiliaryFieldAliasByRef in interface IRasterBuilder

Parameters:

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

getAuxiliaryFieldAlias

public IPropertySet getAuxiliaryFieldAlias()
                                    throws IOException,
                                           AutomationException

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

Product Availability

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

Specified by:

getAuxiliaryFieldAlias in interface IRasterBuilder

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.

isCanBuildInPlace

public boolean isCanBuildInPlace()
                          throws IOException,
                                 AutomationException

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

Product Availability

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

Specified by:

isCanBuildInPlace in interface IRasterBuilder

Returns:

The pbCanBuildInPlace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMosaicDatasetByRef

public void setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
                           throws IOException,
                                  AutomationException

The mosaic dataset associated with this operation.

Product Availability

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

Specified by:

setMosaicDatasetByRef in interface IRasterBuilderInit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMosaicDataset

public IMosaicDataset getMosaicDataset()
                                throws IOException,
                                       AutomationException

The mosaic dataset associated with this operation.

Product Availability

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

Specified by:

getMosaicDataset in interface IRasterBuilderInit

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrackCancelByRef

public void setTrackCancelByRef(ITrackCancel ppTrackCancel)
                         throws IOException,
                                AutomationException

The cancel tracker associated with this operation.

Product Availability

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

Specified by:

setTrackCancelByRef in interface IRasterBuilderInit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrackCancel

public ITrackCancel getTrackCancel()
                            throws IOException,
                                   AutomationException

The cancel tracker associated with this operation.

Product Availability

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

Specified by:

getTrackCancel in interface IRasterBuilderInit

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultSpatialReferenceByRef

public void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
                                     throws 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.

Product Availability

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

Specified by:

setDefaultSpatialReferenceByRef in interface IRasterBuilderInit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultSpatialReference

public ISpatialReference getDefaultSpatialReference()
                                             throws 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.

Product Availability

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

Specified by:

getDefaultSpatialReference in interface IRasterBuilderInit

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterTypeOperationByRef

public void setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation)
                                 throws 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.

Product Availability

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

Specified by:

setRasterTypeOperationByRef in interface IRasterBuilderInit

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterTypeOperation

public IRasterTypeOperation getRasterTypeOperation()
                                            throws 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.

Product Availability

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

Specified by:

getRasterTypeOperation in interface IRasterBuilderInit

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverviewParametersByRef

public void setOverviewParametersByRef(IDefineOverviewsParameters ppParameters)
                                throws IOException,
                                       AutomationException

The parameters object that control how overview items are created.

Product Availability

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

Specified by:

setOverviewParametersByRef in interface IOverviewBuilder

Parameters:

ppParameters - A reference to a com.esri.arcgis.datasourcesraster.IDefineOverviewsParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverviewParameters

public IDefineOverviewsParameters getOverviewParameters()
                                                 throws IOException,
                                                        AutomationException

The parameters object that control how overview items are created.

Product Availability

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

Specified by:

getOverviewParameters in interface IOverviewBuilder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellSizeLevelsByRef

public void setCellSizeLevelsByRef(ICellSizeLevels ppCellSizeLevels)
                            throws IOException,
                                   AutomationException

The cell size levels associated with the overview tiling schema.

Product Availability

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

Specified by:

setCellSizeLevelsByRef in interface IOverviewBuilder

Parameters:

ppCellSizeLevels - A reference to a com.esri.arcgis.datasourcesraster.ICellSizeLevels (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellSizeLevels

public ICellSizeLevels getCellSizeLevels()
                                  throws IOException,
                                         AutomationException

The cell size levels associated with the overview tiling schema.

Product Availability

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

Specified by:

getCellSizeLevels in interface IOverviewBuilder

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

generateImage

public boolean generateImage(IOverviewItemURI pItemURI)
                      throws IOException,
                             AutomationException

Generates the overview raster dataset associated with the specified overview item URI object.

Product Availability

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

Specified by:

generateImage in interface IOverviewBuilder

Parameters:

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

Returns:

The pbAllParticipantsOK

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.