com.esri.sde.sdk.client
Class SeRasterScanLineGenerator

java.lang.Object
  extended by com.esri.sde.sdk.client.SeRasterScanLineGenerator

public class SeRasterScanLineGenerator
extends java.lang.Object

SeRasterScanLineGenerator.java: Image scan line generator from java.awt.Image object. Given SDE raster attribute info, Java AWT Image and other parameters. This class will automatically generate image scan_line with or without bit_mask that is ready to be use on SeInsert or SeUpdate operation via scan_line_mode.

Since:
ArcSDE 9.0
See Also:
SeRasterAttr

Field Summary
static int MASK_ALL_OFF
          Tag for setting all bitmask bits OFF
static int MASK_ALL_ON
          Tag for setting all bitmask bits ON (Default)
static int MASK_TILE_BOUNDARY
          Tag for setting bitmask bits OFF along the SeRasterTile boundary
 
Constructor Summary
SeRasterScanLineGenerator(SeRasterAttr rasAttr, java.awt.Image awtImage, int numScanLinesPerCall)
          Constructs SeRasterScanLineGenerator object.
 
Method Summary
 byte[] getBitMaskData()
          Gets scan line's bit mask data, if exist.
 int getNumLines()
          Gets number of scan lines.
 byte[] getScanLineData()
          Gets scan lines pixel data.
 boolean hasBitMask()
          Return true if bit mask exist.
 void setBitMaskType(int method)
          Sets bitmask type or automatic bitmask generating method.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MASK_ALL_ON

public static final int MASK_ALL_ON
Tag for setting all bitmask bits ON (Default)

See Also:
Constant Field Values

MASK_ALL_OFF

public static final int MASK_ALL_OFF
Tag for setting all bitmask bits OFF

See Also:
Constant Field Values

MASK_TILE_BOUNDARY

public static final int MASK_TILE_BOUNDARY
Tag for setting bitmask bits OFF along the SeRasterTile boundary

See Also:
Constant Field Values
Constructor Detail

SeRasterScanLineGenerator

public SeRasterScanLineGenerator(SeRasterAttr rasAttr,
                                 java.awt.Image awtImage,
                                 int numScanLinesPerCall)
Constructs SeRasterScanLineGenerator object.

Top of SeRasterScanLineGenerator class.

Parameters:
rasAttr - a SeRasterAttr value
numScanLinesPerCall - an int value
Method Detail

hasBitMask

public boolean hasBitMask()
Return true if bit mask exist.

Returns:
a boolean value

getBitMaskData

public byte[] getBitMaskData()
Gets scan line's bit mask data, if exist. Else return null

Returns:
an byte[] value

getScanLineData

public byte[] getScanLineData()
Gets scan lines pixel data.

Returns:
an byte[] value

getNumLines

public int getNumLines()
                throws java.lang.Exception
Gets number of scan lines. Return the next set of ScanLines from AWT Image and return mNumLines. Return 0 if all done.

Returns:
an int value of number of scan lines.
Throws:
java.lang.Exception

setBitMaskType

public void setBitMaskType(int method)
Sets bitmask type or automatic bitmask generating method. if the mask_mode in SeRasterAttr object is NOT set to true (ie, by calling SeRasterAttr.setMaskMode(true)), then any bitmask type setting is ignore, because no bitmask data will be generated.

Support the following bitmask_type: