com.esri.arcgis.datasourcesraster
Class RasterType

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

All Implemented Interfaces:

IRasterBuilder, IRasterBuilderInit, IRasterType, IRasterTypeOperation, IRasterTypeProperties, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterType
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterType, IRasterTypeProperties, IRasterBuilder, IRasterBuilderInit, IRasterTypeOperation

A raster type object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

RasterType()
Constructs a RasterType using ArcGIS Engine.

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

Method Summary

IFunctionRasterDataset	applyOrthorectification(IFunctionRasterDataset pDataset) Adds (or updates) a geometric function associated with the function raster dataset.
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	clipDatasetToItemFootprint(IBuilderItem pBuilderItem) Clips the raster dataset to the associated footprint geometry referenced by the with specified builder item.
void	constructURIs(Object crawlerItem) Constructs one or more item URI objects given the crawled data source item.
IBuilderItem	createBuilderItem(IItemURI pItemURI, IRasterDataset pDataset, int eRasterCategory, ISpatialReference pDefaultRasterSrs, IGeometry pItemFootprint) Constructs a builder item object given an item URI and the associated raster dataset.
IItemURIArray	endConstruction() Shuts down the raster builder object upon completion of URI construction.
boolean	equals(Object o) Compare this object with another
IAddRastersParameters	getAddRastersParameters() The parameters controlling how rasters are added using this raster type.
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 String	getClsid() getClsid.
String	getDataSourceFilter() Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions.
IPropertySet	getDefaultParameters() The collection of all variables associated with all item templates contained in the raster type.
ISpatialReference	getDefaultSpatialReference() The default spatial reference associated with the collection of items built by this raster type.
String	getDescription() Description of the raster type.
Date	getFirstAddTimeStamp() The time when this raster type was first used for adding rasters to the mosaic dataset.
IName	getFullName() The full name of the raster type object.
int	getInputDataSourceTypes() The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.
IItemTemplateArray	getItemTemplates() The collection of item templates associated with the raster type.
Date	getLastAddTimeStamp() The time when this raster type was last used for adding rasters to the mosaic dataset.
Date	getLastSyncTimeStamp() The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
IMosaicDataset	getMosaicDataset() The mosaic dataset associated with this operation.
String	getName() Name of the raster type.
IItemURI	getNextURI() Returns the next available item URI object.
String	getOperationDescription() A user-identifiable description of the collection of items added by this raster type instance.
IGeometricFunctionArguments	getOrthorectificationParameters() The parameters controlling orthorectification of raster datasets built by this raster type.
IPropertySet	getParameters() Overriding parameter values bound to function variables.
IPropertySet	getProperties() The raster dataset builder properties.
IRasterBuilder	getRasterBuilder() The inner raster builder associated with the raster type.
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.
IArray	getSupportedURIFilters() Default URI filters supported by the raster type.
ISynchronizeParameters	getSynchronizeParameters() The parameters controlling how rasters are synchronized using this raster type instance.
ITrackCancel	getTrackCancel() The cancel tracker associated with this opertion.
IItemURIFilter	getURIFilter() The active URI filter associated with the raster type.
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	isEnableClipToFootprint() Indicates whether datasets are clipped to their footprints.
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.
boolean	isSupportsOrthorectification() Indicates whether the raster type supports orthorectification.
boolean	isSupportsSeamline() Indicates whether the raster type supports seamline.
boolean	isSupportsStereo() Indicates whether the raster type supports stereo.
IRasterDataset	openRasterDataset(String dataSource, IRasterInfo pRasterInfo, boolean overwrite) Opens a raster dataset even if it does not exist.
void	processItem(IBuilderItem pBuilderItem) Builds pyramids and computes statistics for all raster dataset referenced by the top-level function raster dataset in the builder item.
void	setAddRastersParameters(IAddRastersParameters ppAddRastersParameters) The parameters controlling how rasters are added using this raster type.
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	setDataSourceFilter(String pDataSourceFilter) Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions.
void	setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) The default spatial reference associated with the collection of items built by this raster type.
void	setDescription(String pRasterTypeDescription) Description of the raster type.
void	setEnableClipToFootprint(boolean pbEnableClipToFootprint) Indicates whether datasets are clipped to their footprints.
void	setFirstAddTimeStamp(Date pFirstAddTimeStamp) The time when this raster type was first used for adding rasters to the mosaic dataset.
void	setFullNameByRef(IName ppRasterTypeName) The full name of the raster type object.
void	setInputDataSourceTypes(int pInputDataSourceTypes) The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.
void	setItemTemplatesByRef(IItemTemplateArray ppItemTemplateArray) The collection of item templates associated with the raster type.
void	setLastAddTimeStamp(Date pLastAddTimeStamp) The time when this raster type was last used for adding rasters to the mosaic dataset.
void	setLastSyncTimeStamp(Date pLastSyncTimeStamp) The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
void	setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) The mosaic dataset associated with this operation.
void	setName(String pRasterTypeName) Name of the raster type.
void	setOperationDescription(String pOperationDescription) A user-identifiable description of the collection of items added by this raster type instance.
void	setOrthorectificationParametersByRef(IGeometricFunctionArguments ppIGeometricFunctionArguments) The parameters controlling orthorectification of raster datasets built by this raster type.
void	setParametersByRef(IPropertySet ppInputParameters) Overriding parameter values bound to function variables.
void	setPropertiesByRef(IPropertySet ppBuilderPoperties) The raster dataset builder properties.
void	setRasterBuilderByRef(IRasterBuilder ppRasterBuilder) The inner raster builder associated with the raster type.
void	setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation) The raster type operation helper object associated with this raster type.
void	setSupportedURIFiltersByRef(IArray pppItemURIFilterArray) Default URI filters supported by the raster type.
void	setSupportsOrthorectification(boolean pbSupportsOrthorectification) Indicates whether the raster type supports orthorectification.
void	setSupportsSeamline(boolean pbSupportsSeamline) Indicates whether the raster type supports seamline.
void	setSupportsStereo(boolean pbSupportsStereo) Indicates whether the raster type supports stereo.
void	setSynchronizeParameters(ISynchronizeParameters ppSynchronizeParameters) The parameters controlling how rasters are synchronized using this raster type instance.
void	setTrackCancelByRef(ITrackCancel ppTrackCancel) The cancel tracker associated with this opertion.
void	setURIFilterByRef(IItemURIFilter ppItemURIFilter) The active URI filter associated with the raster type.

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

RasterType

public RasterType()
           throws IOException,
                  UnknownHostException

Constructs a RasterType using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterType

public RasterType(Object obj)
           throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

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

setFullNameByRef

public void setFullNameByRef(IName ppRasterTypeName)
                      throws IOException,
                             AutomationException

The full name of the raster type object.

Product Availability

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

Specified by:

setFullNameByRef in interface IRasterType

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws IOException,
                         AutomationException

The full name of the raster type object.

Product Availability

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

Specified by:

getFullName in interface IRasterType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterBuilderByRef

public void setRasterBuilderByRef(IRasterBuilder ppRasterBuilder)
                           throws IOException,
                                  AutomationException

The inner raster builder associated with the raster type.

Product Availability

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

Specified by:

setRasterBuilderByRef in interface IRasterType

Parameters:

ppRasterBuilder - A reference to a com.esri.arcgis.datasourcesraster.IRasterBuilder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterBuilder

public IRasterBuilder getRasterBuilder()
                                throws IOException,
                                       AutomationException

The inner raster builder associated with the raster type.

Product Availability

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

Specified by:

getRasterBuilder in interface IRasterType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setURIFilterByRef

public void setURIFilterByRef(IItemURIFilter ppItemURIFilter)
                       throws IOException,
                              AutomationException

The active URI filter associated with the raster type.

Product Availability

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

Specified by:

setURIFilterByRef in interface IRasterType

Parameters:

ppItemURIFilter - A reference to a com.esri.arcgis.datasourcesraster.IItemURIFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getURIFilter

public IItemURIFilter getURIFilter()
                            throws IOException,
                                   AutomationException

The active URI filter associated with the raster type.

Product Availability

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

Specified by:

getURIFilter in interface IRasterType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setItemTemplatesByRef

public void setItemTemplatesByRef(IItemTemplateArray ppItemTemplateArray)
                           throws IOException,
                                  AutomationException

The collection of item templates associated with the raster type.

Product Availability

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

Specified by:

setItemTemplatesByRef in interface IRasterType

Parameters:

ppItemTemplateArray - A reference to a com.esri.arcgis.datasourcesraster.IItemTemplateArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemTemplates

public IItemTemplateArray getItemTemplates()
                                    throws IOException,
                                           AutomationException

The collection of item templates associated with the raster type.

Product Availability

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

Specified by:

getItemTemplates in interface IRasterType

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultParameters

public IPropertySet getDefaultParameters()
                                  throws IOException,
                                         AutomationException

The collection of all variables associated with all item templates contained in the raster type.

Product Availability

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

Specified by:

getDefaultParameters in interface IRasterType

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.

setParametersByRef

public void setParametersByRef(IPropertySet ppInputParameters)
                        throws IOException,
                               AutomationException

Overriding parameter values bound to function variables.

Product Availability

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

Specified by:

setParametersByRef in interface IRasterType

Parameters:

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

getParameters

public IPropertySet getParameters()
                           throws IOException,
                                  AutomationException

Overriding parameter values bound to function variables.

Product Availability

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

Specified by:

getParameters in interface IRasterType

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.

setName

public void setName(String pRasterTypeName)
             throws IOException,
                    AutomationException

Name of the raster type.

Product Availability

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

Specified by:

setName in interface IRasterTypeProperties

Parameters:

pRasterTypeName - The pRasterTypeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the raster type.

Product Availability

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

Specified by:

getName in interface IRasterTypeProperties

Returns:

The pRasterTypeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pRasterTypeDescription)
                    throws IOException,
                           AutomationException

Description of the raster type.

Product Availability

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

Specified by:

setDescription in interface IRasterTypeProperties

Parameters:

pRasterTypeDescription - The pRasterTypeDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the raster type.

Product Availability

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

Specified by:

getDescription in interface IRasterTypeProperties

Returns:

The pRasterTypeDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputDataSourceTypes

public void setInputDataSourceTypes(int pInputDataSourceTypes)
                             throws IOException,
                                    AutomationException

The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.

Product Availability

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

Specified by:

setInputDataSourceTypes in interface IRasterTypeProperties

Parameters:

pInputDataSourceTypes - The pInputDataSourceTypes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputDataSourceTypes

public int getInputDataSourceTypes()
                            throws IOException,
                                   AutomationException

The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.

Product Availability

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

Specified by:

getInputDataSourceTypes in interface IRasterTypeProperties

Returns:

The pInputDataSourceTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSourceFilter

public void setDataSourceFilter(String pDataSourceFilter)
                         throws IOException,
                                AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions. No item URIs are created for input that doesn't match the specified regular expression.

Product Availability

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

Specified by:

setDataSourceFilter in interface IRasterTypeProperties

Parameters:

pDataSourceFilter - The pDataSourceFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSourceFilter

public String getDataSourceFilter()
                           throws IOException,
                                  AutomationException

Regular expression formed using wild card characters ('*', '?', or '.') for matching data source items requested for URI constructions. No item URIs are created for input that doesn't match the specified regular expression.

Product Availability

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

Specified by:

getDataSourceFilter in interface IRasterTypeProperties

Returns:

The pDataSourceFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportedURIFiltersByRef

public void setSupportedURIFiltersByRef(IArray pppItemURIFilterArray)
                                 throws IOException,
                                        AutomationException

Default URI filters supported by the raster type.

Product Availability

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

Specified by:

setSupportedURIFiltersByRef in interface IRasterTypeProperties

Parameters:

pppItemURIFilterArray - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedURIFilters

public IArray getSupportedURIFilters()
                              throws IOException,
                                     AutomationException

Default URI filters supported by the raster type.

Product Availability

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

Specified by:

getSupportedURIFilters in interface IRasterTypeProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsOrthorectification

public void setSupportsOrthorectification(boolean pbSupportsOrthorectification)
                                   throws IOException,
                                          AutomationException

Indicates whether the raster type supports orthorectification.

Product Availability

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

Specified by:

setSupportsOrthorectification in interface IRasterTypeProperties

Parameters:

pbSupportsOrthorectification - The pbSupportsOrthorectification (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsOrthorectification

public boolean isSupportsOrthorectification()
                                     throws IOException,
                                            AutomationException

Indicates whether the raster type supports orthorectification.

Product Availability

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

Specified by:

isSupportsOrthorectification in interface IRasterTypeProperties

Returns:

The pbSupportsOrthorectification

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsStereo

public void setSupportsStereo(boolean pbSupportsStereo)
                       throws IOException,
                              AutomationException

Indicates whether the raster type supports stereo.

Product Availability

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

Specified by:

setSupportsStereo in interface IRasterTypeProperties

Parameters:

pbSupportsStereo - The pbSupportsStereo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsStereo

public boolean isSupportsStereo()
                         throws IOException,
                                AutomationException

Indicates whether the raster type supports stereo.

Product Availability

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

Specified by:

isSupportsStereo in interface IRasterTypeProperties

Returns:

The pbSupportsStereo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsSeamline

public void setSupportsSeamline(boolean pbSupportsSeamline)
                         throws IOException,
                                AutomationException

Indicates whether the raster type supports seamline.

Product Availability

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

Specified by:

setSupportsSeamline in interface IRasterTypeProperties

Parameters:

pbSupportsSeamline - The pbSupportsSeamline (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsSeamline

public boolean isSupportsSeamline()
                           throws IOException,
                                  AutomationException

Indicates whether the raster type supports seamline.

Product Availability

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

Specified by:

isSupportsSeamline in interface IRasterTypeProperties

Returns:

The pbSupportsSeamline

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableClipToFootprint

public void setEnableClipToFootprint(boolean pbEnableClipToFootprint)
                              throws IOException,
                                     AutomationException

Indicates whether datasets are clipped to their footprints.

Product Availability

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

Specified by:

setEnableClipToFootprint in interface IRasterTypeProperties

Parameters:

pbEnableClipToFootprint - The pbEnableClipToFootprint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableClipToFootprint

public boolean isEnableClipToFootprint()
                                throws IOException,
                                       AutomationException

Indicates whether datasets are clipped to their footprints.

Product Availability

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

Specified by:

isEnableClipToFootprint in interface IRasterTypeProperties

Returns:

The pbEnableClipToFootprint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddRastersParameters

public void setAddRastersParameters(IAddRastersParameters ppAddRastersParameters)
                             throws IOException,
                                    AutomationException

The parameters controlling how rasters are added using this raster type.

Product Availability

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

Specified by:

setAddRastersParameters in interface IRasterTypeProperties

Parameters:

ppAddRastersParameters - A reference to a com.esri.arcgis.datasourcesraster.IAddRastersParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddRastersParameters

public IAddRastersParameters getAddRastersParameters()
                                              throws IOException,
                                                     AutomationException

The parameters controlling how rasters are added using this raster type.

Product Availability

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

Specified by:

getAddRastersParameters in interface IRasterTypeProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSynchronizeParameters

public void setSynchronizeParameters(ISynchronizeParameters ppSynchronizeParameters)
                              throws IOException,
                                     AutomationException

The parameters controlling how rasters are synchronized using this raster type instance.

Product Availability

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

Specified by:

setSynchronizeParameters in interface IRasterTypeProperties

Parameters:

ppSynchronizeParameters - A reference to a com.esri.arcgis.datasourcesraster.ISynchronizeParameters (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSynchronizeParameters

public ISynchronizeParameters getSynchronizeParameters()
                                                throws IOException,
                                                       AutomationException

The parameters controlling how rasters are synchronized using this raster type instance.

Product Availability

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

Specified by:

getSynchronizeParameters in interface IRasterTypeProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrthorectificationParametersByRef

public void setOrthorectificationParametersByRef(IGeometricFunctionArguments ppIGeometricFunctionArguments)
                                          throws IOException,
                                                 AutomationException

The parameters controlling orthorectification of raster datasets built by this raster type.

Product Availability

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

Specified by:

setOrthorectificationParametersByRef in interface IRasterTypeProperties

Parameters:

ppIGeometricFunctionArguments - A reference to a com.esri.arcgis.datasourcesraster.IGeometricFunctionArguments (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrthorectificationParameters

public IGeometricFunctionArguments getOrthorectificationParameters()
                                                            throws IOException,
                                                                   AutomationException

The parameters controlling orthorectification of raster datasets built by this raster type.

Product Availability

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

Specified by:

getOrthorectificationParameters in interface IRasterTypeProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFirstAddTimeStamp

public void setFirstAddTimeStamp(Date pFirstAddTimeStamp)
                          throws IOException,
                                 AutomationException

The time when this raster type was first used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

setFirstAddTimeStamp in interface IRasterTypeProperties

Parameters:

pFirstAddTimeStamp - The pFirstAddTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstAddTimeStamp

public Date getFirstAddTimeStamp()
                          throws IOException,
                                 AutomationException

The time when this raster type was first used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

getFirstAddTimeStamp in interface IRasterTypeProperties

Returns:

The pFirstAddTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastAddTimeStamp

public void setLastAddTimeStamp(Date pLastAddTimeStamp)
                         throws IOException,
                                AutomationException

The time when this raster type was last used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

setLastAddTimeStamp in interface IRasterTypeProperties

Parameters:

pLastAddTimeStamp - The pLastAddTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastAddTimeStamp

public Date getLastAddTimeStamp()
                         throws IOException,
                                AutomationException

The time when this raster type was last used for adding rasters to the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

getLastAddTimeStamp in interface IRasterTypeProperties

Returns:

The pLastAddTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastSyncTimeStamp

public void setLastSyncTimeStamp(Date pLastSyncTimeStamp)
                          throws IOException,
                                 AutomationException

The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

setLastSyncTimeStamp in interface IRasterTypeProperties

Parameters:

pLastSyncTimeStamp - The pLastSyncTimeStamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastSyncTimeStamp

public Date getLastSyncTimeStamp()
                          throws IOException,
                                 AutomationException

The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset. The value in this property also appears in the moasic dataset's raster type table.

Product Availability

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

Specified by:

getLastSyncTimeStamp in interface IRasterTypeProperties

Returns:

The pLastSyncTimeStamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOperationDescription

public void setOperationDescription(String pOperationDescription)
                             throws IOException,
                                    AutomationException

A user-identifiable description of the collection of items added by this raster type instance.

Product Availability

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

Specified by:

setOperationDescription in interface IRasterTypeProperties

Parameters:

pOperationDescription - The pOperationDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOperationDescription

public String getOperationDescription()
                               throws IOException,
                                      AutomationException

A user-identifiable description of the collection of items added by this raster type instance.

Product Availability

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

Specified by:

getOperationDescription in interface IRasterTypeProperties

Returns:

The pOperationDescription

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

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

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.

createBuilderItem

public IBuilderItem createBuilderItem(IItemURI pItemURI,
                                      IRasterDataset pDataset,
                                      int eRasterCategory,
                                      ISpatialReference pDefaultRasterSrs,
                                      IGeometry pItemFootprint)
                               throws IOException,
                                      AutomationException

Constructs a builder item object given an item URI and the associated raster dataset.

Product Availability

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

Specified by:

createBuilderItem in interface IRasterTypeOperation

Parameters:

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

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

eRasterCategory - A com.esri.arcgis.datasourcesraster.esriRasterCatalogItemCategory constant (in)

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

pItemFootprint - A reference to a com.esri.arcgis.geometry.IGeometry (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.

openRasterDataset

public IRasterDataset openRasterDataset(String dataSource,
                                        IRasterInfo pRasterInfo,
                                        boolean overwrite)
                                 throws IOException,
                                        AutomationException

Opens a raster dataset even if it does not exist.

Product Availability

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

Specified by:

openRasterDataset in interface IRasterTypeOperation

Parameters:

dataSource - The dataSource (in)

pRasterInfo - A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo (in)

overwrite - The overwrite (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clipDatasetToItemFootprint

public void clipDatasetToItemFootprint(IBuilderItem pBuilderItem)
                                throws IOException,
                                       AutomationException

Clips the raster dataset to the associated footprint geometry referenced by the with specified builder item.

Product Availability

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

Specified by:

clipDatasetToItemFootprint in interface IRasterTypeOperation

Parameters:

pBuilderItem - A reference to a com.esri.arcgis.datasourcesraster.IBuilderItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

processItem

public void processItem(IBuilderItem pBuilderItem)
                 throws IOException,
                        AutomationException

Builds pyramids and computes statistics for all raster dataset referenced by the top-level function raster dataset in the builder item. The associated AddRastersParameters and SynchronizeParameters objects are used to control how pyramids and statistics are bu????&

Product Availability

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

Specified by:

processItem in interface IRasterTypeOperation

Parameters:

pBuilderItem - A reference to a com.esri.arcgis.datasourcesraster.IBuilderItem (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applyOrthorectification

public IFunctionRasterDataset applyOrthorectification(IFunctionRasterDataset pDataset)
                                               throws IOException,
                                                      AutomationException

Adds (or updates) a geometric function associated with the function raster dataset.

Product Availability

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

Specified by:

applyOrthorectification in interface IRasterTypeOperation

Parameters:

pDataset - A reference to a com.esri.arcgis.datasourcesraster.IFunctionRasterDataset (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.