com.esri.arcgis.datasourcesraster
Class IOverviewTileParametersProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.datasourcesraster.IOverviewTileParametersProxy
All Implemented Interfaces:
IOverviewTileParameters, Externalizable, Serializable

public class IOverviewTileParametersProxy
extends com.esri.arcgis.interop.Dispatch
implements IOverviewTileParameters, Serializable

Provides access to members that control overview tile parameters.

Product Availability

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

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IOverviewTileParametersProxy()
           
  IOverviewTileParametersProxy(Object obj)
           
protected IOverviewTileParametersProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 IGeometry getAoiGeometry()
          The polygon within which overview tiles are created.
 double getCellSize()
          The cell size of the first level of overview tiles in the units of the coordinate system of the catalog.
 int getLevels()
          The number of levels of overview tiles created.
 int getMaximumSizeOfTopmostOverview()
          The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
 IPoint getOrigin()
          The origin of the grid containing overview tiles.
 int getOverviewFactor()
          The factor by which two neighboring overview levels differ.
 int getTileCols()
          The recommended number of pixel columns in each overview tiles.
 int getTileRows()
          The recommended number of pixel rows in each overview tiles.
 IWorkspaceName getWorkspaceName()
          The workspace name where overview raster datasets are generated and stored.
 void removeListener(String iidStr, Object theListener)
           
 void setAoiGeometryByRef(IGeometry ppAoiGeometry)
          The polygon within which overview tiles are created.
 void setCellSize(double pCellsize)
          The cell size of the first level of overview tiles in the units of the coordinate system of the catalog.
 void setLevels(int pLevels)
          The number of levels of overview tiles created.
 void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
          The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item.
 void setOriginByRef(IPoint ppOrigin)
          The origin of the grid containing overview tiles.
 void setOverviewFactor(int pOverviewFactor)
          The factor by which two neighboring overview levels differ.
 void setTileCols(int pTileColPixels)
          The recommended number of pixel columns in each overview tiles.
 void setTileRows(int pTileRowPixels)
          The recommended number of pixel rows in each overview tiles.
 void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
          The workspace name where overview raster datasets are generated and stored.
 
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

noncastable

public boolean noncastable
Constructor Detail

IOverviewTileParametersProxy

public IOverviewTileParametersProxy()

IOverviewTileParametersProxy

public IOverviewTileParametersProxy(Object obj)
                             throws IOException
Throws:
IOException

IOverviewTileParametersProxy

protected IOverviewTileParametersProxy(Object obj,
                                       String iid)
                                throws IOException
Throws:
IOException
Method Detail

addListener

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

removeListener

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

setAoiGeometryByRef

public void setAoiGeometryByRef(IGeometry ppAoiGeometry)
                         throws IOException,
                                AutomationException
The polygon within which overview tiles are created.

Product Availability

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

Specified by:
setAoiGeometryByRef in interface IOverviewTileParameters
Parameters:
ppAoiGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAoiGeometry

public IGeometry getAoiGeometry()
                         throws IOException,
                                AutomationException
The polygon within which overview tiles are created.

Product Availability

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

Specified by:
getAoiGeometry in interface IOverviewTileParameters
Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOriginByRef

public void setOriginByRef(IPoint ppOrigin)
                    throws IOException,
                           AutomationException
The origin of the grid containing overview tiles.

Product Availability

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

Specified by:
setOriginByRef in interface IOverviewTileParameters
Parameters:
ppOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrigin

public IPoint getOrigin()
                 throws IOException,
                        AutomationException
The origin of the grid containing overview tiles.

Product Availability

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

Specified by:
getOrigin in interface IOverviewTileParameters
Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCellSize

public void setCellSize(double pCellsize)
                 throws IOException,
                        AutomationException
The cell size of the first level of overview tiles in the units of the coordinate system of the catalog. If this property is not specified, the default value is computed automatically.

Product Availability

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

Specified by:
setCellSize in interface IOverviewTileParameters
Parameters:
pCellsize - The pCellsize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public double getCellSize()
                   throws IOException,
                          AutomationException
The cell size of the first level of overview tiles in the units of the coordinate system of the catalog. If this property is not specified, the default value is computed automatically.

Product Availability

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

Specified by:
getCellSize in interface IOverviewTileParameters
Returns:
The pCellsize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileCols

public void setTileCols(int pTileColPixels)
                 throws IOException,
                        AutomationException
The recommended number of pixel columns in each overview tiles.

Product Availability

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

Specified by:
setTileCols in interface IOverviewTileParameters
Parameters:
pTileColPixels - The pTileColPixels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileCols

public int getTileCols()
                throws IOException,
                       AutomationException
The recommended number of pixel columns in each overview tiles.

Product Availability

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

Specified by:
getTileCols in interface IOverviewTileParameters
Returns:
The pTileColPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTileRows

public void setTileRows(int pTileRowPixels)
                 throws IOException,
                        AutomationException
The recommended number of pixel rows in each overview tiles.

Product Availability

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

Specified by:
setTileRows in interface IOverviewTileParameters
Parameters:
pTileRowPixels - The pTileRowPixels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTileRows

public int getTileRows()
                throws IOException,
                       AutomationException
The recommended number of pixel rows in each overview tiles.

Product Availability

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

Specified by:
getTileRows in interface IOverviewTileParameters
Returns:
The pTileRowPixels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLevels

public void setLevels(int pLevels)
               throws IOException,
                      AutomationException
The number of levels of overview tiles created.

Product Availability

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

Specified by:
setLevels in interface IOverviewTileParameters
Parameters:
pLevels - The pLevels (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLevels

public int getLevels()
              throws IOException,
                     AutomationException
The number of levels of overview tiles created.

Product Availability

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

Specified by:
getLevels in interface IOverviewTileParameters
Returns:
The pLevels
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverviewFactor

public void setOverviewFactor(int pOverviewFactor)
                       throws IOException,
                              AutomationException
The factor by which two neighboring overview levels differ.

Product Availability

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

Specified by:
setOverviewFactor in interface IOverviewTileParameters
Parameters:
pOverviewFactor - The pOverviewFactor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverviewFactor

public int getOverviewFactor()
                      throws IOException,
                             AutomationException
The factor by which two neighboring overview levels differ.

Product Availability

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

Specified by:
getOverviewFactor in interface IOverviewTileParameters
Returns:
The pOverviewFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumSizeOfTopmostOverview

public void setMaximumSizeOfTopmostOverview(int pMaximumSizeOfTopmostOverview)
                                     throws IOException,
                                            AutomationException
The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews. The operation continues to define a new level as long as the number of pixels of the overv????&

Product Availability

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

Specified by:
setMaximumSizeOfTopmostOverview in interface IOverviewTileParameters
Parameters:
pMaximumSizeOfTopmostOverview - The pMaximumSizeOfTopmostOverview (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumSizeOfTopmostOverview

public int getMaximumSizeOfTopmostOverview()
                                    throws IOException,
                                           AutomationException
The recommended maximum size (in pixels) on any dimension for the lowest resolution overview item. A higher value for this property results in fewer levels of overviews. The operation continues to define a new level as long as the number of pixels of the overv????&

Product Availability

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

Specified by:
getMaximumSizeOfTopmostOverview in interface IOverviewTileParameters
Returns:
The pMaximumSizeOfTopmostOverview
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName ppOverviewWorkspaceName)
                           throws IOException,
                                  AutomationException
The workspace name where overview raster datasets are generated and stored.

Product Availability

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

Specified by:
setWorkspaceNameByRef in interface IOverviewTileParameters
Parameters:
ppOverviewWorkspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException
The workspace name where overview raster datasets are generated and stored.

Product Availability

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

Specified by:
getWorkspaceName in interface IOverviewTileParameters
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.