com.esri.sde.sdk.client
Interface SeRasterConsumer

All Known Implementing Classes:

SeRasterRenderedImage, SeRasterRenderedTile

public interface SeRasterConsumer

The interface for objects expressing interest in raster data through the SeRasterProducer interfaces. When a consumer is added to an raster producer class, the producer delivers all of the data about the raster using the method calls defined in this interface.

Example of objects that implements SeRasterConsumer:

• SeRasterRenderedImage class for ScanLine mode loading.
• SeRasterRenderedTile class for Import mode loading.

Since:

ArcSDE 9.0

See Also:

SeRasterProducer, SeRasterRenderedImage, SeRasterRenderedTile

Field Summary

static int	COMPLETESCANLINES The pixels will be delivered in (multiples of) complete scanlines at a time.
static int	COMPLETETILES The image will be delivered in (multiples of) complete SeRasterTile at a time.
static int	IMAGEABORTED The image creation process was deliberately aborted.
static int	IMAGEERROR An error was encountered while producing the image.
static int	SINGLEFRAMEDONE One frame (SeRasterBand) of the image is complete but there are more frames to be delivered.
static int	STATICIMAGEDONE The image is complete and there are no more ScanLines or SeRasterTiles to be delivered.
static int	TOPDOWNLEFTRIGHT The pixels or tiles will be delivered in top-down, left-to-right order.

Method Summary

void	rasterComplete(int status) The rasterComplete method is called when the SeRasterProducer is finished delivering all of the data that the source image contains, or when a single band of a multi-band raster has been completed, or when an error in loading or producing the image has occurred.
void	setHints(int hintFlags) The SeRasterProducer can deliver data in many different ways, so that may be the SeRasterConsumer can handle the data more efficiently or with higher quality if it knows some information about how the data will be delivered up front.
void	setProperties(java.util.Hashtable props) Sets the extensible list of properties associated with this image.
void	setRasterTiles(SeRasterTile[] rasTiles) Sets raster image in SeRasterTile form, for support of Import_Mode loading.
void	setScanLines(int numLines, byte[] scanLines, byte[] bitMask) Sets raster image in scan lines form (optionally bit_mask) for support of ScanLine_Mode loading which is the default.

Field Detail

TOPDOWNLEFTRIGHT

static final int TOPDOWNLEFTRIGHT

The pixels or tiles will be delivered in top-down, left-to-right order.

See Also:

setHints(int), Constant Field Values

COMPLETESCANLINES

static final int COMPLETESCANLINES

The pixels will be delivered in (multiples of) complete scanlines at a time.

Optionally, can include bit_mask data which trigger but SeRasterAttr.setMaskMode (true);

The data will be delivered (default)

• In top-down, left-to-right order
• In a single pass.

See Also:

setHints(int), Constant Field Values

COMPLETETILES

static final int COMPLETETILES

The image will be delivered in (multiples of) complete SeRasterTile at a time.

The image will be delivered in ArcSDE native raster tile fromat and always in top-down, left-to-right order. This is activated by the SeRasterAttr.setImportMode (true) method.

See Also:

setHints(int), Constant Field Values

IMAGEERROR

static final int IMAGEERROR

An error was encountered while producing the image.

See Also:

rasterComplete(int), Constant Field Values

SINGLEFRAMEDONE

static final int SINGLEFRAMEDONE

One frame (SeRasterBand) of the image is complete but there are more frames to be delivered.

See Also:

rasterComplete(int), Constant Field Values

STATICIMAGEDONE

static final int STATICIMAGEDONE

The image is complete and there are no more ScanLines or SeRasterTiles to be delivered.

See Also:

rasterComplete(int), Constant Field Values

IMAGEABORTED

static final int IMAGEABORTED

The image creation process was deliberately aborted.

See Also:

rasterComplete(int), Constant Field Values

Method Detail

setProperties

void setProperties(java.util.Hashtable props)

Sets the extensible list of properties associated with this image.

setHints

void setHints(int hintFlags)

The SeRasterProducer can deliver data in many different ways, so that may be the SeRasterConsumer can handle the data more efficiently or with higher quality if it knows some information about how the data will be delivered up front. If the SeRasterProducer does not follow the guidelines for the indicated hint, the results are undefined.

setScanLines

void setScanLines(int numLines,
                  byte[] scanLines,
                  byte[] bitMask)

Sets raster image in scan lines form (optionally bit_mask) for support of ScanLine_Mode loading which is the default.

Parameters:

numLines - an int value.

scanLines - a byte[] value.

bitMask - a byte[] value.

See Also:

SeRasterRenderedImage.setScanLines(int, byte[], byte[])

setRasterTiles

void setRasterTiles(SeRasterTile[] rasTiles)

Sets raster image in SeRasterTile form, for support of Import_Mode loading. For example, SeRasterAttr.setImportMode (true); on SeInsert or SeUpdate operation.

Parameters:

rasTiles - a SeRasterTile[] value.

See Also:

SeRasterAttr.setImportMode(boolean), SeRasterRenderedTile.setRasterTiles(com.esri.sde.sdk.client.SeRasterTile[])

rasterComplete

void rasterComplete(int status)

The rasterComplete method is called when the SeRasterProducer is finished delivering all of the data that the source image contains, or when a single band of a multi-band raster has been completed, or when an error in loading or producing the image has occurred. The SeRasterConsumer should remove itself from the list of consumers registered with the SeRasterProducer at this time.

See Also:

SeRasterProducer.removeConsumer(com.esri.sde.sdk.client.SeRasterConsumer)