ilog.views.maps.format.cadrg
Class IlvCADRGTocReader

java.lang.Object
  ilog.views.maps.format.cadrg.IlvCADRGTocReader

public class IlvCADRGTocReader
extends Object

This reader reads the table of contents of a CADRG file. The table of contents is usually located in a directory called CADRG/RPF and is named A.TOC. The table of contents of the CADRG product contains information about the CADRG coverages stored in the data base.

Since:

ILOG JViews 3.0

Constructor Summary

IlvCADRGTocReader(String fileName)
Creates an instance of IlvCADRGTocReader and reads the table of contents.

IlvCADRGTocReader(URL url)
Creates an instance of IlvCADRGTocReader for the specified URL and reads the table of contents.

Method Summary

void	dispose() Releases the resources allocated by the reader.
void	finalize() Enables the Java Garbage Collector to release the resources allocated by the reader.
IlvCADRGCoverage[]	getCoverages() Returns the coverages of the CADRG data base.
Enumeration	getLegendFrames() Returns the list of the frames that are located in the LEGEND directory.
Enumeration	getOverviewFrames() Returns the list of overview frames that are located in the CADRG main directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvCADRGTocReader

public IlvCADRGTocReader(String fileName)
                  throws FileNotFoundException,
                         IOException,
                         IlvMapFormatException

Creates an instance of IlvCADRGTocReader and reads the table of contents.

Parameters:

fileName - The name of the file containing the CADRG table of contents.

Throws:

FileNotFoundException - if the file cannot be opened.

IOException - if an I/O error occurs.

IlvMapFormatException - if the file is not a CADRG file.

IlvCADRGTocReader

public IlvCADRGTocReader(URL url)
                  throws IOException,
                         IlvMapFormatException

Creates an instance of IlvCADRGTocReader for the specified URL and reads the table of contents.

Parameters:

url - The URL of the file containing the CADRG table of contents.

Throws:

FileNotFoundException - if the file cannot be opened.

IOException - if an I/O error occurs.

IlvMapFormatException - if the file is not a CADRG file.

Method Detail

getLegendFrames

public Enumeration getLegendFrames()

Returns the list of the frames that are located in the LEGEND directory.

Returns:

an enumeration of IlvCADRGFrame.

getOverviewFrames

public Enumeration getOverviewFrames()

Returns the list of overview frames that are located in the CADRG main directory.

Returns:

an enumeration of IlvCADRGFrame .

getCoverages

public IlvCADRGCoverage[] getCoverages()

Returns the coverages of the CADRG data base.

dispose

public void dispose()

Releases the resources allocated by the reader. This method can be called several times, but only the first call actually frees the resources.

finalize

public void finalize()

Enables the Java Garbage Collector to release the resources allocated by the reader.

Overrides:

finalize in class Object