Class RasterDatasetBuilderClass

Namespace
ESRI.ArcGIS.DatasourcesRaster
Assembly
ESRI.Server.DatasourcesRaster.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("62F7D26F-0053-4514-B9F5-E58A1B0AAB84")]
public class RasterDatasetBuilderClass : RasterDatasetBuilder, IRasterBuilder3, IRasterBuilder2, IRasterBuilder, IRasterBuilderInit, IRasterDatasetBuilder
Inheritance
RasterDatasetBuilderClass
Implements
Inherited Members

Constructors

RasterDatasetBuilderClass()

public RasterDatasetBuilderClass()

Explicit Interface Implementations

AuxiliaryFieldAlias

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

virtual IPropertySet AuxiliaryFieldAlias { get; set; }

Returns

IPropertySet

AuxiliaryFields

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

virtual IFields AuxiliaryFields { get; set; }

Returns

IFields

BeginConstruction(IDataSourceCrawler)

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

virtual void BeginConstruction(IDataSourceCrawler pCrawler)

Parameters

pCrawler IDataSourceCrawler

Build(IItemURI)

Construct a builder item using the specified item URI.

virtual IBuilderItem Build(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

IBuilderItem

CanBuild(object)

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

virtual bool CanBuild(object vtDataSource)

Parameters

vtDataSource object

Returns

bool

CanBuildInPlace

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

virtual bool CanBuildInPlace { get; }

Returns

bool

CanMergeItems

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

virtual bool CanMergeItems { get; }

Returns

bool

CanUpdate(IRasterFunctionTemplate)

Indicates whether the raster builder is capable of updating a raster function template.

virtual bool CanUpdate(IRasterFunctionTemplate pFunctionTemplate)

Parameters

pFunctionTemplate IRasterFunctionTemplate

Returns

bool

ConstructURIs(object)

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

virtual void ConstructURIs(object crawlerItem)

Parameters

crawlerItem object

DefaultSpatialReference

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.

virtual ISpatialReference DefaultSpatialReference { get; set; }

Returns

ISpatialReference

EndConstruction()

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.

virtual IItemURIArray EndConstruction()

Returns

IItemURIArray

GetNextURI()

Returns the next available item URI object.

virtual IItemURI GetNextURI()

Returns

IItemURI

GetRecommendedCrawler(IPropertySet)

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

virtual IDataSourceCrawler GetRecommendedCrawler(IPropertySet pDataSourceProperties)

Parameters

pDataSourceProperties IPropertySet

Returns

IDataSourceCrawler

IRasterBuilder2_AuxiliaryFieldAlias

virtual IPropertySet IRasterBuilder2_AuxiliaryFieldAlias { get; set; }

Returns

IPropertySet

IRasterBuilder2_AuxiliaryFields

virtual IFields IRasterBuilder2_AuxiliaryFields { get; set; }

Returns

IFields

IRasterBuilder2_BeginConstruction(IDataSourceCrawler)

virtual void IRasterBuilder2_BeginConstruction(IDataSourceCrawler pCrawler)

Parameters

pCrawler IDataSourceCrawler

IRasterBuilder2_Build(IItemURI)

virtual IBuilderItem IRasterBuilder2_Build(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

IBuilderItem

IRasterBuilder2_CanBuildInPlace

virtual bool IRasterBuilder2_CanBuildInPlace { get; }

Returns

bool

IRasterBuilder2_ConstructURIs(object)

virtual void IRasterBuilder2_ConstructURIs(object crawlerItem)

Parameters

crawlerItem object

IRasterBuilder2_EndConstruction()

virtual IItemURIArray IRasterBuilder2_EndConstruction()

Returns

IItemURIArray

IRasterBuilder2_GetNextURI()

virtual IItemURI IRasterBuilder2_GetNextURI()

Returns

IItemURI

IRasterBuilder2_GetRecommendedCrawler(IPropertySet)

virtual IDataSourceCrawler IRasterBuilder2_GetRecommendedCrawler(IPropertySet pDataSourceProperties)

Parameters

pDataSourceProperties IPropertySet

Returns

IDataSourceCrawler

IRasterBuilder2_IsStale(IItemURI)

virtual bool IRasterBuilder2_IsStale(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

bool

IRasterBuilder2_Properties

virtual IPropertySet IRasterBuilder2_Properties { get; set; }

Returns

IPropertySet

IRasterBuilder3_AuxiliaryFieldAlias

virtual IPropertySet IRasterBuilder3_AuxiliaryFieldAlias { get; set; }

Returns

IPropertySet

IRasterBuilder3_AuxiliaryFields

virtual IFields IRasterBuilder3_AuxiliaryFields { get; set; }

Returns

IFields

IRasterBuilder3_BeginConstruction(IDataSourceCrawler)

virtual void IRasterBuilder3_BeginConstruction(IDataSourceCrawler pCrawler)

Parameters

pCrawler IDataSourceCrawler

IRasterBuilder3_Build(IItemURI)

virtual IBuilderItem IRasterBuilder3_Build(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

IBuilderItem

IRasterBuilder3_CanBuild(object)

virtual bool IRasterBuilder3_CanBuild(object vtDataSource)

Parameters

vtDataSource object

Returns

bool

IRasterBuilder3_CanBuildInPlace

virtual bool IRasterBuilder3_CanBuildInPlace { get; }

Returns

bool

IRasterBuilder3_CanMergeItems

virtual bool IRasterBuilder3_CanMergeItems { get; }

Returns

bool

IRasterBuilder3_ConstructURIs(object)

virtual void IRasterBuilder3_ConstructURIs(object crawlerItem)

Parameters

crawlerItem object

IRasterBuilder3_EndConstruction()

virtual IItemURIArray IRasterBuilder3_EndConstruction()

Returns

IItemURIArray

IRasterBuilder3_GetNextURI()

virtual IItemURI IRasterBuilder3_GetNextURI()

Returns

IItemURI

IRasterBuilder3_GetRecommendedCrawler(IPropertySet)

virtual IDataSourceCrawler IRasterBuilder3_GetRecommendedCrawler(IPropertySet pDataSourceProperties)

Parameters

pDataSourceProperties IPropertySet

Returns

IDataSourceCrawler

IRasterBuilder3_IsStale(IItemURI)

virtual bool IRasterBuilder3_IsStale(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

bool

IRasterBuilder3_MergeItems

virtual bool IRasterBuilder3_MergeItems { get; set; }

Returns

bool

IRasterBuilder3_Properties

virtual IPropertySet IRasterBuilder3_Properties { get; set; }

Returns

IPropertySet

IRasterBuilder3_Validate()

virtual void IRasterBuilder3_Validate()

IsStale(IItemURI)

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

virtual bool IsStale(IItemURI pItemURI)

Parameters

pItemURI IItemURI

Returns

bool

MergeItems

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

virtual bool MergeItems { get; set; }

Returns

bool

MosaicDataset

The mosaic dataset associated with this operation.

virtual IMosaicDataset MosaicDataset { get; set; }

Returns

IMosaicDataset

MultidimensionalInfo

The multidimensional info object associated with the raster builder. The information contained within this object is updated each time a new item is built.

virtual IMultidimensionalInfo MultidimensionalInfo { get; set; }

Returns

IMultidimensionalInfo

Properties

The raster dataset builder properties.

virtual IPropertySet Properties { get; set; }

Returns

IPropertySet

RasterTypeOperation

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.

virtual IRasterTypeOperation RasterTypeOperation { get; set; }

Returns

IRasterTypeOperation

ReviewBuilderItem(IBuilderItem)

Review and (optionally) update the final builder item generated by the parent raster type.

virtual void ReviewBuilderItem(IBuilderItem pBuilderItem)

Parameters

pBuilderItem IBuilderItem

ReviewItemURI(IItemURI)

Review and (optionally) update the final item URI constructed by the parent raster type.

virtual void ReviewItemURI(IItemURI pItemURI)

Parameters

pItemURI IItemURI

TrackCancel

The cancel tracker associated with this operation.

virtual ITrackCancel TrackCancel { get; set; }

Returns

ITrackCancel

Update(IItemURI, IRasterFunctionTemplate, IPropertySet)

Updates the specified function template and template arguments using information associated with the specified item URI. This method allows a raster builder to modify the function template before the output builder item is constructed by the raster type.

virtual void Update(IItemURI pItemURI, IRasterFunctionTemplate pFunctionTemplate, IPropertySet pArguments)

Parameters

pItemURI IItemURI
pFunctionTemplate IRasterFunctionTemplate
pArguments IPropertySet

Validate()

Validates the raster builder.

virtual void Validate()