cz.cuni.jagrlib
Class DefaultRasterFileFormat

java.lang.Object
  cz.cuni.jagrlib.DefaultProperty
      cz.cuni.jagrlib.Piece
          cz.cuni.jagrlib.DefaultFileFormat
              cz.cuni.jagrlib.DefaultRasterFileFormat

All Implemented Interfaces:

Breakable, DataFileFormat, Property, Template

Direct Known Subclasses:

CompressedFormatBW, CompressedFormatGray, CompressedFormatOrder, CompressedFormatPal, CompressedFormatRGB, CompressedFormatTransform, FractalCompressionQtree, GIFFileFormat, HDRFileFormat, JFIFFileFormat, MeshCompressionRLE, PFMFileFormat, PNGFileFormat

public abstract class DefaultRasterFileFormat
extends DefaultFileFormat

File format default implementation for raster image data.

Since:

0.25

See Also:

DefaultRasterFileFormat.java

Field Summary

protected static java.lang.String	CATEGORY Object category.
protected static java.lang.String	TEMPLATE_NAME Object template identifier.

Fields inherited from class cz.cuni.jagrlib.Piece

channels, info, pl, plugs, reg, TEMPLATE_TYPE, userBreak

Fields inherited from interface cz.cuni.jagrlib.iface.DataFileFormat

DOUBLE_STREAM

Fields inherited from interface cz.cuni.jagrlib.iface.Property

LOGGING, STATISTICS, TEXT_DESCRIPTION

Fields inherited from interface cz.cuni.jagrlib.Template

ALL_PLUGS, C_1D, C_2D, C_3D, C_ALPHA, C_BINARY, C_BREP, C_CAMERA, C_CIRCLE, C_CLIP, C_COMPRESSION, C_CURVE, C_DATA, C_DRAW, C_EDITOR, C_ELLIPSE, C_FILL, C_FILTER, C_FLOAT, C_FUNCTION, C_IMAGE, C_INTEGER, C_IO, C_LIGHT, C_LINE, C_METRIC, C_POLYGON, C_PROJECTION, C_RADIOSITY, C_RASTER, C_RENDER, C_SAMPLE, C_SCENE, C_SET, C_SOLID, C_TEXT, C_TRANSFORM, C_VECTOR, C_VIEWER, C_WORKER, CAT_EMPTY, EMPTY, IFACE, JAGRLIB, JAGRLIB2, MANIPULATOR_COMBO, MANIPULATOR_CUSTOM, MANIPULATOR_DEFAULT, MANIPULATOR_MULTILINE, PL_ALPHAMASK, PL_BITMASK, PL_CAUSTIC, PL_CODEC, PL_COLORMAP, PL_COMPARE, PL_DATA, PL_DIRECT, PL_EDITOR, PL_FILTER, PL_FUNCTION, PL_IMAGE, PL_IMPORT, PL_INPUT, PL_INTERSECTION, PL_LIGHTSOURCE, PL_ORDER, PL_OUTPUT, PL_PALETTE, PL_PHOTON, PL_PROPERTY, PL_QUANTIZER, PL_RASTER, PL_RENDER, PL_SHADOW, PL_STREAM, PL_TRANSFORM, PL_TRIGGER, PL_VOLUME, PL_WINDOW, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INTEGER, TYPE_LONG, TYPE_OBJECT, TYPE_STRING

Constructor Summary

DefaultRasterFileFormat()

Method Summary

protected void	commonLoad(BitStream stream, RasterGraphics g) Common load code.
protected void	commonSave(BitStream stream, RasterGraphics g) Common save code.
boolean	loadFile(BitStream stream, java.lang.Object support) Retrieves data from the given BitStream.
boolean	loadFile(java.lang.String fileName, java.lang.String detail) Retrieves data from the given file (stream).
boolean	saveFile(BitStream stream, java.lang.Object support) Saves data to the given BitStream.
boolean	saveFile(java.lang.String fileName, java.lang.String detail) Saves data to the given file (stream).

Methods inherited from class cz.cuni.jagrlib.DefaultFileFormat

closeFile, fileNameMasks, headerLength, init, match, readFloat, readLine, readParameters, readToken, readUnsigned16, readUnsigned16, readUnsigned32, writeFloat, writeLine, writeParameters, writeUnsigned16, writeUnsigned16, writeUnsigned32

Methods inherited from class cz.cuni.jagrlib.Piece

className, connect, findPlug, findPlug, getInfo, getInterface, getInterface, getPlug, getReg, isCompatible, isCompatible, isConnected, logError, logWarning, myInterface, newInputPlug, newOptOutputPlug, newOutputPlug, newPlug, noTemplates, propBegin, propBounds, propDefault, propEnd, propEnum, propManipulator, propManipulator, setProgressListener, setRegStrings, setTemplate, setTemplateDynamic, stop

Methods inherited from class cz.cuni.jagrlib.DefaultProperty

booleanProperty, booleanProperty, colorDoubleProperty, colorProperty, commit, doubleProperty, doubleProperty, doubleProperty, enumProperty, floatProperty, floatProperty, floatProperty, get, intProperty, intProperty, intProperty, longProperty, longProperty, longProperty, set, set, stringProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.cuni.jagrlib.iface.Property

commit, get, set

Methods inherited from interface cz.cuni.jagrlib.Breakable

setProgressListener, stop

Field Detail

TEMPLATE_NAME

protected static final java.lang.String TEMPLATE_NAME

Object template identifier.

See Also:

Constant Field Values

CATEGORY

protected static final java.lang.String CATEGORY

Object category.

See Also:

Constant Field Values

Constructor Detail

DefaultRasterFileFormat

public DefaultRasterFileFormat()

Method Detail

commonLoad

protected void commonLoad(BitStream stream,
                          RasterGraphics g)
                   throws java.io.IOException

Common load code.

Parameters:

stream - Opened input bit-stream.

g - Checked raster-graphics object.

Throws:

java.io.IOException

commonSave

protected void commonSave(BitStream stream,
                          RasterGraphics g)
                   throws java.io.IOException

Common save code.

Parameters:

stream - Opened output bit-stream.

g - Checked raster-graphics object.

Throws:

java.io.IOException

loadFile

public boolean loadFile(java.lang.String fileName,
                        java.lang.String detail)
                 throws java.io.IOException

Retrieves data from the given file (stream). Can be used for "file opening" in virtual-mapped mode.

Specified by:

loadFile in interface DataFileFormat

Specified by:

loadFile in class DefaultFileFormat

Parameters:

fileName - File-name (stream-name) to read from (can be null).

detail - Further implementation-specific information ("r" or "rw" for mapped mode).

Returns:

true if the operation was successful.

Throws:

java.io.IOException

See Also:

loadFile(BitStream,Object), saveFile(String,String), DefaultFileFormat.closeFile()

loadFile

public boolean loadFile(BitStream stream,
                        java.lang.Object support)
                 throws java.io.IOException

Retrieves data from the given BitStream. This metod is optional.

The stream should be opened before - only the reOpen(false,null) call can be used.

Specified by:

loadFile in interface DataFileFormat

Specified by:

loadFile in class DefaultFileFormat

Parameters:

stream - Input bit-stream (opened - call reOpen(false,null) first).

support - Implementation-specific data (e.g. second BitStream for file-formats with DataFileFormat.DOUBLE_STREAM property).

Returns:

true if the operation was successful.

Throws:

java.io.IOException

See Also:

loadFile(String,String), DataFileFormat.DOUBLE_STREAM

saveFile

public boolean saveFile(java.lang.String fileName,
                        java.lang.String detail)
                 throws java.io.IOException

Saves data to the given file (stream).

Specified by:

saveFile in interface DataFileFormat

Specified by:

saveFile in class DefaultFileFormat

Parameters:

fileName - File-name (stream-name) to write to (can be null).

detail - Further implementation-specific information.

Returns:

true if the operation was successful.

Throws:

java.io.IOException

See Also:

saveFile(BitStream,Object), loadFile(String,String)

saveFile

public boolean saveFile(BitStream stream,
                        java.lang.Object support)
                 throws java.io.IOException

Saves data to the given BitStream. This metod is optional.

The stream should be opened and empty - the reOpen(true,null) call is not required.

Specified by:

saveFile in interface DataFileFormat

Specified by:

saveFile in class DefaultFileFormat

Parameters:

stream - Output bit-stream (opened and empty).

support - Implementation-specific data (e.g. second BitStream for file-formats with DataFileFormat.DOUBLE_STREAM property).

Returns:

true if the operation was successful.

Throws:

java.io.IOException

See Also:

saveFile(String,String), DataFileFormat.DOUBLE_STREAM