ilog.views.maps

Class IlvMapOutputStream

java.lang.Object

ilog.views.io.IlvOutputStream

ilog.views.maps.IlvMapOutputStream

public class IlvMapOutputStream
extends IlvOutputStream

IlvMapOutputStream is a specialized IlvOutputStream that is used to save only the named properties attached to a manager. This output stream does not save the layers of the manager.

Since:

JViews 7.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENTS_NOT_SAVED_PROPERTY_NAME The name of the IlvNamedProperty that indicates, when present in the manager, that map contents were saved.
static String	SKIP_MAPLAYER_CREATION_PROPERTY_NAME The name of the IlvNamedProperty that indicates, when present in the manager layer, that a layer should not be wrapped in an IlvMapLayer, as is the default behavior.
static String	VERSION_PROPERTY_NAME The name of the IlvNamedProperty that holds the version of the .ivl file written by this IlvMapOutputStream instance.

Constructor Summary

Constructors

Constructor and Description
IlvMapOutputStream(OutputStream stream, String imageFilename, boolean binary) Creates an IlvMapOutputStream that will write to an OutputStream in ASCII mode.
IlvMapOutputStream(String mapFilename, boolean binary) Creates an IlvMapOutputStream from a file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes any underlying OutputStream objects used by this IlvMapOutputStream instance.
void	closeImageStream() Closes the underlying image stream and cleans up temporary files used during the save process.
static String	getFileSuffix() Returns the file extension used for serialized JViews Map files.
static String	getImageFileSuffix() Returns the file extension used for serialized raster data used by images objects within an JViews Maps file.
FileOutputStream	getImageStream() Returns the stream opened to the file where the data for raster objects in a map is saved.
boolean	isWritingObjects() Tests if the output stream writes layers or not.
void	registerMappedBufferPosition(IlvRasterMappedBuffer buffer, long position) Registers the start position of the specified IlvRasterMappedBuffer in the serialized raster data file being written by this IlvMapOutputStream instance.
static void	setFileSuffix(String suffix) Sets the file extension used for serialized JViews Map files.
static void	setImageFileSuffix(String suffix) Sets the file extension for serialized raster data used by image objects within an JViews Maps file.
void	setWritingObjects(boolean writeLayers) Sets whether this IlvMapOutputStream will write manager layers.
void	write(IlvManager manager, boolean writeSelection) Writes a manager to this object's IlvOutputStream after thread monitoring is started.
void	write(IlvManagerLayer[] layers, boolean useCopyPaste) This method does NOT write the layers of a manager to an output stream.

Methods inherited from class ilog.views.io.IlvOutputStream

filterObjects, flush, getBinary, getManager, setBinary, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, write, writeExtensions, writeGradient, writePattern, writeStroke, writeTexture

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_PROPERTY_NAME

public static final String VERSION_PROPERTY_NAME

The name of the IlvNamedProperty that holds the version of the .ivl file written by this IlvMapOutputStream instance.

See Also:

Constant Field Values

CONTENTS_NOT_SAVED_PROPERTY_NAME

public static final String CONTENTS_NOT_SAVED_PROPERTY_NAME

The name of the IlvNamedProperty that indicates, when present in the manager, that map contents were saved.

Since:

JViews 7.5

See Also:

Constant Field Values

SKIP_MAPLAYER_CREATION_PROPERTY_NAME

public static final String SKIP_MAPLAYER_CREATION_PROPERTY_NAME

The name of the IlvNamedProperty that indicates, when present in the manager layer, that a layer should not be wrapped in an IlvMapLayer, as is the default behavior.

Since:

JViews 7.5

See Also:

Constant Field Values

Constructor Detail

IlvMapOutputStream

public IlvMapOutputStream(OutputStream stream,
                          String imageFilename,
                          boolean binary)

Creates an IlvMapOutputStream that will write to an OutputStream in ASCII mode.

Parameters:

stream - The output stream.

imageFilename - The name of the file to write map raster data to.

binary - Set to true for the stream to write binary data.

IlvMapOutputStream

public IlvMapOutputStream(String mapFilename,
                          boolean binary)
                   throws FileNotFoundException

Creates an IlvMapOutputStream from a file.

The filename passed in the mapFilename parameter is suffixed by the file extension returned by calling getFileSuffix() to create the map filename, if this has not been done already.

The name of the file used to store images used in the map is derived from mapFilename, with the extension returned by calling getImageFileSuffix().

Parameters:

mapFilename - The filename for the map.

binary - Set to true for the stream to write binary data.

Throws:

FileNotFoundException - if the map file can not be created.

Since:

JViews 7.5

Method Detail

write

public void write(IlvManagerLayer[] layers,
                  boolean useCopyPaste)
           throws IOException

This method does NOT write the layers of a manager to an output stream.

Overrides:

write in class IlvOutputStream

Parameters:

layers - The layers NOT to be saved

useCopyPaste - Set to true to use copy and paste.

Throws:

IOException - if an I/O error occurs.

close

public void close()
           throws IOException

Closes any underlying OutputStream objects used by this IlvMapOutputStream instance.

Throws:

IOException - if an I/O error occurs.

Since:

JViews 7.5

write

public void write(IlvManager manager,
                  boolean writeSelection)
           throws IOException

Writes a manager to this object's IlvOutputStream after thread monitoring is started.

Overrides:

write in class IlvOutputStream

Parameters:

manager - The manager that contains the map.

writeSelection - Set to true to save only the objects selected by the user but not layer information.

Throws:

IOException - usual IO errors.

See Also:

IlvOutputStream.write(ilog.views.IlvManager, boolean)

closeImageStream

public void closeImageStream()
                      throws IOException

Closes the underlying image stream and cleans up temporary files used during the save process.

Throws:

IOException - if there is a problem closing the image stream.

FileNotFoundException - if the file defined in IlvMapOutputStream(OutputStream , String , boolean ) cannot be found.

setWritingObjects

public void setWritingObjects(boolean writeLayers)

Sets whether this IlvMapOutputStream will write manager layers.

Parameters:

writeLayers - Set to true so manager layers are saved.

isWritingObjects

public boolean isWritingObjects()

Tests if the output stream writes layers or not.

Returns:

true if the output stream writes the layers.

getImageStream

public FileOutputStream getImageStream()
                                throws FileNotFoundException

Returns the stream opened to the file where the data for raster objects in a map is saved.

Returns:

Returns The image stream.

Throws:

FileNotFoundException - if the image file defined in IlvMapOutputStream(OutputStream , String , boolean ) cannot be found.

registerMappedBufferPosition

public void registerMappedBufferPosition(IlvRasterMappedBuffer buffer,
                                         long position)

Registers the start position of the specified IlvRasterMappedBuffer in the serialized raster data file being written by this IlvMapOutputStream instance.

Note: this method is for internal purpose only. It ensures that saved objects containing raster data are properly re-mapped on the serialized raster data file written by this IlvMapOutputStream.

Parameters:

buffer - The IlvRasterMappedBuffer whose start position is to be registered.

position - A Long instance defining the position in the serialized raster data file where the mapping starts.

setFileSuffix

public static void setFileSuffix(String suffix)

Sets the file extension used for serialized JViews Map files.

Parameters:

suffix - The new map file extension.

See Also:

getFileSuffix()

getFileSuffix

public static String getFileSuffix()

Returns the file extension used for serialized JViews Map files. If a custom file extension has not been set, the default value, ".ivl", is returned.

Returns:

The file suffix used for serialized JViews Maps files.

See Also:

setFileSuffix(String)

setImageFileSuffix

public static void setImageFileSuffix(String suffix)

Sets the file extension for serialized raster data used by image objects within an JViews Maps file.

Parameters:

suffix - The new image file extension.

See Also:

getImageFileSuffix()

getImageFileSuffix

public static String getImageFileSuffix()

Returns the file extension used for serialized raster data used by images objects within an JViews Maps file.

Returns:

The file suffix used for serialized JViews Map image files. If no custom file extension has been set, ".img" is returned.

See Also:

setImageFileSuffix(String)