ilog.views.maps

Class IlvMapInputStream

java.lang.Object

ilog.views.io.IlvInputStream

ilog.views.maps.IlvMapInputStream

public class IlvMapInputStream
extends IlvInputStream

IlvMapInputStream is an extension of IlvInputStream that reconnects IlvMapLayer objects to IlvManagerLayer objects when they are read from an IVL file. This class also handles the associated files containing raster data.

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
IlvMapInputStream(InputStream stream, RandomAccessFile imageRandomAccess) Deprecated. use IlvMapInputStream(InputStream stream, String filename) instead.
IlvMapInputStream(InputStream stream, String imageFilename) Creates an IlvMapInputStream from an InputStream instance.
IlvMapInputStream(String mapFilename) Creates an IlvMapInputStream from a file.
IlvMapInputStream(URL ilvFile) Creates an IlvMapInputStream from a URL.

Method Summary

Modifier and Type	Method and Description
String	getImageFilename() Returns the name of the .img file containing raster data.
RandomAccessFile	getImageRandomAccessFile() Deprecated. Use getImageFilename() instead.
boolean	isAutoRearrange() Tests if the auto rearrange is allowed to change the manager's layer order after the IlvMapDataSourceModel has been read.
Boolean	isGeneratingImage() Tests if this stream is configured to generate images.
static boolean	isIVL(String path) Test if a file has a valid IVL structure.
static boolean	isIVL(URL url) Test if a file has a valid IVL structure.
void	notifyMissingRasterData() Notifies this input stream that .img file containing raster data related to the map being read is likely to be missing.
void	read(IlvGraphicBag bag) Reads an IlvInputStream.
void	setAutoRearrange(boolean autoRearrange) Sets whether the rearrange layers is allowed to change manager layers order after reading a IlvMapDataSourceModel.
void	setGeneratingImage(Boolean t) Set to true so objects read with this stream configure themselves to synchronously respond to a paint request.

Methods inherited from class ilog.views.io.IlvInputStream

getDocumentBase, getGraphicBag, getObjects, getVersion, invokeConstructor, isASCIIMode, isDoubleVersion, readBoolean, readBooleanArray, readColor, readColorArray, readComponentOrientation, readDouble, readDoubleArray, readDoubleOrFloat, readDoubleOrFloatArray, readExtensions, readFloat, readFloatArray, readFont, readFontArray, readGradient, readInt, readIntArray, readLocale, readLong, readLongArray, readObject, readObject, readObjectArray, readObjects, readPaint, readPattern, readPersistentObject, readPersistentObjects, readPoint, readPointArray, readRect, readRectArray, readShape, readShort, readShortArray, readString, readStringArray, readStroke, readTexture, readTransformer, readTransformerArray, readULocale, registerGraphic, setCopyPasteMode, setDocumentBase, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvMapInputStream

@Deprecated
public IlvMapInputStream(InputStream stream,
                                     RandomAccessFile imageRandomAccess)

Deprecated. use IlvMapInputStream(InputStream stream, String filename) instead.

Creates an IlvMapInputStream from an InputStream instance.

Parameters:

stream - The stream to read the map from.

imageRandomAccess - A RandomAccessFile on the file containing raster data for objects in the serialized map.

IlvMapInputStream

public IlvMapInputStream(InputStream stream,
                         String imageFilename)

Creates an IlvMapInputStream from an InputStream instance.

Parameters:

stream - The stream to read the map from.

imageFilename - The name of the file containing raster data for objects in the serialized map.

Since:

JViews 7.5

IlvMapInputStream

public IlvMapInputStream(URL ilvFile)
                  throws IOException

Creates an IlvMapInputStream from a URL. This constructor seeks a corresponding URL (see IlvMapOutputStream.getImageFileSuffix()) for the image data. If possible, it initializes the corresponding direct access stream. If it cannot initialize the distant stream, it copies the image data to the local temporary file system and opens a stream to that copy.

Parameters:

ilvFile - The URL for the the map data.

Throws:

IOException - if the IVL URL cannot be opened.

Since:

JViews 8.7

IlvMapInputStream

public IlvMapInputStream(String mapFilename)
                  throws IOException

Creates an IlvMapInputStream from a file.

Parameters:

mapFilename - The map file to open.

Throws:

IOException - if the file mapFilename was not found.

Since:

JViews 7.5

Method Detail

isAutoRearrange

public boolean isAutoRearrange()

Tests if the auto rearrange is allowed to change the manager's layer order after the IlvMapDataSourceModel has been read. The default value is true.

Note: this property is not persistent.

Returns:

true if the rearrange layers is allowed to change the layer order in the manager.

Since:

JViews 7.5

setAutoRearrange

public void setAutoRearrange(boolean autoRearrange)

Sets whether the rearrange layers is allowed to change manager layers order after reading a IlvMapDataSourceModel. The default value is true.

Note: this property is not persistent.

Parameters:

autoRearrange - Set to false to prevent the manager's layer order from being rearranged.

Since:

JViews 7.5

read

public void read(IlvGraphicBag bag)
          throws IOException,
                 IlvReadFileException

Reads an IlvInputStream.

Overrides:

read in class IlvInputStream

Parameters:

bag - The graphic bag in which objects will be added.

Throws:

IOException - if there are any I/O errors.

IlvReadFileException - if the format is not correct or if some classes cannot be loaded.

See Also:

IlvInputStream.read(ilog.views.IlvGraphicBag)

getImageRandomAccessFile

@Deprecated
public RandomAccessFile getImageRandomAccessFile()

Deprecated. Use getImageFilename() instead.

Returns the RandomAccessFile used on the file containing raster data.

Returns:

The RandomAccessFile used on the file containing raster data.

getImageFilename

public String getImageFilename()

Returns the name of the .img file containing raster data.

Returns:

The .img file name.

Since:

JViews 7.5

notifyMissingRasterData

public void notifyMissingRasterData()

Notifies this input stream that .img file containing raster data related to the map being read is likely to be missing.

Internal: do not use!

setGeneratingImage

public void setGeneratingImage(Boolean t)

Set to true so objects read with this stream configure themselves to synchronously respond to a paint request.

Parameters:

t - Set to true so object read using this stream synchronously respond to a paint request.

Since:

JViews 8.0

isGeneratingImage

public Boolean isGeneratingImage()

Tests if this stream is configured to generate images.

Returns:

true if this stream is configured to generate images.

Since:

JViews 8.0

isIVL

public static boolean isIVL(String path)

Test if a file has a valid IVL structure.

Parameters:

path - The path to the file to be tested.

Returns:

true if the file is a valid IVL file.

Since:

JViews 8.1

isIVL

public static boolean isIVL(URL url)

Test if a file has a valid IVL structure.

Parameters:

url - The URL to the file to validate.

Returns:

true if the file is a valid IVL file.

Since:

JViews 8.1