ilog.views.maps.defense.terrain

Class IlvComputedRasterReader

java.lang.Object

ilog.views.maps.raster.IlvRasterAbstractReader

ilog.views.maps.defense.terrain.IlvComputedRasterReader

All Implemented Interfaces:

IlvPersistentObject, IlvMapFeatureIterator, IlvMapReusableFeatureIterator, Serializable

public class IlvComputedRasterReader
extends IlvRasterAbstractReader

This fake reader always creates a single image using an IlvImageComputation set.
The following code example shows how to use this class:

 // Create the reader
 IlvComputedRasterReader reader = new IlvComputedRasterReader(manager);
 // set the image computation object
 reader.setImageComputation(imageComputation);
 // use the reader in a tiled data source
 IlvTiledRasterDataSource ds = IlvRasterDataSourceFactory.buildTiledImageDataSource(manager, reader, true, true, null);
 

Since:

JViews 7.0

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.maps.raster.IlvRasterAbstractReader

needReload

Constructor Summary

Constructors

Constructor and Description
IlvComputedRasterReader(IlvInputStream stream) The stream constructor.
IlvComputedRasterReader(IlvManager manager) The default constructor.

Method Summary

Modifier and Type	Method and Description
IlvCoordinateSystem	getCoordinateSystem() Returns a WGS84 coordinate system.
IlvImageComputation	getImageComputation() Returns the instance of the image builder used to make, or recreate, the computed image.
IlvMathTransform	getInternalTransformation(int imageIndex) Returns null.
static int	getMaxImageSize() Returns the maximum image area, that is the width x height.
IlvFeatureAttributeProperty	getProperties(int imageIndex) Returns null.
static int	getWarningImageHeight() Returns the maximum height acceptable for a computed image before a warning message is displayed.
static int	getWarningImageWidth() Returns the maximum width acceptable for a computed image before a warning message is displayed.
static void	getWarningImageWidth(int warningImageWidth) Indicates that trying to create images with a width greater than the parameter passed will lead to a warning message being displayed.
static boolean	isAllowMessages() Returns true if messages should be displayed.
void	reload(IlvThreadMonitoringData monitorInfo) Removes all images, then recreates a new one using style information and image computation.
void	restart() Rewinds the iterator for a new use.
static void	setAllowMessages(boolean allowMessages) Indicates whether messages should be displayed.
void	setImageComputation(IlvImageComputation imageBuilder) Sets the image builder instance that will be used to make, or recreate, the computed image.
static void	setMaxImageSize(int max_image_size) Indicates that images with an area greater than the parameter passed will not be created.
void	setStyle(IlvGradientRasterStyle style) Sets the style used for retrieving the image bounds and calling IlvImageComputation.buildImage(IlvRasterProperties, IlvThreadMonitoringData, IlvManager, IlvGradientRasterStyle).
static void	setWarningImageHeight(int warningImageHeight) Indicates that trying to create images with a height greater than the parameter passed will lead to a warning message being displayed.
void	write(IlvOutputStream stream) Writes the attributes of a persistent object to an output stream.

Methods inherited from class ilog.views.maps.raster.IlvRasterAbstractReader

addRaster, computeGisImageBounds, computeLimits, createRasterTileLoader, dispose, getDefaultFeatureRenderer, getDefaultMaximumIntervalsForDeterminingImageLocation, getImageBounds, getImageCount, getInverseTransformation, getLowerRightCorner, getLowerRightCorner, getMaximumIntervalsForDeterminingImageLocation, getNextFeature, getRasterMappedBuffer, getRasterProperties, getTileLoader, getTileLoader, getTileLoaders, getTransformation, getUpperLeftCorner, getUpperLeftCorner, isForceImageLoadingWhenSaving, isGeoreferenced, isHighQualityRendering, isNeedReload, removeRaster, setDefaultMaximumIntervalsForDeterminingImageLocation, setForceImageLoadingWhenSaving, setHighQualityRendering, setMaximumIntervalsForDeterminingImageLocation, setTransformation

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvComputedRasterReader

public IlvComputedRasterReader(IlvManager manager)

The default constructor.

Parameters:

manager - The manager used for calls to IlvImageComputation.buildImage(IlvRasterProperties, IlvThreadMonitoringData, IlvManager, IlvGradientRasterStyle).

IlvComputedRasterReader

public IlvComputedRasterReader(IlvInputStream stream)
                        throws IlvReadFileException

The stream constructor.

Parameters:

stream - The stream to read from.

Throws:

IlvReadFileException - if there is a problem reading from stream.

Method Detail

setImageComputation

public void setImageComputation(IlvImageComputation imageBuilder)

Sets the image builder instance that will be used to make, or recreate, the computed image. Calling this method indicates to the reader that it needs a reload.

Parameters:

imageBuilder - The image computing object.

getImageComputation

public IlvImageComputation getImageComputation()

Returns the instance of the image builder used to make, or recreate, the computed image.

Returns:

The instance of the image builder used to make, or recreate, the computed image.

setStyle

public void setStyle(IlvGradientRasterStyle style)

Sets the style used for retrieving the image bounds and calling IlvImageComputation.buildImage(IlvRasterProperties, IlvThreadMonitoringData, IlvManager, IlvGradientRasterStyle). Calling this method indicates to the reader that it needs a reload.

Parameters:

style - The style to set.

getInternalTransformation

public IlvMathTransform getInternalTransformation(int imageIndex)

Returns null.

Specified by:

getInternalTransformation in class IlvRasterAbstractReader

Parameters:

imageIndex - The index of the raster.

Returns:

This method always returns null.

See Also:

IlvRasterAbstractReader.getInternalTransformation(int)

getCoordinateSystem

public IlvCoordinateSystem getCoordinateSystem()

Returns a WGS84 coordinate system.

Returns:

A WGS84 coordinate system.

See Also:

IlvMapFeatureIterator.getCoordinateSystem()

getProperties

public IlvFeatureAttributeProperty getProperties(int imageIndex)

Returns null.

Specified by:

getProperties in class IlvRasterAbstractReader

Parameters:

imageIndex - The index of the image.

Returns:

This method always returns null.

See Also:

IlvRasterAbstractReader.getProperties(int)

reload

public void reload(IlvThreadMonitoringData monitorInfo)

Removes all images, then recreates a new one using style information and image computation.

Overrides:

reload in class IlvRasterAbstractReader

Parameters:

monitorInfo - Thread monitoring data.

See Also:

IlvRasterAbstractReader.reload(ilog.views.maps.raster.datasource.IlvThreadMonitoringData)

isAllowMessages

public static boolean isAllowMessages()

Returns true if messages should be displayed.

Returns:

If messages should be displayed, true is returned.

Since:

JViews 8.1

setAllowMessages

public static void setAllowMessages(boolean allowMessages)

Indicates whether messages should be displayed.

Parameters:

allowMessages - Set to true to indicate that messages should be displayed.

Since:

JViews 8.1

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of a persistent object to an output stream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvRasterAbstractReader

Parameters:

stream - The output stream.

Throws:

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

getMaxImageSize

public static int getMaxImageSize()

Returns the maximum image area, that is the width x height.

Returns:

The maximum image area.

Since:

JViews 7.5

setMaxImageSize

public static void setMaxImageSize(int max_image_size)

Indicates that images with an area greater than the parameter passed will not be created. The width x height of the image must be less than max_image_size.

Using this method prevents too much memory being allocating if the computed image is too large. When the image area is bigger than max_image_size, a smaller image is created. This is done by changing the style precision based on the values returned by getWarningImageHeight() and getWarningImageWidth(). A message may be displayed to the user to indicate the change.

Note: the default value is 10,000,000 pixels.

Parameters:

max_image_size - The maximum image area.

Since:

JViews 7.5

See Also:

setAllowMessages(boolean)

getWarningImageHeight

public static int getWarningImageHeight()

Returns the maximum height acceptable for a computed image before a warning message is displayed.

Returns:

Returns the maximum height acceptable.

Since:

JViews 8.1

setWarningImageHeight

public static void setWarningImageHeight(int warningImageHeight)

Indicates that trying to create images with a height greater than the parameter passed will lead to a warning message being displayed. When the image height in pixels is greater than warningImageHeight, a warning message may be displayed to the user. If he or she accepts to reduce the image precision, or if no message is allowed, a smaller image is created. This is done by changing the style precision until the resulting number of pixels is less than warningImageHeight.

Note: the default value is 1000.

Parameters:

warningImageHeight - The maximum image height.

Since:

JViews 8.1

See Also:

setAllowMessages(boolean)

getWarningImageWidth

public static int getWarningImageWidth()

Returns the maximum width acceptable for a computed image before a warning message is displayed.

Returns:

Returns The maximum width acceptable.

Since:

JViews 8.1

getWarningImageWidth

public static void getWarningImageWidth(int warningImageWidth)

Indicates that trying to create images with a width greater than the parameter passed will lead to a warning message being displayed. When the image width in pixels is greater than warningImageWidth, a warning message is displayed to the user. If he or she aggrees to reduce the image precision, or if no message is allowed, a smaller image will be created. This is done by changing the style precision until the resulting width is less than warningImageWidth.

Note: the default value is 1000.

Parameters:

warningImageWidth - The maximum image width.

Since:

JViews 8.1

See Also:

setAllowMessages(boolean)

restart

public void restart()

Rewinds the iterator for a new use.

Specified by:

restart in interface IlvMapReusableFeatureIterator

Overrides:

restart in class IlvRasterAbstractReader

See Also:

IlvMapReusableFeatureIterator.restart()