ilog.views.maps.format.shapefile

Class IlvShapeFileTileLoader

java.lang.Object

ilog.views.maps.format.IlvMapTileLoader

ilog.views.maps.format.shapefile.IlvShapeFileTileLoader

All Implemented Interfaces:

IlvPersistentObject, IlvTileLoader, Serializable

Direct Known Subclasses:

IlvTiledShapeDataSource.FilteredShapeFileTileLoader

public class IlvShapeFileTileLoader
extends IlvMapTileLoader

This class implements a tile loader to read tiles from an ESRI Shapefile whose spatial index has been created.
An ESRI Shapefile can be opened in load-on-demand mode if:

• The main file of the ESRI Shapefile is present (.shp file).
• The index file of the ESRI Shapefile is present (.shx file).
• A Perforce JViews spatial index for the Shapefile is present (typically, .idx files).

If an attribute table (.dbf file) is available, the attributes can be attached to objects.
Since JViews 5.0, this tile loader uses the following policy to find files whose names are used to create this tile loader:

• If the path names are absolute path names, then they are read from the specified path.
• If the path names are not absolute path names, the relative path names are resolved in the following order, until an existing file is found:
  • Path names are resolved using IlvMapDataPathManager.
  • If this tile loader is loaded from an IlvInputStream, the path names are considered relative to the document base of the input stream.

Since:

JViews 4.0

See Also:

IlvMapDataPathManager, IlvInputStream.getDocumentBase(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvShapeFileTileLoader(IlvInputStream stream) Reads an IlvShapeFileTileLoader from the specified input stream.
IlvShapeFileTileLoader(String shpFilename, String dbfFilename, String shxFilename, String indexFilename) Constructs a new .shp file tile loader.
IlvShapeFileTileLoader(URL shpURL, URL dbfURL, URL shxURL, URL indexURL) Constructs a new .shp file tile loader.

Method Summary

Modifier and Type	Method and Description
IlvCoordinateSystem	getCoordinateSystem() Returns the spatial reference system that describes the coordinate system of the tile loader.
String	getDBFFilename() Returns the .dbf file from which this tile loader loads attributes.
URL	getDBFURL() Retrieves the DBF file URL.
IlvFeatureRenderer	getDefaultFeatureRenderer() Returns the default feature renderer for this tile loader.
IlvMapFeatureIterator	getFeatureIterator(IlvTile tile) Returns the feature iterator to load features from the specified tile.
IlvCoordinate	getLowerRightCorner() Returns the lower right corner of data read by this tile loader.
protected IlvShapeFileReader	getReader(String shpFilename, String dbfFilename, String shxFilename) Creates the IlvShapeFileReader to read from specified files.
protected IlvShapeFileReader	getReader(URL shp, URL dbf, URL shx) Creates the IlvShapeFileReader to read from specified files.
String	getSHPFilename() Returns the .shp file from which this tile loader loads geometries.
URL	getSHPURL() Retrieves the shape file URL.
String	getSHXFilename() Returns the .shx file used as the shape index file.
URL	getSHXURL() Retrieves the shx file URL.
String	getSpatialIndexFilename() Returns the spatial index file used by this tile loader to index geometries by tile.
URL	getSpatialIndexURL() Retrieves the spatial index file URL.
String	getStringEncoding() Returns the character encoding used when reading the .dbf attribute table.
IlvRect	getTileOrigin() Returns the tile origin.
IlvCoordinate	getUpperLeftCorner() Returns the upper left corner of data read by this tile loader.
boolean	isInterningStringAttributes() Returns true if the String attributes that are read are interned.
boolean	isPersistent() Returns true if the object is persistent.
void	setCoordinateSystem(IlvCoordinateSystem cs) Used to specify the source coordinate system of the geometries handled by this tile loader.
void	setInterningStringAttributes(boolean interningStrings) Specifies whether the String attributes that are read are interned.
void	setStringEncoding(String encoding) Specifies the character encoding used when reading the .dbf attribute table.
void	write(IlvOutputStream stream) Writes this tile loader to the specified stream.

Methods inherited from class ilog.views.maps.format.IlvMapTileLoader

getFeatureRenderer, isAttachingAttributes, load, release, setAttachingAttributes, setFeatureRenderer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvShapeFileTileLoader

public IlvShapeFileTileLoader(String shpFilename,
                              String dbfFilename,
                              String shxFilename,
                              String indexFilename)
                       throws IOException

Constructs a new .shp file tile loader.

Parameters:

shpFilename - The name of the .shp filename.

dbfFilename - The name of the .dbf filename.

shxFilename - The name of the .shx filename.

indexFilename - The name of the Perforce JViews spatial index filename.

Throws:

IOException

IlvShapeFileTileLoader

public IlvShapeFileTileLoader(URL shpURL,
                              URL dbfURL,
                              URL shxURL,
                              URL indexURL)
                       throws IOException

Constructs a new .shp file tile loader.

Parameters:

shpURL - The URL of the .shp filename.

dbfURL - The URL of the .dbf filename.

shxURL - The URL of the .shx filename.

indexURL - The URL of the Perforce JViews spatial index filename.

Throws:

IOException

Since:

JViews 7.5

IlvShapeFileTileLoader

public IlvShapeFileTileLoader(IlvInputStream stream)
                       throws IlvReadFileException,
                              IOException

Reads an IlvShapeFileTileLoader from the specified input stream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - If a tile loader cannot be read from the specified stream.

IOException - If an I/O error occurs.

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes this tile loader to the specified stream.

Specified by:

write in interface IlvPersistentObject

Specified by:

write in interface IlvTileLoader

Overrides:

write in class IlvMapTileLoader

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

getTileOrigin

public IlvRect getTileOrigin()

Returns the tile origin.

getUpperLeftCorner

public IlvCoordinate getUpperLeftCorner()

Returns the upper left corner of data read by this tile loader.

getLowerRightCorner

public IlvCoordinate getLowerRightCorner()

Returns the lower right corner of data read by this tile loader.

getFeatureIterator

public IlvMapFeatureIterator getFeatureIterator(IlvTile tile)
                                         throws Exception

Returns the feature iterator to load features from the specified tile.
This implementation returns an IlvLookAheadFeatureIterator to read features for the specified tile.

Specified by:

getFeatureIterator in class IlvMapTileLoader

Parameters:

tile - The tile.

Returns:

The feature iterator to load features for this tile, or null if no features are to be loaded.

Throws:

Exception

See Also:

IlvLookAheadFeatureIterator

getDefaultFeatureRenderer

public IlvFeatureRenderer getDefaultFeatureRenderer()

Returns the default feature renderer for this tile loader.

Specified by:

getDefaultFeatureRenderer in class IlvMapTileLoader

isPersistent

public boolean isPersistent()

Returns true if the object is persistent.

Specified by:

isPersistent in interface IlvTileLoader

Specified by:

isPersistent in class IlvMapTileLoader

setStringEncoding

public void setStringEncoding(String encoding)

Specifies the character encoding used when reading the .dbf attribute table. The default is to use the default character encoding of the platform. See the Java internationalization documentation for the set of supported encodings.

Parameters:

encoding - The string encoding, or null to read attributes using the default encoding of the platform.

getStringEncoding

public String getStringEncoding()

Returns the character encoding used when reading the .dbf attribute table. The default is to use the default character encoding of the platform.

Returns:

The string encoding or null if using the default encoding of the platform.

setCoordinateSystem

public void setCoordinateSystem(IlvCoordinateSystem cs)

Used to specify the source coordinate system of the geometries handled by this tile loader.

Parameters:

cs - The coordinate system of the tile loader.

Since:

JViews 5.0

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem()

Returns the spatial reference system that describes the coordinate system of the tile loader.

Returns:

The coordinate system.

Since:

JViews 5.0

getReader

protected IlvShapeFileReader getReader(String shpFilename,
                                       String dbfFilename,
                                       String shxFilename)
                                throws IOException

Creates the IlvShapeFileReader to read from specified files. Subclasses of IlvShapeFileTileLoader can override this method to produce a reader with the customized parameters for specific applications.

Parameters:

shpFilename - The name of the .shp filename.

dbfFilename - The name of the .dbf filename.

shxFilename - The name of the .shx filename.

Returns:

The default implementation returns an IlvShapeFileReader with the specified files.

Throws:

IOException

See Also:

getFeatureIterator(ilog.views.tiling.IlvTile)

getReader

protected IlvShapeFileReader getReader(URL shp,
                                       URL dbf,
                                       URL shx)
                                throws IOException

Creates the IlvShapeFileReader to read from specified files. Subclasses of IlvShapeFileTileLoader can override this method to produce a reader with the customized parameters for specific applications.

Parameters:

shp - The URL of the .shp filename.

dbf - The URL of the .dbf filename.

shx - The URL of the .shx filename.

Returns:

The default implementation returns an IlvShapeFileReader with the specified files.

Throws:

IOException

Since:

JViews 7.5

See Also:

getFeatureIterator(ilog.views.tiling.IlvTile)

getSHPFilename

public final String getSHPFilename()

Returns the .shp file from which this tile loader loads geometries.

getSHXFilename

public final String getSHXFilename()

Returns the .shx file used as the shape index file.

getDBFFilename

public final String getDBFFilename()

Returns the .dbf file from which this tile loader loads attributes.

getSpatialIndexFilename

public final String getSpatialIndexFilename()

Returns the spatial index file used by this tile loader to index geometries by tile.

getSHPURL

public URL getSHPURL()

Retrieves the shape file URL.

Returns:

The shape file URL or null.

Since:

JViews 8.5

getSpatialIndexURL

public URL getSpatialIndexURL()

Retrieves the spatial index file URL.

Returns:

The idx file URL or null.

Since:

JViews 8.5

getDBFURL

public URL getDBFURL()

Retrieves the DBF file URL.

Returns:

The DBF file URL or null.

Since:

JViews 8.5

getSHXURL

public URL getSHXURL()

Retrieves the shx file URL.

Returns:

The shx file URL or null.

Since:

JViews 8.5

isInterningStringAttributes

public boolean isInterningStringAttributes()

Returns true if the String attributes that are read are interned. The default is false.

Since:

JViews 8.5

See Also:

IlvDBFReader.isInterningStringAttributes()

setInterningStringAttributes

public void setInterningStringAttributes(boolean interningStrings)

Specifies whether the String attributes that are read are interned.

Since:

JViews 8.5

See Also:

IlvDBFReader.setInterningStringAttributes(boolean)