ilog.views.maps.defense.format.vmap

Class IlvVMAPReader

java.lang.Object

ilog.views.maps.defense.format.vmap.IlvVMAPReader

All Implemented Interfaces:

IlvPersistentObject, IlvMapFeatureIterator, IlvMapReusableFeatureIterator, IlvMapRegionOfInterestIterator

public class IlvVMAPReader
extends Object
implements IlvMapRegionOfInterestIterator, IlvPersistentObject

Reader for VMAP database files.

Since:

JViews 7.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_FACC_CODE Property name for FACC Code.

Constructor Summary

Constructors

Constructor and Description
IlvVMAPReader(IlvInputStream stream) Constructs an IlvVMAPReader from the input stream
IlvVMAPReader(String databasePath) Constructs a IlvVMAPReader from a specified database path.

Method Summary

Modifier and Type	Method and Description
void	clearRegionOfInterest() Sets the reader not to use the previously specified region of interest.
void	clearTableCache() Deletes all previously read tables (stored in cache).
void	closeAllVMAPDataInputs() Close all table data inputs opened by this VMAP reader
void	dispose() Releases resources uses by this reader.
IlvCoordinateSystem	getCoordinateSystem() Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.
IlvFeatureRenderer	getDefaultFeatureRenderer() Returns the default feature renderer used for the rendering of map features read by this reader.
String[]	getFeatureClassList(String[] faccCodes1) Returns the list of feature classes that contain at least one of specified facc codes
IlvVMAPGeometryFactory	getGeometryFactory(IlvVMAPTable featureTable) Gets appropriate IlvMapGeometry factory for a given feature class table.
Rectangle2D	getLatLonBounds() Returns the latitude/longitude bounds for the list of all geometries or null if such is not available.
String	getLibraryName() Returns the name of the library currently being built.
IlvCoordinate	getLowerRightCorner() Returns the lower right corner of the rectangle containing all the map feature of the list, or null if the iterator cannot provide this information.
IlvMapFeature	getNextFeature() Returns the next map feature of the iterator or null if the iteration is finished.
IlvCoordinate	getUpperLeftCorner() Returns the upper left corner of the rectangle containing all the map features of the list, or null if the iterator cannot provide this information.
IlvVMAPTable	getVMAPTable(String filename, boolean readFully) Gets the VMAP table of specified filename.
boolean	isGeoreferenced() Returns true if the map reader can provide the source projection of its map features.
void	restart() Rewinds the iterator for a new use.
void	setFaccFilter(String[] faccCodes) Configures this reader to read only features with specified FACC codes.
void	setFeatureClassFilter(String[] featureClasses) Configures this reader to read only features of specified feature classes.
void	setFeatureClassFilter(String[] featureClasses, String[] faccCodes) Configures this reader to read only features of specified feature classes and with specified facc codes only.
void	setLibraryName(String libraryName) Sets the library used from which to build data.
void	setRegionOfInterest(double lonMin, double latMin, double lonMax, double latMax) Sets region of interest to keep only features in this region when reading VMAP database.
void	setUseOptionalData(boolean use) Sets whether the reader should use VMAP feature records as gis components ID.
void	setVerbose(boolean verbose) Print error messages on the standard output stream.
void	setVerbose(boolean verbose, PrintStream printStream) Print error messages on the specified output.
void	write(IlvOutputStream stream) Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_FACC_CODE

public static final String PROPERTY_FACC_CODE

Property name for FACC Code.

See Also:

Constant Field Values

Constructor Detail

IlvVMAPReader

public IlvVMAPReader(String databasePath)

Constructs a IlvVMAPReader from a specified database path.

Parameters:

databasePath - Database directory.

IlvVMAPReader

public IlvVMAPReader(IlvInputStream stream)
              throws IlvReadFileException

Constructs an IlvVMAPReader from the input stream

Parameters:

stream - the IlvInputStream to read from

Throws:

IlvReadFileException

Since:

JViews 7.5

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of a persistent object.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - the output stream

Throws:

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

Since:

JViews 7.5

See Also:

IlvPersistentObject.write(ilog.views.io.IlvOutputStream)

setRegionOfInterest

public void setRegionOfInterest(double lonMin,
                                double latMin,
                                double lonMax,
                                double latMax)

Sets region of interest to keep only features in this region when reading VMAP database.

Specified by:

setRegionOfInterest in interface IlvMapRegionOfInterestIterator

Parameters:

lonMin - min longitude (x) in Radians.

latMin - min latitude (y) in Radians.

lonMax - max longitude (x) in Radians.

latMax - max latitude (y) in Radians.

clearRegionOfInterest

public void clearRegionOfInterest()

Sets the reader not to use the previously specified region of interest. The reader will read all features in VMAP database extents.

setVerbose

public void setVerbose(boolean verbose,
                       PrintStream printStream)

Print error messages on the specified output. Default is non verbose, and default PrintStream is System.out.

Parameters:

verbose - true for verbose messages.

printStream - Print stream where messages should go.

setVerbose

public void setVerbose(boolean verbose)

Print error messages on the standard output stream. Default is non verbose.

Parameters:

verbose - true for verbose messages.

setUseOptionalData

public void setUseOptionalData(boolean use)

Sets whether the reader should use VMAP feature records as gis components ID.

Parameters:

use - true if optional data should be read.

setFaccFilter

public void setFaccFilter(String[] faccCodes)

Configures this reader to read only features with specified FACC codes. This resets the reader as a IlvMapFeatureIterator

Parameters:

faccCodes - the FACC codes of features to read.

getFeatureClassList

public String[] getFeatureClassList(String[] faccCodes1)

Returns the list of feature classes that contain at least one of specified facc codes

Parameters:

faccCodes1 - a list of desired facc codes

Returns:

featureClassList the list of VMAP feature classes containing specified facc codes

setFeatureClassFilter

public void setFeatureClassFilter(String[] featureClasses)

Configures this reader to read only features of specified feature classes. This resets the reader as a IlvMapFeatureIterator

Parameters:

featureClasses - the featureClasses to read.

setFeatureClassFilter

public void setFeatureClassFilter(String[] featureClasses,
                                  String[] faccCodes)

Configures this reader to read only features of specified feature classes and with specified facc codes only. This resets the reader as a IlvMapFeatureIterator

Parameters:

featureClasses - the featureClasses to read.

faccCodes - the facc codes of features to read.

getNextFeature

public IlvMapFeature getNextFeature()
                             throws IOException

Returns the next map feature of the iterator or null if the iteration is finished. The returned map feature must be considered as volatile and can be modified by the reader during the next call to its getNextFeature function.

Specified by:

getNextFeature in interface IlvMapFeatureIterator

Returns:

the next available feature or null if the iteration is finished.

Throws:

IOException - if an exception occurred when reading VMAP files.

closeAllVMAPDataInputs

public void closeAllVMAPDataInputs()
                            throws IOException

Close all table data inputs opened by this VMAP reader

Throws:

IOException - if an exception occurred when closing input streams.

getVMAPTable

public IlvVMAPTable getVMAPTable(String filename,
                                 boolean readFully)
                          throws IOException,
                                 IlvVMAPFormatException

Gets the VMAP table of specified filename. Caches them to improve performance.

Parameters:

filename - File name of requested VMAP table.

readFully - @see IlvVMAPTable#readTable(boolean)

Returns:

The table definition read.

Throws:

IOException - if there was an error when reading VMAP files.

IlvVMAPFormatException - if the table does not comply with VMAP specifications.

getGeometryFactory

public IlvVMAPGeometryFactory getGeometryFactory(IlvVMAPTable featureTable)

Gets appropriate IlvMapGeometry factory for a given feature class table.

Parameters:

featureTable - the specified VMAP table.

Returns:

The map geometry factory to use.

Since:

JViews 8.1

getLibraryName

public String getLibraryName()

Returns the name of the library currently being built.

Returns:

The name of the library currently being built.

setLibraryName

public void setLibraryName(String libraryName)

Sets the library used from which to build data.

Parameters:

libraryName - Name of library to use.

isGeoreferenced

public boolean isGeoreferenced()

Returns true if the map reader can provide the source projection of its map features.

Specified by:

isGeoreferenced in interface IlvMapFeatureIterator

Returns:

true if the map reader can provide a source projection

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem()

Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.

Specified by:

getCoordinateSystem in interface IlvMapFeatureIterator

Returns:

The coordinate system, or null if the coordinate system is unknown.

getUpperLeftCorner

public IlvCoordinate getUpperLeftCorner()

Returns the upper left corner of the rectangle containing all the map features of the list, or null if the iterator cannot provide this information.

Specified by:

getUpperLeftCorner in interface IlvMapFeatureIterator

Returns:

the coordinate of the upper left corner.

getLowerRightCorner

public IlvCoordinate getLowerRightCorner()

Returns the lower right corner of the rectangle containing all the map feature of the list, or null if the iterator cannot provide this information.

Specified by:

getLowerRightCorner in interface IlvMapFeatureIterator

Returns:

the coordinate of the lower right corner.

getDefaultFeatureRenderer

public IlvFeatureRenderer getDefaultFeatureRenderer()

Returns the default feature renderer used for the rendering of map features read by this reader.

Specified by:

getDefaultFeatureRenderer in interface IlvMapFeatureIterator

Returns:

the default IlvFeatureRenderer for this reader

dispose

public void dispose()

Releases resources uses by this reader. Closes all input streams.

Specified by:

dispose in interface IlvMapFeatureIterator

clearTableCache

public void clearTableCache()

Deletes all previously read tables (stored in cache). Any subsequent access to these table implies a reload of the table from the file system.

restart

public void restart()

Rewinds the iterator for a new use.

Specified by:

restart in interface IlvMapReusableFeatureIterator

getLatLonBounds

public Rectangle2D getLatLonBounds()

Returns the latitude/longitude bounds for the list of all geometries or null if such is not available.

Specified by:

getLatLonBounds in interface IlvMapRegionOfInterestIterator

Returns:

a rectangle enclosing all features.

Since:

JViews 7.5