com.esri.arcgis.datasourcesraster

Class RasterType

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterType

All Implemented Interfaces:

IRasterBuilder, IRasterBuilder2, IRasterBuilderInit, IRasterBuilderInit2, IRasterType, IRasterTypeOperation, IRasterTypeProperties, IRasterTypeProperties2, IRasterTypeProperties3, IRasterTypeProperties4, com.esri.arcgis.interop.RemoteObjRef, IObjectUpdate, IXMLSerialize, IXMLVersionSupport, java.io.Serializable

public class RasterType
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterType, IRasterTypeProperties, IRasterTypeProperties2, IRasterTypeProperties3, IRasterTypeProperties4, IRasterBuilder2, IRasterBuilderInit, IRasterBuilderInit2, IRasterTypeOperation, IObjectUpdate, IXMLSerialize, IXMLVersionSupport

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

Description 'A raster type object.' 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.IRasterType

IID, IIDe5eea64c_91c9_4dca_b16a_516af8a0ca0b, xxDummy

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

IID, IID76670af5_83de_4262_813a_03af86acc1fc, xxDummy

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

IID47cb1b20_bba7_44fc_b258_2cb346642c47

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

IID7bd60984_38d6_4c55_94ed_1ed74a839727

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

IID078c7800_66f2_46cf_a182_78e6c4aade53

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

IID, IID4d53f22d_3d94_41b8_9d5b_aca99d46ecd7, xxDummy

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

IIDd8e71e5a_401b_43a8_a55d_46881c51134c

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

IID, IID2a83ce86_dc8d_4eb6_a6fd_bf3bafccd08e, xxDummy

Fields inherited from interface com.esri.arcgis.system.IObjectUpdate

IID, IIDd641f414_1004_4e73_9386_f6ea543e2d95, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
RasterType() Constructs a RasterType using ArcGIS Engine.
RasterType(java.lang.Object obj) Construct a RasterType using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
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.
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	clipDatasetToItemFootprint(IBuilderItem pBuilderItem) Clips the raster dataset to the associated footprint geometry referenced by the with specified builder item.
void	constructURIs(java.lang.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.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
IItemURIArray	endConstruction() Shuts down the raster builder object upon completion of URI construction.
boolean	equals(java.lang.Object o) Compare this object with another
IAddRastersParameters	getAddRastersParameters() The parameters controlling how rasters are added using this raster type.
IStringArray	getAliases() All the names, in addition to the primary name, by which the raster type may be referenced.
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.
java.lang.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.
java.lang.String	getDescription() Description of the raster type.
IUID	getFactoryCLSID() The CLSID of the raster type factory that created the raster type.
java.util.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.
IGeoTransformationHelper	getGeoTransformationHelper() The geographic tranformation helper object, set by the calling application, that enables the raster builder to install geotransformation method in to the system's GeoTransformationOperationSet.
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.
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.
java.util.Date	getLastAddTimeStamp() The time when this raster type was last used for adding rasters to the mosaic dataset.
java.util.Date	getLastSyncTimeStamp() The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
int	getMissingBandAction() Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.
IMosaicDataset	getMosaicDataset() The mosaic dataset associated with this operation.
java.lang.String	getName() Name of the raster type.
IItemURI	getNextURI() Returns the next available item URI object.
java.lang.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.
IArray	getParameterInfo() Description of parameters supported by the 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 operation.
IItemURIFilter	getURIFilter() The active URI filter associated with the raster type.
int	getVersion() The version number associated with the raster type.
int	hashCode() the hashcode for this object
boolean	isAllowSimplification() Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.
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	isEnableClipToFootprint() Indicates whether datasets are clipped to their footprints.
boolean	isMergeItems() Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
boolean	isPerformsGrouping() Indicates whether the raster type instance collects item URIs with the same group name allowing the function template to combine multiple raster datasets into a single product.
boolean	isSensorRasterType() Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).
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	isSupportsColorCorrection() Indicates whether the raster type supports color correction.
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(java.lang.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	release() Release this COM object reference
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAddRastersParameters(IAddRastersParameters ppAddRastersParameters) The parameters controlling how rasters are added using this raster type.
void	setAliasesByRef(IStringArray ppAliases) All the names, in addition to the primary name, by which the raster type may be referenced.
void	setAllowSimplification(boolean pbAllowSimplification) Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.
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(java.lang.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(java.lang.String pRasterTypeDescription) Description of the raster type.
void	setEnableClipToFootprint(boolean pbEnableClipToFootprint) Indicates whether datasets are clipped to their footprints.
void	setFactoryCLSIDByRef(IUID ppFactoryClsid) The CLSID of the raster type factory that created the raster type.
void	setFirstAddTimeStamp(java.util.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	setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper) The geographic tranformation helper object, set by the calling application, that enables the raster builder to install geotransformation method in to the system's GeoTransformationOperationSet.
void	setInputDataSourceTypes(int pInputDataSourceTypes) The types of input data source types as a bitwise combination of esriCrawlerDataSourceType values.
void	setIsSensorRasterType(boolean pbIsSensorRasterType) Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).
void	setItemTemplatesByRef(IItemTemplateArray ppItemTemplateArray) The collection of item templates associated with the raster type.
void	setLastAddTimeStamp(java.util.Date pLastAddTimeStamp) The time when this raster type was last used for adding rasters to the mosaic dataset.
void	setLastSyncTimeStamp(java.util.Date pLastSyncTimeStamp) The time when this raster type was last used for synchronizing one or more rasters in the mosaic dataset.
void	setMergeItems(boolean pbMergeItems) Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
void	setMissingBandAction(int pMissingBandAction) Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.
void	setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) The mosaic dataset associated with this operation.
void	setName(java.lang.String pRasterTypeName) Name of the raster type.
void	setOperationDescription(java.lang.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	setParameterInfoByRef(IArray ppParameterInfo) Description of parameters supported by the 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	setSupportsColorCorrection(boolean pbSupportsColorCorrection) Indicates whether the raster type supports color correction.
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 operation.
void	setURIFilterByRef(IItemURIFilter ppItemURIFilter) The active URI filter associated with the raster type.
void	setVersion(int pVersion) The version number associated with the raster type.
void	update(IPropertySet props) Updates object's properties.
void	validate() Validates the raster builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterType

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

Constructs a RasterType using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterType

public RasterType(java.lang.Object obj)
           throws java.io.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:

java.io.IOException - if there are interop problems RasterType theRasterType = (RasterType) obj;

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

setFullNameByRef

public void setFullNameByRef(IName ppRasterTypeName)
                      throws java.io.IOException,
                             AutomationException

The full name of the raster type object.

Specified by:

setFullNameByRef in interface IRasterType

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The full name of the raster type object.

Specified by:

getFullName in interface IRasterType

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterBuilderByRef

public void setRasterBuilderByRef(IRasterBuilder ppRasterBuilder)
                           throws java.io.IOException,
                                  AutomationException

The inner raster builder associated with the raster type.

Specified by:

setRasterBuilderByRef in interface IRasterType

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterBuilder

public IRasterBuilder getRasterBuilder()
                                throws java.io.IOException,
                                       AutomationException

The inner raster builder associated with the raster type.

Specified by:

getRasterBuilder in interface IRasterType

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setURIFilterByRef

public void setURIFilterByRef(IItemURIFilter ppItemURIFilter)
                       throws java.io.IOException,
                              AutomationException

The active URI filter associated with the raster type.

Specified by:

setURIFilterByRef in interface IRasterType

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getURIFilter

public IItemURIFilter getURIFilter()
                            throws java.io.IOException,
                                   AutomationException

The active URI filter associated with the raster type.

Specified by:

getURIFilter in interface IRasterType

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setItemTemplatesByRef

public void setItemTemplatesByRef(IItemTemplateArray ppItemTemplateArray)
                           throws java.io.IOException,
                                  AutomationException

The collection of item templates associated with the raster type.

Specified by:

setItemTemplatesByRef in interface IRasterType

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getItemTemplates

public IItemTemplateArray getItemTemplates()
                                    throws java.io.IOException,
                                           AutomationException

The collection of item templates associated with the raster type.

Specified by:

getItemTemplates in interface IRasterType

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultParameters

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

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

Specified by:

getDefaultParameters in interface IRasterType

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.

setParametersByRef

public void setParametersByRef(IPropertySet ppInputParameters)
                        throws java.io.IOException,
                               AutomationException

Overriding parameter values bound to function variables.

Specified by:

setParametersByRef in interface IRasterType

Parameters:

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

getParameters

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

Overriding parameter values bound to function variables.

Specified by:

getParameters in interface IRasterType

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.

setName

public void setName(java.lang.String pRasterTypeName)
             throws java.io.IOException,
                    AutomationException

Name of the raster type.

Specified by:

setName in interface IRasterTypeProperties

Parameters:

pRasterTypeName - The pRasterTypeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Name of the raster type.

Specified by:

getName in interface IRasterTypeProperties

Returns:

The pRasterTypeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String pRasterTypeDescription)
                    throws java.io.IOException,
                           AutomationException

Description of the raster type.

Specified by:

setDescription in interface IRasterTypeProperties

Parameters:

pRasterTypeDescription - The pRasterTypeDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the raster type.

Specified by:

getDescription in interface IRasterTypeProperties

Returns:

The pRasterTypeDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInputDataSourceTypes

public void setInputDataSourceTypes(int pInputDataSourceTypes)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setInputDataSourceTypes in interface IRasterTypeProperties

Parameters:

pInputDataSourceTypes - The pInputDataSourceTypes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInputDataSourceTypes

public int getInputDataSourceTypes()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:

getInputDataSourceTypes in interface IRasterTypeProperties

Returns:

The pInputDataSourceTypes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDataSourceFilter

public void setDataSourceFilter(java.lang.String pDataSourceFilter)
                         throws java.io.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.

Specified by:

setDataSourceFilter in interface IRasterTypeProperties

Parameters:

pDataSourceFilter - The pDataSourceFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataSourceFilter

public java.lang.String getDataSourceFilter()
                                     throws java.io.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.

Specified by:

getDataSourceFilter in interface IRasterTypeProperties

Returns:

The pDataSourceFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportedURIFiltersByRef

public void setSupportedURIFiltersByRef(IArray pppItemURIFilterArray)
                                 throws java.io.IOException,
                                        AutomationException

Default URI filters supported by the raster type.

Specified by:

setSupportedURIFiltersByRef in interface IRasterTypeProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSupportedURIFilters

public IArray getSupportedURIFilters()
                              throws java.io.IOException,
                                     AutomationException

Default URI filters supported by the raster type.

Specified by:

getSupportedURIFilters in interface IRasterTypeProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsOrthorectification

public void setSupportsOrthorectification(boolean pbSupportsOrthorectification)
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether the raster type supports orthorectification.

Specified by:

setSupportsOrthorectification in interface IRasterTypeProperties

Parameters:

pbSupportsOrthorectification - The pbSupportsOrthorectification (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsOrthorectification

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

Indicates whether the raster type supports orthorectification.

Specified by:

isSupportsOrthorectification in interface IRasterTypeProperties

Returns:

The pbSupportsOrthorectification

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsStereo

public void setSupportsStereo(boolean pbSupportsStereo)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the raster type supports stereo.

Specified by:

setSupportsStereo in interface IRasterTypeProperties

Parameters:

pbSupportsStereo - The pbSupportsStereo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsStereo

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

Indicates whether the raster type supports stereo.

Specified by:

isSupportsStereo in interface IRasterTypeProperties

Returns:

The pbSupportsStereo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsSeamline

public void setSupportsSeamline(boolean pbSupportsSeamline)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the raster type supports seamline.

Specified by:

setSupportsSeamline in interface IRasterTypeProperties

Parameters:

pbSupportsSeamline - The pbSupportsSeamline (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsSeamline

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

Indicates whether the raster type supports seamline.

Specified by:

isSupportsSeamline in interface IRasterTypeProperties

Returns:

The pbSupportsSeamline

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableClipToFootprint

public void setEnableClipToFootprint(boolean pbEnableClipToFootprint)
                              throws java.io.IOException,
                                     AutomationException

Indicates whether datasets are clipped to their footprints.

Specified by:

setEnableClipToFootprint in interface IRasterTypeProperties

Parameters:

pbEnableClipToFootprint - The pbEnableClipToFootprint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableClipToFootprint

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

Indicates whether datasets are clipped to their footprints.

Specified by:

isEnableClipToFootprint in interface IRasterTypeProperties

Returns:

The pbEnableClipToFootprint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAddRastersParameters

public void setAddRastersParameters(IAddRastersParameters ppAddRastersParameters)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setAddRastersParameters in interface IRasterTypeProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAddRastersParameters

public IAddRastersParameters getAddRastersParameters()
                                              throws java.io.IOException,
                                                     AutomationException

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

Specified by:

getAddRastersParameters in interface IRasterTypeProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSynchronizeParameters

public void setSynchronizeParameters(ISynchronizeParameters ppSynchronizeParameters)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

setSynchronizeParameters in interface IRasterTypeProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSynchronizeParameters

public ISynchronizeParameters getSynchronizeParameters()
                                                throws java.io.IOException,
                                                       AutomationException

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

Specified by:

getSynchronizeParameters in interface IRasterTypeProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOrthorectificationParametersByRef

public void setOrthorectificationParametersByRef(IGeometricFunctionArguments ppIGeometricFunctionArguments)
                                          throws java.io.IOException,
                                                 AutomationException

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

Specified by:

setOrthorectificationParametersByRef in interface IRasterTypeProperties

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOrthorectificationParameters

public IGeometricFunctionArguments getOrthorectificationParameters()
                                                            throws java.io.IOException,
                                                                   AutomationException

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

Specified by:

getOrthorectificationParameters in interface IRasterTypeProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFirstAddTimeStamp

public void setFirstAddTimeStamp(java.util.Date pFirstAddTimeStamp)
                          throws java.io.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.

Specified by:

setFirstAddTimeStamp in interface IRasterTypeProperties

Parameters:

pFirstAddTimeStamp - The pFirstAddTimeStamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFirstAddTimeStamp

public java.util.Date getFirstAddTimeStamp()
                                    throws java.io.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.

Specified by:

getFirstAddTimeStamp in interface IRasterTypeProperties

Returns:

The pFirstAddTimeStamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLastAddTimeStamp

public void setLastAddTimeStamp(java.util.Date pLastAddTimeStamp)
                         throws java.io.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.

Specified by:

setLastAddTimeStamp in interface IRasterTypeProperties

Parameters:

pLastAddTimeStamp - The pLastAddTimeStamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastAddTimeStamp

public java.util.Date getLastAddTimeStamp()
                                   throws java.io.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.

Specified by:

getLastAddTimeStamp in interface IRasterTypeProperties

Returns:

The pLastAddTimeStamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLastSyncTimeStamp

public void setLastSyncTimeStamp(java.util.Date pLastSyncTimeStamp)
                          throws java.io.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.

Specified by:

setLastSyncTimeStamp in interface IRasterTypeProperties

Parameters:

pLastSyncTimeStamp - The pLastSyncTimeStamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLastSyncTimeStamp

public java.util.Date getLastSyncTimeStamp()
                                    throws java.io.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.

Specified by:

getLastSyncTimeStamp in interface IRasterTypeProperties

Returns:

The pLastSyncTimeStamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOperationDescription

public void setOperationDescription(java.lang.String pOperationDescription)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setOperationDescription in interface IRasterTypeProperties

Parameters:

pOperationDescription - The pOperationDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperationDescription

public java.lang.String getOperationDescription()
                                         throws java.io.IOException,
                                                AutomationException

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

Specified by:

getOperationDescription in interface IRasterTypeProperties

Returns:

The pOperationDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsSensorRasterType

public void setIsSensorRasterType(boolean pbIsSensorRasterType)
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).

Specified by:

setIsSensorRasterType in interface IRasterTypeProperties2

Parameters:

pbIsSensorRasterType - The pbIsSensorRasterType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSensorRasterType

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

Indicates whether the raster type processes sensor data sources (as opposed to regular raster data sources).

Specified by:

isSensorRasterType in interface IRasterTypeProperties2

Returns:

The pbIsSensorRasterType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAliasesByRef

public void setAliasesByRef(IStringArray ppAliases)
                     throws java.io.IOException,
                            AutomationException

All the names, in addition to the primary name, by which the raster type may be referenced.

Specified by:

setAliasesByRef in interface IRasterTypeProperties2

Parameters:

ppAliases - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliases

public IStringArray getAliases()
                        throws java.io.IOException,
                               AutomationException

All the names, in addition to the primary name, by which the raster type may be referenced.

Specified by:

getAliases in interface IRasterTypeProperties2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowSimplification

public void setAllowSimplification(boolean pbAllowSimplification)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.

Specified by:

setAllowSimplification in interface IRasterTypeProperties2

Parameters:

pbAllowSimplification - The pbAllowSimplification (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowSimplification

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

Indicates whether the function raster datasets generated by the raster type should be simplified before being added to the mosaic dataset by 'AddRasters' or 'SynchronizeItems' operations.

Specified by:

isAllowSimplification in interface IRasterTypeProperties2

Returns:

The pbAllowSimplification

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(int pVersion)
                throws java.io.IOException,
                       AutomationException

The version number associated with the raster type.

Specified by:

setVersion in interface IRasterTypeProperties2

Parameters:

pVersion - The pVersion (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersion

public int getVersion()
               throws java.io.IOException,
                      AutomationException

The version number associated with the raster type.

Specified by:

getVersion in interface IRasterTypeProperties2

Returns:

The pVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMissingBandAction

public int getMissingBandAction()
                         throws java.io.IOException,
                                AutomationException

Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.

Specified by:

getMissingBandAction in interface IRasterTypeProperties2

Returns:

A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMissingBandAction

public void setMissingBandAction(int pMissingBandAction)
                          throws java.io.IOException,
                                 AutomationException

Indicates how the raster type behaves when a band requested by the mosaic dataset's band definition is not found in the input raster.

Specified by:

setMissingBandAction in interface IRasterTypeProperties2

Parameters:

pMissingBandAction - A com.esri.arcgis.datasourcesraster.esriMissingBandAction constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFactoryCLSIDByRef

public void setFactoryCLSIDByRef(IUID ppFactoryClsid)
                          throws java.io.IOException,
                                 AutomationException

The CLSID of the raster type factory that created the raster type.

Specified by:

setFactoryCLSIDByRef in interface IRasterTypeProperties2

Parameters:

ppFactoryClsid - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFactoryCLSID

public IUID getFactoryCLSID()
                     throws java.io.IOException,
                            AutomationException

The CLSID of the raster type factory that created the raster type.

Specified by:

getFactoryCLSID in interface IRasterTypeProperties2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsColorCorrection

public void setSupportsColorCorrection(boolean pbSupportsColorCorrection)
                                throws java.io.IOException,
                                       AutomationException

Indicates whether the raster type supports color correction.

Specified by:

setSupportsColorCorrection in interface IRasterTypeProperties2

Parameters:

pbSupportsColorCorrection - The pbSupportsColorCorrection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportsColorCorrection

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

Indicates whether the raster type supports color correction.

Specified by:

isSupportsColorCorrection in interface IRasterTypeProperties2

Returns:

The pbSupportsColorCorrection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPerformsGrouping

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

Indicates whether the raster type instance collects item URIs with the same group name allowing the function template to combine multiple raster datasets into a single product.

Specified by:

isPerformsGrouping in interface IRasterTypeProperties3

Returns:

The pbPerformsGrouping

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getParameterInfo

public IArray getParameterInfo()
                        throws java.io.IOException,
                               AutomationException

Description of parameters supported by the raster type.

Specified by:

getParameterInfo in interface IRasterTypeProperties4

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setParameterInfoByRef

public void setParameterInfoByRef(IArray ppParameterInfo)
                           throws java.io.IOException,
                                  AutomationException

Description of parameters supported by the raster type.

Specified by:

setParameterInfoByRef in interface IRasterTypeProperties4

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.

setGeoTransformationHelperByRef

public void setGeoTransformationHelperByRef(IGeoTransformationHelper ppGeoTransformationHelper)
                                     throws java.io.IOException,
                                            AutomationException

The geographic tranformation helper object, set by the calling application, that enables the raster builder to install geotransformation method in to the system's GeoTransformationOperationSet.

Specified by:

setGeoTransformationHelperByRef in interface IRasterBuilderInit2

Parameters:

ppGeoTransformationHelper - A reference to a com.esri.arcgis.datasourcesraster.IGeoTransformationHelper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeoTransformationHelper

public IGeoTransformationHelper getGeoTransformationHelper()
                                                    throws java.io.IOException,
                                                           AutomationException

The geographic tranformation helper object, set by the calling application, that enables the raster builder to install geotransformation method in to the system's GeoTransformationOperationSet.

Specified by:

getGeoTransformationHelper in interface IRasterBuilderInit2

Returns:

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

Throws:

java.io.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 java.io.IOException,
                                      AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

openRasterDataset

public IRasterDataset openRasterDataset(java.lang.String dataSource,
                                        IRasterInfo pRasterInfo,
                                        boolean overwrite)
                                 throws java.io.IOException,
                                        AutomationException

Opens a raster dataset even if it does not exist.

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:

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

AutomationException - If the ArcObject component throws an exception.

clipDatasetToItemFootprint

public void clipDatasetToItemFootprint(IBuilderItem pBuilderItem)
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

clipDatasetToItemFootprint in interface IRasterTypeOperation

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

processItem

public void processItem(IBuilderItem pBuilderItem)
                 throws java.io.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

Specified by:

processItem in interface IRasterTypeOperation

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyOrthorectification

public IFunctionRasterDataset applyOrthorectification(IFunctionRasterDataset pDataset)
                                               throws java.io.IOException,
                                                      AutomationException

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

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:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IPropertySet props)
            throws java.io.IOException,
                   AutomationException

Updates object's properties.

Specified by:

update in interface IObjectUpdate

Parameters:

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

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.