public class PythonRasterBuilder extends java.lang.Object implements com.esri.arcgis.interop.RemoteObjRef, IRasterBuilder, IRasterBuilder2, IRasterBuilder3, IRasterBuilderInit, IPythonRasterBuilder
Description 'A raster builder for Python Raster Types' 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 =
IID, IIDc8cda4c3_da95_4eb9_9c3d_d8d11889c4aa, xxDummy
IIDec840d20_97c0_40a6_b86a_05179c79a745
IIDb2e3f2d4_5182_4299_aff5_41e5c9017d4f
IID, IIDd8e71e5a_401b_43a8_a55d_46881c51134c, xxDummy
IID, IID93f13881_dc0d_41a8_b7d2_3e662023c80a, xxDummy
Constructor and Description |
---|
PythonRasterBuilder()
Constructs a PythonRasterBuilder using ArcGIS Engine.
|
PythonRasterBuilder(java.lang.Object obj)
Deprecated.
As of ArcGIS 9.2, replaced by normal Java casts.
PythonRasterBuilder thePythonRasterBuilder = (PythonRasterBuilder) obj; |
Modifier and Type | Method and Description |
---|---|
void |
beginConstruction(IDataSourceCrawler pCrawler)
Initializes the raster builder for URI construction given a valid data source crawler object.
|
IBuilderItem |
build(IItemURI pItemURI)
Construct a builder item using the specified item URI.
|
boolean |
canBuild(java.lang.Object vtDataSource)
Indicates whether the raster builder recognizes the specified data source and is possibly capable of building a valid function raster dataset from it.
|
boolean |
canUpdate(IRasterFunctionTemplate pFunctionTemplate)
Indicates whether the raster builder is capable of updating a raster function template.
|
void |
constructURIs(java.lang.Object crawlerItem)
Constructs one or more item URI objects given the crawled data source item.
|
IItemURIArray |
endConstruction()
Shuts down the raster builder object upon completion of URI construction.
|
boolean |
equals(java.lang.Object o)
Compare this object with another
|
IPropertySet |
getAuxiliaryFieldAlias()
Optional look-up that maps field names to possile metadata property names.
|
IFields |
getAuxiliaryFields()
Fields to be created and populated in the raster catalog when a builder is used.
|
java.lang.String |
getBuilderName()
The builder class name.
|
static java.lang.String |
getClsid()
getClsid.
|
java.lang.String |
getCrawlerName()
The crawler class name.
|
ISpatialReference |
getDefaultSpatialReference()
The default spatial reference associated with the collection of items built by this raster type.
|
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this
interface indicates the implementing class references.
|
java.lang.String |
getModulePath()
The python module path.
|
IMosaicDataset |
getMosaicDataset()
The mosaic dataset associated with this operation.
|
IMultidimensionalInfo |
getMultidimensionalInfo()
The multidimensional info object associated with the raster builder.
|
IItemURI |
getNextURI()
Returns the next available item URI object.
|
IPropertySet |
getProperties()
The raster dataset builder properties.
|
IRasterTypeOperation |
getRasterTypeOperation()
The raster type operation helper object associated with this raster type.
|
IDataSourceCrawler |
getRecommendedCrawler(IPropertySet pDataSourceProperties)
Returns a crawler best suited for data source as recommended by the raster builder.
|
ITrackCancel |
getTrackCancel()
The cancel tracker associated with this operation.
|
int |
hashCode()
the hashcode for this object
|
boolean |
isCanBuildInPlace()
Indicates whether the raster type can build an item URI as soon as it is contructed.
|
boolean |
isCanMergeItems()
Indicates whether the raster builder is capable of building composite crawled items.
|
boolean |
isMergeItems()
Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
|
boolean |
isStale(IItemURI pItemURI)
Indicates whether the data source referenced by the specified item URI has been updated since the item URI was last constructed.
|
void |
release()
Release this COM object reference
|
void |
reviewBuilderItem(IBuilderItem pBuilderItem)
Review and (optionally) update the final builder item generated by the parent raster type.
|
void |
reviewItemURI(IItemURI pItemURI)
Review and (optionally) update the final item URI constructed by the parent 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 |
setBuilderName(java.lang.String pBuilderName)
The builder class name.
|
void |
setCrawlerName(java.lang.String pCrawlerName)
The crawler class name.
|
void |
setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
The default spatial reference associated with the collection of items built by this raster type.
|
void |
setMergeItems(boolean pbMergeItems)
Indicates whether the raster builder constructs a multi-part URI given a composite crawled item.
|
void |
setModulePath(java.lang.String pModulePath)
The python module path.
|
void |
setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
The mosaic dataset associated with this operation.
|
void |
setMultidimensionalInfoByRef(IMultidimensionalInfo ppMultidimensionalInfo)
The multidimensional info object associated with the raster builder.
|
void |
setPropertiesByRef(IPropertySet ppBuilderPoperties)
The raster dataset builder properties.
|
void |
setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation)
The raster type operation helper object associated with this raster type.
|
void |
setTrackCancelByRef(ITrackCancel ppTrackCancel)
The cancel tracker associated with this operation.
|
void |
update(IItemURI pItemURI,
IRasterFunctionTemplate pFunctionTemplate,
IPropertySet pArguments)
Updates the specified function template and template arguments using information associated with the specified item URI.
|
void |
validate()
Validates the raster builder.
|
public PythonRasterBuilder() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problemsjava.net.UnknownHostException
- if there are interop problemspublic PythonRasterBuilder(java.lang.Object obj) throws java.io.IOException
PythonRasterBuilder thePythonRasterBuilder = (PythonRasterBuilder) obj;
obj
to PythonRasterBuilder
.obj
- an object returned from ArcGIS Engine or Serverjava.io.IOException
- if there are interop problemspublic static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public IDataSourceCrawler getRecommendedCrawler(IPropertySet pDataSourceProperties) throws java.io.IOException, AutomationException
getRecommendedCrawler
in interface IRasterBuilder
pDataSourceProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void beginConstruction(IDataSourceCrawler pCrawler) throws java.io.IOException, AutomationException
beginConstruction
in interface IRasterBuilder
pCrawler
- A reference to a com.esri.arcgis.datasourcesraster.IDataSourceCrawler (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void constructURIs(java.lang.Object crawlerItem) throws java.io.IOException, AutomationException
constructURIs
in interface IRasterBuilder
crawlerItem
- A Variant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IItemURI getNextURI() throws java.io.IOException, AutomationException
getNextURI
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IItemURIArray endConstruction() throws java.io.IOException, AutomationException
endConstruction
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isStale(IItemURI pItemURI) throws java.io.IOException, AutomationException
isStale
in interface IRasterBuilder
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IBuilderItem build(IItemURI pItemURI) throws java.io.IOException, AutomationException
build
in interface IRasterBuilder
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setPropertiesByRef(IPropertySet ppBuilderPoperties) throws java.io.IOException, AutomationException
setPropertiesByRef
in interface IRasterBuilder
ppBuilderPoperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IPropertySet getProperties() throws java.io.IOException, AutomationException
getProperties
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields) throws java.io.IOException, AutomationException
setAuxiliaryFieldsByRef
in interface IRasterBuilder
ppAuxiliaryFields
- A reference to a com.esri.arcgis.geodatabase.IFields (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IFields getAuxiliaryFields() throws java.io.IOException, AutomationException
getAuxiliaryFields
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap) throws java.io.IOException, AutomationException
setAuxiliaryFieldAliasByRef
in interface IRasterBuilder
ppFieldNameMap
- A reference to a com.esri.arcgis.system.IPropertySet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IPropertySet getAuxiliaryFieldAlias() throws java.io.IOException, AutomationException
getAuxiliaryFieldAlias
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isCanBuildInPlace() throws java.io.IOException, AutomationException
isCanBuildInPlace
in interface IRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean canBuild(java.lang.Object vtDataSource) throws java.io.IOException, AutomationException
canBuild
in interface IRasterBuilder2
vtDataSource
- A Variant (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void validate() throws java.io.IOException, AutomationException
validate
in interface IRasterBuilder2
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isCanMergeItems() throws java.io.IOException, AutomationException
isCanMergeItems
in interface IRasterBuilder2
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean isMergeItems() throws java.io.IOException, AutomationException
isMergeItems
in interface IRasterBuilder2
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setMergeItems(boolean pbMergeItems) throws java.io.IOException, AutomationException
setMergeItems
in interface IRasterBuilder2
pbMergeItems
- The pbMergeItems (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void reviewItemURI(IItemURI pItemURI) throws java.io.IOException, AutomationException
reviewItemURI
in interface IRasterBuilder3
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void reviewBuilderItem(IBuilderItem pBuilderItem) throws java.io.IOException, AutomationException
reviewBuilderItem
in interface IRasterBuilder3
pBuilderItem
- A reference to a com.esri.arcgis.datasourcesraster.IBuilderItem (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IMultidimensionalInfo getMultidimensionalInfo() throws java.io.IOException, AutomationException
getMultidimensionalInfo
in interface IRasterBuilder3
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setMultidimensionalInfoByRef(IMultidimensionalInfo ppMultidimensionalInfo) throws java.io.IOException, AutomationException
setMultidimensionalInfoByRef
in interface IRasterBuilder3
ppMultidimensionalInfo
- A reference to a com.esri.arcgis.geodatabase.IMultidimensionalInfo (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public boolean canUpdate(IRasterFunctionTemplate pFunctionTemplate) throws java.io.IOException, AutomationException
canUpdate
in interface IRasterBuilder3
pFunctionTemplate
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void update(IItemURI pItemURI, IRasterFunctionTemplate pFunctionTemplate, IPropertySet pArguments) throws java.io.IOException, AutomationException
update
in interface IRasterBuilder3
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)pFunctionTemplate
- A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate (in)pArguments
- A reference to a com.esri.arcgis.system.IPropertySet (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) throws java.io.IOException, AutomationException
setMosaicDatasetByRef
in interface IRasterBuilderInit
ppMosaicDataset
- A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IMosaicDataset getMosaicDataset() throws java.io.IOException, AutomationException
getMosaicDataset
in interface IRasterBuilderInit
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setTrackCancelByRef(ITrackCancel ppTrackCancel) throws java.io.IOException, AutomationException
setTrackCancelByRef
in interface IRasterBuilderInit
ppTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public ITrackCancel getTrackCancel() throws java.io.IOException, AutomationException
getTrackCancel
in interface IRasterBuilderInit
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) throws java.io.IOException, AutomationException
setDefaultSpatialReferenceByRef
in interface IRasterBuilderInit
ppDefaultSrs
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getDefaultSpatialReference() throws java.io.IOException, AutomationException
getDefaultSpatialReference
in interface IRasterBuilderInit
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation) throws java.io.IOException, AutomationException
setRasterTypeOperationByRef
in interface IRasterBuilderInit
ppRasterTypeOperation
- A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeOperation (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public IRasterTypeOperation getRasterTypeOperation() throws java.io.IOException, AutomationException
getRasterTypeOperation
in interface IRasterBuilderInit
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setModulePath(java.lang.String pModulePath) throws java.io.IOException, AutomationException
setModulePath
in interface IPythonRasterBuilder
pModulePath
- The pModulePath (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getModulePath() throws java.io.IOException, AutomationException
getModulePath
in interface IPythonRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setBuilderName(java.lang.String pBuilderName) throws java.io.IOException, AutomationException
setBuilderName
in interface IPythonRasterBuilder
pBuilderName
- The pBuilderName (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getBuilderName() throws java.io.IOException, AutomationException
getBuilderName
in interface IPythonRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public void setCrawlerName(java.lang.String pCrawlerName) throws java.io.IOException, AutomationException
setCrawlerName
in interface IPythonRasterBuilder
pCrawlerName
- The pCrawlerName (in)java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.public java.lang.String getCrawlerName() throws java.io.IOException, AutomationException
getCrawlerName
in interface IPythonRasterBuilder
java.io.IOException
- If there are interop problems.AutomationException
- If the ArcObject component throws an exception.