IlvMIFReader (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.format.midmif.IlvMIFReader

All Implemented Interfaces:

IlvMapFeatureIterator
```
public class IlvMIFReader
extends Object
implements IlvMapFeatureIterator
```
The class IlvMIFReader reads geometries from a MapInfo® Interchange file.
The .mif file of a MID/MIF file contains the attribute field definition, the positioning information, the geometries and rendering parameters of a MapInfo® Interchange file.
This reader implements all geometries from MID/MIF; The rendering parameters are attached to the read map features, as properties. The default renderer returned by this feature iterator, IlvMIFFeatureRenderer can take advantage of these properties to perform the proper rendering.

Since:

JViews 5.0

See Also:

IlvMIDMIFReader, IlvMIFFeatureRenderer

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BRUSH_STYLE_NAME` The name of the map feature property to specify a brush style.
`static String`	`PEN_STYLE_NAME` The name of the map feature property to specify a pen style.
`static String`	`SYMBOL_STYLE_NAME` The name of the map feature property to specify a symbol style.
`static String`	`TEXT_STYLE_NAME` The name of the map feature property to specify a text style.

Constructor Summary

Constructors
Constructor and Description
`IlvMIFReader(Reader reader)` Constructs a new `IlvMIFReader` to read from the specified reader.
`IlvMIFReader(String fileName)` Constructs a new `IlvMIFReader` to read from the file which name is specified.
`IlvMIFReader(URL url)` Constructs a new `IlvMIFReader` to read from the file which URL is specified.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` Releases the resources allocated to the reader.
`IlvAttributeInfoProperty`	`getAttributeInfo()` Returns information about the attribute values.
`String`	`getCharset()` Returns a string indicating the character set used to encode strings of this MIF/MID file.
`IlvCoordinateSystem`	`getCoordinateSystem()` Returns the spatial reference system that describes the coordinate system of geometric coordinates of the map features.
`IlvMIFCoordinateSystemFactory`	`getCoordinateSystemFactory()` Returns the factory used to create `IlvProjection` from MID/MIF files
`IlvFeatureRenderer`	`getDefaultFeatureRenderer()` Returns the default renderer used to display the map features returned by the reader.
`char`	`getDelimiter()` Returns the character used as separator in the MID file associated to this MIF file.
`int`	`getFileVersion()` Returns the MID/MIF file version of this file.
`String`	`getJavaCharset()` Returns a string indicating the charset used to encode strings of this MIF file.
`IlvCoordinate`	`getLowerRightCorner()` Returns the lower-right corner of the bounding box that delimits the objects read from the file.
`IlvMapFeature`	`getNextFeature()` Returns the next feature read from file.
`IlvMIFPenFactory`	`getPenFactory()` Returns the factory used to create `IlvMapLineRenderingStyle` associated to pen styles from the read MIF features.
`static boolean`	`getTextCompatibility()` Tells if the reader is in backward compatibility mode.
`int[]`	`getUniqueList()` Returns a array of integer indexes referring to the MID file columns associated to this MIF file.
`IlvUnit`	`getUnit()` Returns the `IlvUnit` describing the unit of the coordinates of the `IlvMapFeature` returned by this feature iterator.
`IlvCoordinate`	`getUpperLeftCorner()` Returns the upper-left corner of the bounding box that delimits the objects read from the file.
`boolean`	`isGeoreferenced()` Returns `true` if this feature iterator is georeferenced.
`void`	`setCoordinateSystemFactory(IlvMIFCoordinateSystemFactory factory)` Sets the factory used to create `IlvCoordinateSystem` from MID/MIF coordinate system specifications.
`void`	`setPenFactory(IlvMIFPenFactory factory)` Sets the factory used to create `IlvMapLineRenderingStyle` from pen styles of MIF features.
`static void`	`setTextCompatibility(boolean compat)` Ensure backward text mode compatibility.

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

- Field Detail
  - PEN_STYLE_NAME
```
public static final String PEN_STYLE_NAME
```
    The name of the map feature property to specify a pen style.
    
    See Also:
    
    Constant Field Values
  - BRUSH_STYLE_NAME
```
public static final String BRUSH_STYLE_NAME
```
    The name of the map feature property to specify a brush style.
    
    See Also:
    
    Constant Field Values
  - TEXT_STYLE_NAME
```
public static final String TEXT_STYLE_NAME
```
    The name of the map feature property to specify a text style.
    
    See Also:
    
    Constant Field Values
  - SYMBOL_STYLE_NAME
```
public static final String SYMBOL_STYLE_NAME
```
    The name of the map feature property to specify a symbol style.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IlvMIFReader
```
public IlvMIFReader(String fileName)
             throws IOException,
                    IlvMapFormatException
```
    Constructs a new IlvMIFReader to read from the file which name is specified.
    
    Parameters:
    
    fileName - The name of the .mif file to read.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    IlvMapFormatException - if the file is not in the MID/MIF format.
  - IlvMIFReader
```
public IlvMIFReader(URL url)
             throws IOException,
                    IlvMapFormatException
```
    Constructs a new IlvMIFReader to read from the file which URL is specified.
    
    Parameters:
    
    url - The name of the .mif URL to read.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    IlvMapFormatException - if the file is not in the MID/MIF format.
    
    Since:
    
    JViews 7.5
  - IlvMIFReader
```
public IlvMIFReader(Reader reader)
             throws IOException,
                    IlvMapFormatException
```
    Constructs a new IlvMIFReader to read from the specified reader.
    
    Parameters:
    
    reader - The java.io.Reader to read from.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    IlvMapFormatException - if the file is not in the MID/MIF format.
- Method Detail
  - setTextCompatibility
```
public static void setTextCompatibility(boolean compat)
```
    Ensure backward text mode compatibility.
    
    Parameters:
    
    compat - The compatibility mode.
    
    Since:
    
    JViews 6.5
  - getTextCompatibility
```
public static boolean getTextCompatibility()
```
    Tells if the reader is in backward compatibility mode.
    
    Returns:
    
    the compatibility mode.
    
    Since:
    
    JViews 6.5
  - getPenFactory
```
public IlvMIFPenFactory getPenFactory()
```
    Returns the factory used to create IlvMapLineRenderingStyle associated to pen styles from the read MIF features.
    
    See Also:
    
    IlvMIFPenFactory
  - setPenFactory
```
public void setPenFactory(IlvMIFPenFactory factory)
```
    Sets the factory used to create IlvMapLineRenderingStyle from pen styles of MIF features.
    
    Parameters:
    
    factory - The pen factory.
  - getCoordinateSystemFactory
```
public IlvMIFCoordinateSystemFactory getCoordinateSystemFactory()
```
    Returns the factory used to create IlvProjection from MID/MIF files
    
    See Also:
    
    IlvMIFCoordinateSystemFactory
  - setCoordinateSystemFactory
```
public void setCoordinateSystemFactory(IlvMIFCoordinateSystemFactory factory)
```
    Sets the factory used to create IlvCoordinateSystem from MID/MIF coordinate system specifications.
  - getNextFeature
```
public IlvMapFeature getNextFeature()
                             throws IOException,
                                    IlvMapFormatException
```
    Returns the next feature read from file.
    
    Specified by:
    
    getNextFeature in interface IlvMapFeatureIterator
    
    Throws:
    
    IOException - if an error occurs while reading the file.
    
    IlvMapFormatException - if the file contains a format error.
  - dispose
```
public void dispose()
```
    Releases the resources allocated to the reader. Once this method has been called, no other access to the reader should be performed.
    
    Specified by:
    
    dispose in interface IlvMapFeatureIterator
  - getUpperLeftCorner
```
public IlvCoordinate getUpperLeftCorner()
```
    Returns the upper-left corner of the bounding box that delimits the objects read from the file.
    
    Specified by:
    
    getUpperLeftCorner in interface IlvMapFeatureIterator
  - getLowerRightCorner
```
public IlvCoordinate getLowerRightCorner()
```
    Returns the lower-right corner of the bounding box that delimits the objects read from the file.
    
    Specified by:
    
    getLowerRightCorner in interface IlvMapFeatureIterator
  - getDefaultFeatureRenderer
```
public IlvFeatureRenderer getDefaultFeatureRenderer()
```
    Returns the default renderer used to display the map features returned by the reader.
    The default for this feature iterator is an IlvMIFFeatureRenderer
    
    Specified by:
    
    getDefaultFeatureRenderer in interface IlvMapFeatureIterator
    
    See Also:
    
    IlvMIFFeatureRenderer
  - 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.
  - isGeoreferenced
```
public boolean isGeoreferenced()
```
    Returns true if this feature iterator is georeferenced.
    
    Specified by:
    
    isGeoreferenced in interface IlvMapFeatureIterator
  - getFileVersion
```
public int getFileVersion()
```
    Returns the MID/MIF file version of this file.
    
    Returns:
    
    The file version.
  - getCharset
```
public String getCharset()
```
    Returns a string indicating the character set used to encode strings of this MIF/MID file.
    Possible values include :
    - "WindowsLatin1" : to indicate the file was created using the Windows US & Western Europe charset,
    - "MacRoman" : to indicate the file was created using the Macintosh US & Western Europe charset,
    - "Neutral" : to indicate no conversion is required.
    Returns:
    
    The charset of this file.
  - getJavaCharset
```
public String getJavaCharset()
```
    Returns a string indicating the charset used to encode strings of this MIF file.
    The value returned by this value can be used as parameter for java.lang.String. The possible values are:
    - "Cp1252": This value is returned when the charset of the MIF file is "WindowsLatin1".
    - "MacRoman": This value is returned when the charset of the MIF file is "MacRoman".
    - "ASCII": This value is returned when the charset of the MIF file is "Neutral".
    - "MS936": This value is returned when the charset of the MIF file is "WindowsSimpChinese".
    - "MS932": This value is returned when the charset of the MIF file is "WindowsJapanese".
    - null: This value is returned when the reader does not know how to convert the charset of the file to a Java encoding.
  - getDelimiter
```
public char getDelimiter()
```
    Returns the character used as separator in the MID file associated to this MIF file.
    Default separator is the TAB character.
  - getUniqueList
```
public int[] getUniqueList()
```
    Returns a array of integer indexes referring to the MID file columns associated to this MIF file. Each column which index is in this list is considered as a key for objects. That is, all map features that represent the same real life object have the same value in their key column.
    
    Returns:
    
    An integer array containing the unique list, or null if no unique list has been defined.
  - getUnit
```
public IlvUnit getUnit()
```
    Returns the IlvUnit describing the unit of the coordinates of the IlvMapFeature returned by this feature iterator.
    The unit converter is defined only when this feature iterator iterates on a MIF file which coordinate system is Earth, Nonearth or Layout Units.
    
    Returns:
    
    An IlvUnitConverter or null if none defined.
  - getAttributeInfo
```
public IlvAttributeInfoProperty getAttributeInfo()
```
    Returns information about the attribute values.
    
    Returns:
    
    Information about the attribute values.

Class IlvMIFReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PEN_STYLE_NAME

BRUSH_STYLE_NAME

TEXT_STYLE_NAME

SYMBOL_STYLE_NAME

Constructor Detail

IlvMIFReader

IlvMIFReader

IlvMIFReader

Method Detail

setTextCompatibility

getTextCompatibility

getPenFactory

setPenFactory

getCoordinateSystemFactory

setCoordinateSystemFactory

getNextFeature

dispose

getUpperLeftCorner

getLowerRightCorner

getDefaultFeatureRenderer

getCoordinateSystem

isGeoreferenced

getFileVersion

getCharset

getJavaCharset

getDelimiter

getUniqueList

getUnit

getAttributeInfo