IlvCADRGFrame (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.maps.format.cadrg.IlvCADRGFrame

```
public final class IlvCADRGFrame
extends Object
```
This class defines a CADRG frame as described in the CADRG table of contents. A frame corresponds physically to a file in a CADRG product. It can be loaded with a IlvCADRGFrameReader.
Most of the frames are georeferenced, except for those used to display the overview of a CADRG product or the map legends. Instances of IlvCADRGFrame can be obtained with an IlvCADRGCoverage.

Since:

Rogue Wave JViews 3.0

See Also:

IlvCADRGCoverage, IlvCADRGFrameReader

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getColumn()` Returns the column of the frame in its CADRG coverage.
`IlvCADRGCoverage`	`getCoverage()` Returns the coverage of the frame.
`String`	`getFileName()` Returns the file name of the frame as read from the CADRG table of contents.
`IlvCoordinate`	`getLowerRightCorner()` Returns the lower-right corner of the frame in the reader's projection (geographic).
`String`	`getPathName()` Returns the path name of the frame as read from the CADRG table of contents.
`int`	`getRow()` Returns the row of the frame in its CADRG coverage.
`IlvCoordinate`	`getUpperLeftCorner()` Returns the upper-left corner of the frame in the reader's projection (geographic).
`IlvCADRGFrameReader`	`makeReader(boolean transparency)` Initializes a frame reader for the CADRG frame.
`String`	`toString()` Converts the frame into a `String`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFileName
```
public final String getFileName()
```
    Returns the file name of the frame as read from the CADRG table of contents.
    
    See Also:
    
    IlvCADRGTocReader
  - getPathName
```
public final String getPathName()
```
    Returns the path name of the frame as read from the CADRG table of contents. The path name is relative to the directory that contains the CADRG table of contents. Returns the path name of the frame
  - getCoverage
```
public final IlvCADRGCoverage getCoverage()
```
    Returns the coverage of the frame.
  - getUpperLeftCorner
```
public final IlvCoordinate getUpperLeftCorner()
```
    Returns the upper-left corner of the frame in the reader's projection (geographic).
  - getLowerRightCorner
```
public final IlvCoordinate getLowerRightCorner()
```
    Returns the lower-right corner of the frame in the reader's projection (geographic).
  - getRow
```
public final int getRow()
```
    Returns the row of the frame in its CADRG coverage.
  - getColumn
```
public final int getColumn()
```
    Returns the column of the frame in its CADRG coverage.
  - toString
```
public final String toString()
```
    Converts the frame into a String.
    
    Overrides:
    
    toString in class Object
  - makeReader
```
public final IlvCADRGFrameReader makeReader(boolean transparency)
                                     throws IOException
```
    Initializes a frame reader for the CADRG frame.
    
    Parameters:
    
    transparency - specifies whether the transparent pixel of the CADRG frame must be rendered as transparent.
    
    Throws:
    
    IOException - if an error occurs while opening the frame.

Class IlvCADRGFrame

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFileName

getPathName

getCoverage

getUpperLeftCorner

getLowerRightCorner

getRow

getColumn

toString

makeReader