|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesraster.RPDefBuilder
public class RPDefBuilder
A raster builder for Raster Process Definition files
Constructor Summary | |
---|---|
RPDefBuilder()
Constructs a RPDefBuilder using ArcGIS Engine. |
|
RPDefBuilder(Object obj)
Construct a RPDefBuilder using a reference to such an object returned from ArcGIS Engine or Server. |
Method Summary | |
---|---|
void |
beginConstruction(IDataSourceCrawler pCrawler)
Initializes the raster builder for URI construction given a valid data source crawler object. |
IBuilderItem |
build(IItemURI pItemURI)
Construct a builder item using the specified item URI. |
boolean |
canBuild(Object vtDataSource)
Indicates whether the raster builder recognizes the specified data source and is possibly capable of building a valid function raster dataset from it. |
void |
constructURIs(Object crawlerItem)
Constructs one or more item URI objects given the crawled data source item. |
IItemURIArray |
endConstruction()
Shuts down the raster builder object upon completion of URI construction. |
boolean |
equals(Object o)
Compare this object with another |
IPropertySet |
getAuxiliaryFieldAlias()
Optional look-up that maps field names to possile metadata property names. |
IFields |
getAuxiliaryFields()
Fields to be created and populated in the raster catalog when a builder is used. |
static String |
getClsid()
getClsid. |
ISpatialReference |
getDefaultSpatialReference()
The default spatial reference associated with the collection of items built by this raster type. |
IMosaicDataset |
getMosaicDataset()
The mosaic dataset associated with this operation. |
IItemURI |
getNextURI()
Returns the next available item URI object. |
IPropertySet |
getProperties()
The raster dataset builder properties. |
IRasterTypeOperation |
getRasterTypeOperation()
The raster type operation helper object associated with this raster type. |
IDataSourceCrawler |
getRecommendedCrawler(IPropertySet pDataSourceProperties)
Returns a crawler best suited for data source as recommended by the raster builder. |
ITrackCancel |
getTrackCancel()
The cancel tracker associated with this operation. |
int |
hashCode()
the hashcode for this object |
boolean |
isCanBuildInPlace()
Indicates whether the raster type can build an item URI as soon as it is contructed. |
boolean |
isCanMergeItems()
Indicates whether the raster builder is capable of building composite crawled items. |
boolean |
isMergeItems()
Indicates whether the raster builder constructs a multi-part URI given a composite crawled item. |
boolean |
isStale(IItemURI pItemURI)
Indicates whether the data source referenced by the specified item URI has been updated since the item URI was last constructed. |
void |
setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap)
Optional look-up that maps field names to possile metadata property names. |
void |
setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields)
Fields to be created and populated in the raster catalog when a builder is used. |
void |
setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs)
The default spatial reference associated with the collection of items built by this raster type. |
void |
setMergeItems(boolean pbMergeItems)
Indicates whether the raster builder constructs a multi-part URI given a composite crawled item. |
void |
setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset)
The mosaic dataset associated with this operation. |
void |
setPropertiesByRef(IPropertySet ppBuilderPoperties)
The raster dataset builder properties. |
void |
setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation)
The raster type operation helper object associated with this raster type. |
void |
setTrackCancelByRef(ITrackCancel ppTrackCancel)
The cancel tracker associated with this operation. |
void |
validate()
Validates the raster builder. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public RPDefBuilder() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic RPDefBuilder(Object obj) throws IOException
obj
to RPDefBuilder
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problems
RPDefBuilder theRPDefBuilder = (RPDefBuilder) obj;
Method Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public boolean canBuild(Object vtDataSource) throws IOException, AutomationException
canBuild
in interface IRasterBuilder2
vtDataSource
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void validate() throws IOException, AutomationException
validate
in interface IRasterBuilder2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanMergeItems() throws IOException, AutomationException
isCanMergeItems
in interface IRasterBuilder2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isMergeItems() throws IOException, AutomationException
isMergeItems
in interface IRasterBuilder2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMergeItems(boolean pbMergeItems) throws IOException, AutomationException
setMergeItems
in interface IRasterBuilder2
pbMergeItems
- The pbMergeItems (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataSourceCrawler getRecommendedCrawler(IPropertySet pDataSourceProperties) throws IOException, AutomationException
getRecommendedCrawler
in interface IRasterBuilder
pDataSourceProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void beginConstruction(IDataSourceCrawler pCrawler) throws IOException, AutomationException
beginConstruction
in interface IRasterBuilder
pCrawler
- A reference to a com.esri.arcgis.datasourcesraster.IDataSourceCrawler (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void constructURIs(Object crawlerItem) throws IOException, AutomationException
constructURIs
in interface IRasterBuilder
crawlerItem
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IItemURI getNextURI() throws IOException, AutomationException
getNextURI
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IItemURIArray endConstruction() throws IOException, AutomationException
endConstruction
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isStale(IItemURI pItemURI) throws IOException, AutomationException
isStale
in interface IRasterBuilder
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IBuilderItem build(IItemURI pItemURI) throws IOException, AutomationException
build
in interface IRasterBuilder
pItemURI
- A reference to a com.esri.arcgis.datasourcesraster.IItemURI (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setPropertiesByRef(IPropertySet ppBuilderPoperties) throws IOException, AutomationException
setPropertiesByRef
in interface IRasterBuilder
ppBuilderPoperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getProperties() throws IOException, AutomationException
getProperties
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAuxiliaryFieldsByRef(IFields ppAuxiliaryFields) throws IOException, AutomationException
setAuxiliaryFieldsByRef
in interface IRasterBuilder
ppAuxiliaryFields
- A reference to a com.esri.arcgis.geodatabase.IFields (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFields getAuxiliaryFields() throws IOException, AutomationException
getAuxiliaryFields
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setAuxiliaryFieldAliasByRef(IPropertySet ppFieldNameMap) throws IOException, AutomationException
setAuxiliaryFieldAliasByRef
in interface IRasterBuilder
ppFieldNameMap
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getAuxiliaryFieldAlias() throws IOException, AutomationException
getAuxiliaryFieldAlias
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanBuildInPlace() throws IOException, AutomationException
isCanBuildInPlace
in interface IRasterBuilder
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setMosaicDatasetByRef(IMosaicDataset ppMosaicDataset) throws IOException, AutomationException
setMosaicDatasetByRef
in interface IRasterBuilderInit
ppMosaicDataset
- A reference to a com.esri.arcgis.datasourcesraster.IMosaicDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IMosaicDataset getMosaicDataset() throws IOException, AutomationException
getMosaicDataset
in interface IRasterBuilderInit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTrackCancelByRef(ITrackCancel ppTrackCancel) throws IOException, AutomationException
setTrackCancelByRef
in interface IRasterBuilderInit
ppTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITrackCancel getTrackCancel() throws IOException, AutomationException
getTrackCancel
in interface IRasterBuilderInit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefaultSpatialReferenceByRef(ISpatialReference ppDefaultSrs) throws IOException, AutomationException
setDefaultSpatialReferenceByRef
in interface IRasterBuilderInit
ppDefaultSrs
- A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getDefaultSpatialReference() throws IOException, AutomationException
getDefaultSpatialReference
in interface IRasterBuilderInit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRasterTypeOperationByRef(IRasterTypeOperation ppRasterTypeOperation) throws IOException, AutomationException
setRasterTypeOperationByRef
in interface IRasterBuilderInit
ppRasterTypeOperation
- A reference to a com.esri.arcgis.datasourcesraster.IRasterTypeOperation (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IRasterTypeOperation getRasterTypeOperation() throws IOException, AutomationException
getRasterTypeOperation
in interface IRasterBuilderInit
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |