com.esri.arcgis.datasourcesraster
Class IRasterBuilderProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.datasourcesraster.IRasterBuilderProxy
All Implemented Interfaces:
IRasterBuilder, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IRasterBuilder2Proxy

public class IRasterBuilderProxy
extends com.esri.arcgis.interop.Dispatch
implements IRasterBuilder, java.io.Serializable

Internal use class Proxy for COM Interface 'IRasterBuilder'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDataSourcesRaster.olb'

Description: 'Provides access to members that control a raster builder.' 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
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterBuilder
IID, IIDb2e3f2d4_5182_4299_aff5_41e5c9017d4f
 
Constructor Summary
  IRasterBuilderProxy()
          For internal use only
  IRasterBuilderProxy(java.lang.Object obj)
           
protected IRasterBuilderProxy(java.lang.Object obj, java.lang.String iid)
           
  IRasterBuilderProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IRasterBuilderProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 void beginConstruction(IDataSourceCrawler pCrawler)
          Initializes the raster builder for URI construction given a valid data source crawler object.
 IBuilderItem build(IItemURI pItemURI)
          Construct a builder item using the specified item URI.
 void 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.
 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.
 IItemURI getNextURI()
          Returns the next available item URI object.
 IPropertySet getProperties()
          The raster dataset builder properties.
 IDataSourceCrawler getRecommendedCrawler(IPropertySet pDataSourceProperties)
          Returns a crawler best suited for data source as recommended by the raster builder.
 boolean isCanBuildInPlace()
          Indicates whether the raster type can build an item URI as soon as it is contructed.
 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 removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 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 setPropertiesByRef(IPropertySet ppBuilderPoperties)
          The raster dataset builder properties.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IRasterBuilderProxy

public IRasterBuilderProxy(java.lang.String CLSID,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.net.UnknownHostException,
                           java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IRasterBuilderProxy

public IRasterBuilderProxy()
For internal use only


IRasterBuilderProxy

public IRasterBuilderProxy(java.lang.Object obj)
                    throws java.io.IOException
Throws:
java.io.IOException

IRasterBuilderProxy

protected IRasterBuilderProxy(java.lang.Object obj,
                              java.lang.String iid)
                       throws java.io.IOException
Throws:
java.io.IOException

IRasterBuilderProxy

protected IRasterBuilderProxy(java.lang.String CLSID,
                              java.lang.String iid,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

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.?G?^??

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.