com.esri.sde.sdk.client
Class SeRaster

java.lang.Object
  com.esri.sde.sdk.client.SeRaster

All Implemented Interfaces:

java.lang.Cloneable

public class SeRaster
extends java.lang.Object
implements java.lang.Cloneable

A SeRaster object provide client side methods for ArcSDE raster Input/Output operation.

Since:

ArcSDE 9.0

See Also:

SeRasterColumn, SeRasterBand

Field Summary

static int	SE_BIN_FUNCTION_AUTO Tag for BIN function type auto
static int	SE_BIN_FUNCTION_DIRECT Tag for BIN function type direct
static int	SE_BIN_FUNCTION_EXPLICIT Tag for BIN function type explicit
static int	SE_BIN_FUNCTION_LINEAR Tag for BIN function type linear
static int	SE_BIN_FUNCTION_LOGARITHM Tag for BIN function type logarithm
static int	SE_BIN_FUNCTION_NONE Tag for BIN function type NONE
static int	SE_COLORMAP_DATA_BYTE Tag for colormap data type byte
static int	SE_COLORMAP_DATA_SHORT Tag for colormap data type short
static int	SE_COLORMAP_NONE Tag for colormap type NONE
static int	SE_COLORMAP_RGB Tag for colormap type RGB
static int	SE_COLORMAP_RGBA Tag for colormap type RGBA
static int	SE_COMPRESSION_JP2 Tag for raster band compression type JP2
static int	SE_COMPRESSION_JPEG Tag for raster band compression type JPEG
static int	SE_COMPRESSION_LZ77 Tag for raster band compression type LZ77
static int	SE_COMPRESSION_NONE Tag for raster band compression type NONE
static int	SE_INTERPOLATION_BICUBIC Tag for interpolation type BICUBIC
static int	SE_INTERPOLATION_BILINEAR Tag for interpolation type BILINEAR
static int	SE_INTERPOLATION_NEAREST Tag for interpolation type nearest
static int	SE_INTERPOLATION_NONE Tag for interpolation type NONE
static int	SE_MOSAIC_MODE_DELETE Tag for raster mosaic mode delete
static int	SE_MOSAIC_MODE_MERGE Tag for raster mosaic mode merge
static int	SE_MOSAIC_MODE_NONE Tag for raster mosaic mode NONE
static int	SE_PIXEL_TYPE_16BIT_S Tag for raster pixel type 16 bit signed.
static int	SE_PIXEL_TYPE_16BIT_U Tag for raster pixel type 16 bit unsigned.
static int	SE_PIXEL_TYPE_1BIT Tag for raster pixel type 1 bit.
static int	SE_PIXEL_TYPE_32BIT_REAL Tag for raster pixel type 32 bit real.
static int	SE_PIXEL_TYPE_32BIT_S Tag for raster pixel type 32 bit signed.
static int	SE_PIXEL_TYPE_32BIT_U Tag for raster pixel type 32 bit unsigned.
static int	SE_PIXEL_TYPE_4BIT Tag for raster pixel type 4 bit.
static int	SE_PIXEL_TYPE_64BIT_REAL Tag for raster pixel type 64 bit real.
static int	SE_PIXEL_TYPE_8BIT_S Tag for raster pixel type 8 bit signed.
static int	SE_PIXEL_TYPE_8BIT_U Tag for raster pixel type 8 bit unsigned.
static int	SE_PYRAMID_AUTO_LEVEL Tag for raster image pyramid auto level
static int	SE_RASTER_INTERLEAVE_BIL Tag for raster Interleave by line
static int	SE_RASTER_INTERLEAVE_BIL_91 Tag for raster Interleave by line
static int	SE_RASTER_INTERLEAVE_BIP Tag for raster Interleave by pixel
static int	SE_RASTER_INTERLEAVE_BIP_91 Tag for raster Interleave by pixel
static int	SE_RASTER_INTERLEAVE_BSQ Tag for raster interleave in band sequential order
static int	SE_RASTER_INTERLEAVE_BSQ_91 Tag for raster interleave in band sequential order
static int	SE_RASTER_INTERLEAVE_NONE
static int	SE_RASTERBAND_CREATED Tag for SeRasterBand creation time
static int	SE_RASTERBAND_MODIFIED Tag for SeRasterBand last modified time

Constructor Summary

SeRaster()
Deprecated. at ArcSDE version 9.0

SeRaster(SeConnection conn)
Constructs SeRaster with specified SeConnection handle conn

SeRaster(SeConnection conn, SeObjectId rasColIdObj)
Constructs SeRaster with specified SeConnection handle conn and raster_column_ID object rasColIdObj.

Method Summary

void	addBand(SeRasterBand rasBand) Add a raster band to the raster.
java.lang.Object	clone() Clones the SeRaster object.
static int	compressionGetParamValue(int type) Class method: Gets compression from param value.
static int	compressionSetParamValue(int type, int value) Class method: Sets compression from param value.
void	create() Creates a database entry for this SeRaster object.
void	delete() Deletes this SeRaster object from database.
void	dropBand(SeRasterBand rasBand) Drop a raster band from the raster.
SeRasterBand[]	getBands() Retrieves all raster bands for this raster.
java.lang.String	getDescription() Retrieves the SeRaster description as String
void	getInfoById(SeObjectId rasterIdObj) Retrieves SeRaster info from server with specified raster_ID object rasterIdObj.
SeObjectId	getRasterColumnId() Retrieves the raster_column_ID as SeObjectId.
SeObjectId	getRasterId() Retrieves the raster_ID as SeObjectId.
void	setDescription(java.lang.String description) Sets the raster description String with input description
void	setRasterColumnId(SeObjectId rasColIdObj) Sets the raster_cloumn_ID
void	setRasterId(SeObjectId rasterIdObj) Sets the raster_ID.

Methods inherited from class java.lang.Object

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

Field Detail

SE_RASTERBAND_CREATED

public static final int SE_RASTERBAND_CREATED

Tag for SeRasterBand creation time

See Also:

Constant Field Values

SE_RASTERBAND_MODIFIED

public static final int SE_RASTERBAND_MODIFIED

Tag for SeRasterBand last modified time

See Also:

Constant Field Values

SE_PYRAMID_AUTO_LEVEL

public static final int SE_PYRAMID_AUTO_LEVEL

Tag for raster image pyramid auto level

See Also:

Constant Field Values

SE_PIXEL_TYPE_1BIT

public static final int SE_PIXEL_TYPE_1BIT

Tag for raster pixel type 1 bit.

See Also:

Constant Field Values

SE_PIXEL_TYPE_4BIT

public static final int SE_PIXEL_TYPE_4BIT

Tag for raster pixel type 4 bit.

See Also:

Constant Field Values

SE_PIXEL_TYPE_8BIT_U

public static final int SE_PIXEL_TYPE_8BIT_U

Tag for raster pixel type 8 bit unsigned.

See Also:

Constant Field Values

SE_PIXEL_TYPE_8BIT_S

public static final int SE_PIXEL_TYPE_8BIT_S

Tag for raster pixel type 8 bit signed.

See Also:

Constant Field Values

SE_PIXEL_TYPE_16BIT_U

public static final int SE_PIXEL_TYPE_16BIT_U

Tag for raster pixel type 16 bit unsigned.

See Also:

Constant Field Values

SE_PIXEL_TYPE_16BIT_S

public static final int SE_PIXEL_TYPE_16BIT_S

Tag for raster pixel type 16 bit signed.

See Also:

Constant Field Values

SE_PIXEL_TYPE_32BIT_U

public static final int SE_PIXEL_TYPE_32BIT_U

Tag for raster pixel type 32 bit unsigned.

See Also:

Constant Field Values

SE_PIXEL_TYPE_32BIT_S

public static final int SE_PIXEL_TYPE_32BIT_S

Tag for raster pixel type 32 bit signed.

See Also:

Constant Field Values

SE_PIXEL_TYPE_32BIT_REAL

public static final int SE_PIXEL_TYPE_32BIT_REAL

Tag for raster pixel type 32 bit real.

See Also:

Constant Field Values

SE_PIXEL_TYPE_64BIT_REAL

public static final int SE_PIXEL_TYPE_64BIT_REAL

Tag for raster pixel type 64 bit real.

See Also:

Constant Field Values

SE_COMPRESSION_NONE

public static final int SE_COMPRESSION_NONE

Tag for raster band compression type NONE

See Also:

Constant Field Values

SE_COMPRESSION_LZ77

public static final int SE_COMPRESSION_LZ77

Tag for raster band compression type LZ77

See Also:

Constant Field Values

SE_COMPRESSION_JPEG

public static final int SE_COMPRESSION_JPEG

Tag for raster band compression type JPEG

See Also:

Constant Field Values

SE_COMPRESSION_JP2

public static final int SE_COMPRESSION_JP2

Tag for raster band compression type JP2

See Also:

Constant Field Values

SE_INTERPOLATION_NONE

public static final int SE_INTERPOLATION_NONE

Tag for interpolation type NONE

See Also:

Constant Field Values

SE_INTERPOLATION_NEAREST

public static final int SE_INTERPOLATION_NEAREST

Tag for interpolation type nearest

See Also:

Constant Field Values

SE_INTERPOLATION_BILINEAR

public static final int SE_INTERPOLATION_BILINEAR

Tag for interpolation type BILINEAR

See Also:

Constant Field Values

SE_INTERPOLATION_BICUBIC

public static final int SE_INTERPOLATION_BICUBIC

Tag for interpolation type BICUBIC

See Also:

Constant Field Values

SE_BIN_FUNCTION_NONE

public static final int SE_BIN_FUNCTION_NONE

Tag for BIN function type NONE

See Also:

Constant Field Values

SE_BIN_FUNCTION_AUTO

public static final int SE_BIN_FUNCTION_AUTO

Tag for BIN function type auto

See Also:

Constant Field Values

SE_BIN_FUNCTION_DIRECT

public static final int SE_BIN_FUNCTION_DIRECT

Tag for BIN function type direct

See Also:

Constant Field Values

SE_BIN_FUNCTION_LINEAR

public static final int SE_BIN_FUNCTION_LINEAR

Tag for BIN function type linear

See Also:

Constant Field Values

SE_BIN_FUNCTION_LOGARITHM

public static final int SE_BIN_FUNCTION_LOGARITHM

Tag for BIN function type logarithm

See Also:

Constant Field Values

SE_BIN_FUNCTION_EXPLICIT

public static final int SE_BIN_FUNCTION_EXPLICIT

Tag for BIN function type explicit

See Also:

Constant Field Values

SE_COLORMAP_NONE

public static final int SE_COLORMAP_NONE

Tag for colormap type NONE

See Also:

Constant Field Values

SE_COLORMAP_RGB

public static final int SE_COLORMAP_RGB

Tag for colormap type RGB

See Also:

Constant Field Values

SE_COLORMAP_RGBA

public static final int SE_COLORMAP_RGBA

Tag for colormap type RGBA

See Also:

Constant Field Values

SE_COLORMAP_DATA_BYTE

public static final int SE_COLORMAP_DATA_BYTE

Tag for colormap data type byte

See Also:

Constant Field Values

SE_COLORMAP_DATA_SHORT

public static final int SE_COLORMAP_DATA_SHORT

Tag for colormap data type short

See Also:

Constant Field Values

SE_MOSAIC_MODE_NONE

public static final int SE_MOSAIC_MODE_NONE

Tag for raster mosaic mode NONE

See Also:

Constant Field Values

SE_MOSAIC_MODE_MERGE

public static final int SE_MOSAIC_MODE_MERGE

Tag for raster mosaic mode merge

See Also:

Constant Field Values

SE_MOSAIC_MODE_DELETE

public static final int SE_MOSAIC_MODE_DELETE

Tag for raster mosaic mode delete

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_NONE

public static final int SE_RASTER_INTERLEAVE_NONE

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BSQ

public static final int SE_RASTER_INTERLEAVE_BSQ

Tag for raster interleave in band sequential order

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BIP

public static final int SE_RASTER_INTERLEAVE_BIP

Tag for raster Interleave by pixel

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BIL

public static final int SE_RASTER_INTERLEAVE_BIL

Tag for raster Interleave by line

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BIP_91

public static final int SE_RASTER_INTERLEAVE_BIP_91

Tag for raster Interleave by pixel

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BIL_91

public static final int SE_RASTER_INTERLEAVE_BIL_91

Tag for raster Interleave by line

See Also:

Constant Field Values

SE_RASTER_INTERLEAVE_BSQ_91

public static final int SE_RASTER_INTERLEAVE_BSQ_91

Tag for raster interleave in band sequential order

See Also:

Constant Field Values

Constructor Detail

SeRaster

public SeRaster()

Deprecated. at ArcSDE version 9.0

Constructs SeRaster object.

Top of SeRaster class.

SeRaster

public SeRaster(SeConnection conn)
         throws SeException

Constructs SeRaster with specified SeConnection handle conn

Top of SeRaster class.

Parameters:

conn - a SeConnection handle.

Throws:

SeException - if an error occurs.

SeRaster

public SeRaster(SeConnection conn,
                SeObjectId rasColIdObj)
         throws SeException

Constructs SeRaster with specified SeConnection handle conn and raster_column_ID object rasColIdObj.

Top of SeRaster class.

Parameters:

conn - a SeConnection handle

rasColIdObj - raster_column layer's ID which can be obtain by the getID method of the SeRasterColumn class.

Throws:

SeException - if an error occurs

See Also:

setRasterColumnId(SeObjectId), SeRasterColumn.getID()

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the SeRaster object.

Overrides:

clone in class java.lang.Object

Returns:

an Object value

Throws:

java.lang.CloneNotSupportedException - if an error occurs.

create

public void create()
            throws SeException

Creates a database entry for this SeRaster object.

Throws:

SeException - if an error occurs.

delete

public void delete()
            throws SeException

Deletes this SeRaster object from database.

Throws:

SeException - if an error occurs.

getInfoById

public void getInfoById(SeObjectId rasterIdObj)
                 throws SeException

Retrieves SeRaster info from server with specified raster_ID object rasterIdObj.

This method does not return any SeRaster info to the caller. Use the following methods to get specific info:

• getDescription
• getRasterColumnId
• getRasterId

Parameters:

rasterIdObj - raster_ID of SeObjectId value type

Throws:

SeException - if an error occurs

getDescription

public java.lang.String getDescription()

Retrieves the SeRaster description as String

Returns:

a String value

getRasterColumnId

public SeObjectId getRasterColumnId()

Retrieves the raster_column_ID as SeObjectId.

Returns:

a SeObjectId value

getRasterId

public SeObjectId getRasterId()

Retrieves the raster_ID as SeObjectId.

Returns:

a SeObjectId value

setDescription

public void setDescription(java.lang.String description)

Sets the raster description String with input description

Parameters:

description - a String value. raster_column description.

setRasterColumnId

public void setRasterColumnId(SeObjectId rasColIdObj)
                       throws SeException

Sets the raster_cloumn_ID

Parameters:

rasColIdObj - raster_column layer's ID which can be obtain by the getID method of the SeRasterColumn class.

Throws:

SeException - if an error occurs

See Also:

SeRasterColumn.getID()

setRasterId

public void setRasterId(SeObjectId rasterIdObj)
                 throws SeException

Sets the raster_ID.

Parameters:

rasterIdObj - a SeObjectId value

Throws:

SeException - if an error occurs

addBand

public void addBand(SeRasterBand rasBand)
             throws SeException

Add a raster band to the raster.

Parameters:

rasBand - a SeRasterBand value

Throws:

SeException - if an error occurs.

See Also:

dropBand(SeRasterBand), getBands()

dropBand

public void dropBand(SeRasterBand rasBand)
              throws SeException

Drop a raster band from the raster.

Parameters:

rasBand - a SeRasterBand value

Throws:

SeException - if an error occurs

See Also:

addBand(SeRasterBand), getBands()

getBands

public SeRasterBand[] getBands()
                        throws SeException

Retrieves all raster bands for this raster.

Returns:

a SeRasterBand[] value

Throws:

SeException - if an error occurs

See Also:

addBand(SeRasterBand), dropBand(SeRasterBand)

compressionGetParamValue

public static int compressionGetParamValue(int type)

Class method: Gets compression from param value.

compressionSetParamValue

public static int compressionSetParamValue(int type,
                                           int value)

Class method: Sets compression from param value.