com.dynalivery.saffron.client
Class RasterFormatOptions

java.lang.Object
  com.dynalivery.saffron.client.FormatOptions
      com.dynalivery.saffron.client.RasterFormatOptions

All Implemented Interfaces:

java.io.Serializable

public class RasterFormatOptions

extends FormatOptions

implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.dynalivery.saffron.client.FormatOptions

fileType

Constructor Summary

RasterFormatOptions()
Creates new RasterFormatOptions

RasterFormatOptions(int imageType, java.lang.String baseFileName)
Creates new RasterFormatOptions

Method Summary

java.lang.String	getBaseFileName() Returns the base filename String to be used when generating Rasters
int	getImageType() Returns the base filename String to be used when generating Raster
byte[]	getXML() Returns the XML String that represents these Raster formatting options
void	setBaseFileName(java.lang.String baseFileName) Sets the base filename String to be used when generating Rasters
void	setImageType(int imageType) Sets the base filename String to be used when generating Raster Images
java.lang.String	toString() Creates display string for format options.

Methods inherited from class com.dynalivery.saffron.client.FormatOptions

getFileType, setFileType

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterFormatOptions

public RasterFormatOptions()
                    throws InvalidParameterException

Creates new RasterFormatOptions

RasterFormatOptions

public RasterFormatOptions(int imageType,
                           java.lang.String baseFileName)
                    throws InvalidParameterException

Creates new RasterFormatOptions

Method Detail

setImageType

public void setImageType(int imageType)
                  throws InvalidParameterException

Sets the base filename String to be used when generating Raster Images

Parameters:

imageType - the integer image type (e.g. ImageType.JPG)

Throws:

InvalidParameterException

getImageType

public int getImageType()

Returns the base filename String to be used when generating Raster

Returns:

the integer image type (e.g. ImageType.JPG)

setBaseFileName

public void setBaseFileName(java.lang.String baseFileName)

Sets the base filename String to be used when generating Rasters

Parameters:

baseFileName - the base filename String to be used when generating Raster

getBaseFileName

public java.lang.String getBaseFileName()

Returns the base filename String to be used when generating Rasters

Returns:

the base filename String to be used when generating Rasters

getXML

public byte[] getXML()
              throws InvalidParameterException

Returns the XML String that represents these Raster formatting options

Specified by:

getXML in class FormatOptions

Returns:

the XML String that represents these Raster formatting options

Throws:

InvalidParameterException

toString

public java.lang.String toString()

Creates display string for format options.

Overrides:

toString in class FormatOptions

Returns:

display string for format options. Must be overridden in subclasses.