com.esri.arcgis.carto
Class TileCacheInfo

java.lang.Object
  com.esri.arcgis.carto.TileCacheInfo

All Implemented Interfaces:

ITileCacheInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class TileCacheInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITileCacheInfo, IXMLSerialize, IPersistStream, IPersist, IXMLVersionSupport, Externalizable

A Tile Cache Info object.

Remarks

TileCacheInfo object contains information on the tiling scheme for the cache. The tiling scheme includes the tiling origin, spatial reference, tile size in pixels and information on the Levels of Detail at which the service is cached.

Using the tiling scheme information in the TileCacheInfo object the client can calculate the tiles that cover any rectangular extent in map space and then retrieve tiles either directly from the virtual directory, or from the tile handler or by making GetMapTile or GetLayerTile requests against the map service.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TileCacheInfo()
Constructs a TileCacheInfo using ArcGIS Engine.

TileCacheInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TileCacheInfo theTileCacheInfo = (TileCacheInfo) obj;

Method Summary

void	computeResolutions() Computes resolutions from scales and current DPI.
void	computeScales() Computes scales from resolutions and current DPI.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDpi() The tiling DPI.
ILODInfos	getLODInfos() The tile cache Levels Of Details.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IPoint	getOrigin() The tiling origin.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The tiling spatial reference.
int	getTileCols() The number of columns per tile.
int	getTileRows() The number of rows per tile.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setDpi(int pDpi) The tiling DPI.
void	setLODInfosByRef(ILODInfos ppLODInfos) The tile cache Levels Of Details.
void	setOrigin(IPoint ppOrigin) The tiling origin.
void	setSpatialReferenceByRef(ISpatialReference ppSpatialReference) The tiling spatial reference.
void	setTileCols(int pNumTileCols) The number of columns per tile.
void	setTileRows(int pNumTileRows) The number of rows per tile.
void	writeExternal(ObjectOutput out)

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

TileCacheInfo

public TileCacheInfo()
              throws IOException,
                     UnknownHostException

Constructs a TileCacheInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TileCacheInfo

public TileCacheInfo(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TileCacheInfo theTileCacheInfo = (TileCacheInfo) obj;

Construct a TileCacheInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to TileCacheInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The tiling spatial reference.

Product Availability

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

Specified by:

getSpatialReference in interface ITileCacheInfo

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference ppSpatialReference)
                              throws IOException,
                                     AutomationException

The tiling spatial reference.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface ITileCacheInfo

Parameters:

ppSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrigin

public IPoint getOrigin()
                 throws IOException,
                        AutomationException

The tiling origin.

Remarks

The tiling origin is in map space, and it is the same for all levels of detail (LODs).

Product Availability

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

Specified by:

getOrigin in interface ITileCacheInfo

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.

setOrigin

public void setOrigin(IPoint ppOrigin)
               throws IOException,
                      AutomationException

The tiling origin.

Product Availability

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

Specified by:

setOrigin in interface ITileCacheInfo

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.

getTileCols

public int getTileCols()
                throws IOException,
                       AutomationException

The number of columns per tile.

Product Availability

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

Specified by:

getTileCols in interface ITileCacheInfo

Returns:

The pNumTileCols

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileCols

public void setTileCols(int pNumTileCols)
                 throws IOException,
                        AutomationException

The number of columns per tile.

Product Availability

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

Specified by:

setTileCols in interface ITileCacheInfo

Parameters:

pNumTileCols - The pNumTileCols (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTileRows

public int getTileRows()
                throws IOException,
                       AutomationException

The number of rows per tile.

Product Availability

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

Specified by:

getTileRows in interface ITileCacheInfo

Returns:

The pNumTileRows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTileRows

public void setTileRows(int pNumTileRows)
                 throws IOException,
                        AutomationException

The number of rows per tile.

Product Availability

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

Specified by:

setTileRows in interface ITileCacheInfo

Parameters:

pNumTileRows - The pNumTileRows (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDpi

public int getDpi()
           throws IOException,
                  AutomationException

The tiling DPI.

Product Availability

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

Specified by:

getDpi in interface ITileCacheInfo

Returns:

The pDpi

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDpi

public void setDpi(int pDpi)
            throws IOException,
                   AutomationException

The tiling DPI.

Product Availability

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

Specified by:

setDpi in interface ITileCacheInfo

Parameters:

pDpi - The pDpi (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLODInfos

public ILODInfos getLODInfos()
                      throws IOException,
                             AutomationException

The tile cache Levels Of Details.

Product Availability

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

Specified by:

getLODInfos in interface ITileCacheInfo

Returns:

A reference to a com.esri.arcgis.carto.ILODInfos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLODInfosByRef

public void setLODInfosByRef(ILODInfos ppLODInfos)
                      throws IOException,
                             AutomationException

The tile cache Levels Of Details.

Product Availability

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

Specified by:

setLODInfosByRef in interface ITileCacheInfo

Parameters:

ppLODInfos - A reference to a com.esri.arcgis.carto.ILODInfos (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeResolutions

public void computeResolutions()
                        throws IOException,
                               AutomationException

Computes resolutions from scales and current DPI.

Product Availability

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

Specified by:

computeResolutions in interface ITileCacheInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

computeScales

public void computeScales()
                   throws IOException,
                          AutomationException

Computes scales from resolutions and current DPI.

Product Availability

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

Specified by:

computeScales in interface ITileCacheInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException