com.esri.sde.sdk.client
Class SeRasterColumn

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

All Implemented Interfaces:

java.lang.Cloneable

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

An SeRasterColumn object represents a column, in an ArcSDE table or layer, that contains raster values. Invoking the SeRasterColumn create() method, on any existing ArcSDE table or layer, designates a column in the corresponding RDBMS table as the ArcSDE raster column for that table.

Creating a new raster column adds data and meta-data tables, required to store the raster data, to the database user's table schema.

Since:

ArcSDE 9.0

See Also:

SeRaster

Field Summary

static byte	SE_GDBTYPE_NONE Tag for Geo database type NONE
static byte	SE_GDBTYPE_RASTERMAP Tag for Geo database type rastermap

Constructor Summary

SeRasterColumn(SeConnection conn)
Constructor to create an SeRasterColumn object associated with a specified server connection; used to add a new raster column to an existing ArcSDE Table or Layer.

SeRasterColumn(SeConnection conn, SeObjectId rasColId)
Constructor to create an SeRasterColumn object associated with a specific server connection and a specific raster column id; used to retrieve information about an existing raster column.

SeRasterColumn(SeConnection conn, java.lang.String table, java.lang.String rasCol)
Constructor to create an SeRasterColumn object associated with a specific server connection, table name and raster column name; used to retrieve information about an existing raster column.

Method Summary

void	alter() Alters those characteristics of a raster column that can be modified after it has been created.
java.lang.Object	clone() Clones the SeRasterColumn object.
void	create() Adds a raster column to an ArcSDE Table or Layer.
void	delete() Deletes the raster column from the associated RDBMS table.
int	getAccess() Returns the bitmask of the privileges that the current user has on this raster column.
java.lang.String	getConfigurationKeyword() Returns the configuration keyword used when creating this raster column.
SeCoordinateReference	getCoordRef() Returns this raster column's coordinate reference.
java.util.Date	getCreationDate() Returns the date and time that this raster column was created.
java.lang.String	getDescription() Returns the raster column's description string.
byte	getGdbType() Returns the GeoDataBase (GDB) type associated with this raster column.
SeObjectId	getID() Returns this raster column's id value.
void	getInfo() Refreshes this SeRasterColumn object.
SeObjectId	getMinID() Returns the minimum raster id value in this raster column.
java.lang.String	getName() Returns the name of this raster column
java.lang.String	getQualifiedTableName() Returns the qualified name of the ArcSDE table that contains this raster column
java.lang.String	getTableName() Returns the name of the ArcSDE table associated with this raster column.
void	grantAccess(int privilege, boolean grant, java.lang.String user) Grants the privileges specified, on this raster column, to another RDBMS user.
boolean	hasGdbType() Returns true if the raster column is registered as a geodatabase raster dataset, false otherwise.
boolean	isLoadOnly() Deprecated. at ArcSDE v9.0.
void	migrateStorage(java.lang.String config_keyword) Migrate storage type for raster block and auxiliary from LONG RAW to BLOB(Oracle only).
void	revokeAccess(int privilege, java.lang.String user) Revokes the privileges specified, on this raster column, from another RDBMS user.
void	setConfigurationKeyword(java.lang.String configKeyword) Sets the configuration keyword for this raster column.
void	setCoordRef(SeCoordinateReference coordref) Sets the coordinate reference for this raster column.
void	setDescription(java.lang.String description) Sets the raster column's description.
void	setGdbType(byte gdbType) Sets the GeoDataBase (GDB) type for this raster column.
void	setMinID(SeObjectId minID) Sets minimum id number that a raster value in this raster column can start with.
void	setRasterColumnName(java.lang.String rasterColName) Sets the name of this raster column.
void	setTableName(java.lang.String tableName) Sets the name of the table name that contains this raster column.
java.lang.String	toString() toString () method for SeRasterColumn object.
void	truncate() Deletes all the raster data in the raster column of an ArcSDE table or layer.

Methods inherited from class java.lang.Object

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

Field Detail

SE_GDBTYPE_NONE

public static final byte SE_GDBTYPE_NONE

Tag for Geo database type NONE

See Also:

Constant Field Values

SE_GDBTYPE_RASTERMAP

public static final byte SE_GDBTYPE_RASTERMAP

Tag for Geo database type rastermap

See Also:

Constant Field Values

Constructor Detail

SeRasterColumn

public SeRasterColumn(SeConnection conn)
               throws SeException

Constructor to create an SeRasterColumn object associated with a specified server connection; used to add a new raster column to an existing ArcSDE Table or Layer.

Parameters:

conn - an open SeConnection instance

Throws:

SeException - if an error occurs

SeRasterColumn

public SeRasterColumn(SeConnection conn,
                      SeObjectId rasColId)
               throws SeDoesNotExistException,
                      SeException

Constructor to create an SeRasterColumn object associated with a specific server connection and a specific raster column id; used to retrieve information about an existing raster column.

Parameters:

conn - an open SeConnection instance

rasColId - the raster column's id value

Throws:

SeException,SeDoesNotExistException - if an error occurs

SeDoesNotExistException

SeException

SeRasterColumn

public SeRasterColumn(SeConnection conn,
                      java.lang.String table,
                      java.lang.String rasCol)
               throws SeDoesNotExistException,
                      SeException

Constructor to create an SeRasterColumn object associated with a specific server connection, table name and raster column name; used to retrieve information about an existing raster column.

Parameters:

conn - an open SeConnection instance

table - the name of the table with a raster column

rasCol - the name of the raster column

Throws:

SeException - if an error occurs

SeDoesNotExistException

See Also:

setTableName(String), setRasterColumnName(String)

Method Detail

alter

public void alter()
           throws SeException

Alters those characteristics of a raster column that can be modified after it has been created.

You can change the following characteristics:

• Raster column's description
• Raster column's coordinate system
• Load mode

Throws:

SeException - if an error occurs

clone

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

Clones the SeRasterColumn object.

Overrides:

clone in class java.lang.Object

Returns:

a SeRasterColumn as type Object

Throws:

java.lang.CloneNotSupportedException - if an error occurs

create

public void create()
            throws SeException

Adds a raster column to an ArcSDE Table or Layer. Before this method is invoked the ArcSDE table name and a name for the new raster column must be specified.

Throws:

SeException - if an error occurs

See Also:

setTableName(String), setRasterColumnName(String)

delete

public void delete()
            throws SeException

Deletes the raster column from the associated RDBMS table. Only the raster column and all raster data is deleted. The other columns of the associated RDBMS table remain untouched.

Throws:

SeException - if an error occurs

getInfo

public void getInfo()
             throws SeException

Refreshes this SeRasterColumn object. This method requires that this SeRasterColumn object is associated with an open connection, a valid ArcSDE table and the raster column name of that table. Similar to SeRasterColumn(SeConnection, String, String)

Throws:

SeException - if an error occurs

grantAccess

public void grantAccess(int privilege,
                        boolean grant,
                        java.lang.String user)
                 throws SeException

Grants the privileges specified, on this raster column, to another RDBMS user.

The user invoking this method must have the privilege to grant or revoke privileges on this raster column.

If grant is TRUE, then the user in turn can grant or revoke privileges on this raster column, to another user.

Grant multiple privileges to a user with the OR operator and the appropriate privilege masks.

The access privileges that can be granted are:

• SeDefs.SE_DELETE_PRIVILEGE
• SeDefs.SE_INSERT_PRIVILEGE
• SeDefs.SE_SELECT_PRIVILEGE
• SeDefs.SE_UPDATE_PRIVILEGE

Parameters:

privilege - bit mask of the privileges to grant to the user

grant - specify, true or false, if the user specified can himself grant or revoke privileges on this raster column

user - the name of an RDBMS user

Throws:

SeException - if an error occurs

See Also:

getAccess(), revokeAccess(int, String), SeDefs

revokeAccess

public void revokeAccess(int privilege,
                         java.lang.String user)
                  throws SeException

Revokes the privileges specified, on this raster column, from another RDBMS user.

The user invoking this method must have the privilege to grant or revoke privileges on this raster column.

If grant is TRUE, then the user in turn can grant or revoke privileges on this raster column, to another user.

Revoke multiple privileges to a user with the OR operator and the appropriate privilege masks.

The access privileges that can be revoked are:

• SeDefs.SE_DELETE_PRIVILEGE
• SeDefs.SE_INSERT_PRIVILEGE
• SeDefs.SE_SELECT_PRIVILEGE
• SeDefs.SE_UPDATE_PRIVILEGE

Parameters:

privilege - an int value. Privilege to revoke..

user - a String value. DBMS user name to whom privilges need to be granted.

Throws:

SeException - if an error occurs

See Also:

getAccess(), grantAccess(int, boolean, String), SeDefs

truncate

public void truncate()
              throws SeException

Deletes all the raster data in the raster column of an ArcSDE table or layer. The raster column itself is not deleted.

Throws:

SeException - if an error occurs

getAccess

public int getAccess()

Returns the bitmask of the privileges that the current user has on this raster column.

Possible value are:

• SeDefs.SE_DELETE_PRIVILEGE
• SeDefs.SE_INSERT_PRIVILEGE
• SeDefs.SE_SELECT_PRIVILEGE
• SeDefs.SE_UPDATE_PRIVILEGE

Returns:

the privilege bit mask, for the user, on this raster column

See Also:

grantAccess(int, boolean, String), revokeAccess(int, String), SeDefs

getCoordRef

public SeCoordinateReference getCoordRef()

Returns this raster column's coordinate reference.

Returns:

this raster column's coordinate reference.

See Also:

setCoordRef(SeCoordinateReference)

getCreationDate

public java.util.Date getCreationDate()

Returns the date and time that this raster column was created.

Returns:

this raster column's creation date

getConfigurationKeyword

public java.lang.String getConfigurationKeyword()

Returns the configuration keyword used when creating this raster column.

Returns:

raster column's creation keyword

See Also:

setConfigurationKeyword(String)

getDescription

public java.lang.String getDescription()

Returns the raster column's description string.

Returns:

raster column's description

See Also:

setDescription(String)

getGdbType

public byte getGdbType()

Returns the GeoDataBase (GDB) type associated with this raster column. Value is either SE_GDBTYPE_NONE or SE_GDBTYPE_RASTERMAP.

Returns:

the Geodatabase type of this raster column

See Also:

hasGdbType(), setGdbType(byte)

getID

public SeObjectId getID()

Returns this raster column's id value.

Returns:

raster column's id value

getMinID

public SeObjectId getMinID()

Returns the minimum raster id value in this raster column.

Returns:

minimum possible raster id value

See Also:

setMinID(SeObjectId)

getQualifiedTableName

public java.lang.String getQualifiedTableName()
                                       throws SeException

Returns the qualified name of the ArcSDE table that contains this raster column

Returns:

raster column's qualified table name

Throws:

SeException

See Also:

getTableName(), setTableName(String)

getName

public java.lang.String getName()

Returns the name of this raster column

Returns:

raster column's name

See Also:

setRasterColumnName(String)

getTableName

public java.lang.String getTableName()

Returns the name of the ArcSDE table associated with this raster column.

Returns:

raster column's table name

See Also:

getQualifiedTableName(), setTableName(String)

hasGdbType

public boolean hasGdbType()

Returns true if the raster column is registered as a geodatabase raster dataset, false otherwise.

Returns:

true if raster column is a geodatabase raster dataset.

See Also:

getGdbType(), setGdbType(byte)

isLoadOnly

public boolean isLoadOnly()

Deprecated. at ArcSDE v9.0.

Returns true if the raster column is in load only mode, false if mode is normal I/O.

Returns:

true if mode is load only, false if normal I/O

See Also:

setLoadMode(boolean)

setCoordRef

public void setCoordRef(SeCoordinateReference coordref)
                 throws SeException

Sets the coordinate reference for this raster column.

Parameters:

coordref - a valid coordinate reference.

Throws:

SeException - if an error occurs

See Also:

getCoordRef()

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String configKeyword)

Sets the configuration keyword for this raster column. The raster column will be created according to the configuration specified by this keyword. The configuration keyword must correspond to a valid entry in the ArcSDE server's dbtune table.

Parameters:

configKeyword - valid configuration keyword

See Also:

getConfigurationKeyword()

setDescription

public void setDescription(java.lang.String description)

Sets the raster column's description.

Parameters:

description - a String description.

See Also:

getDescription()

setGdbType

public void setGdbType(byte gdbType)
                throws SeException

Sets the GeoDataBase (GDB) type for this raster column. Value is either SE_GDBTYPE_NONE or SE_GDBTYPE_RASTERMAP.

Parameters:

gdbType - the geodatabase type

Throws:

SeException - if an error occurs

See Also:

getGdbType(), setGdbType(byte)

setMinID

public void setMinID(SeObjectId minID)
              throws SeException

Sets minimum id number that a raster value in this raster column can start with.

Parameters:

minID - the minimum id value a raster value can start with

Throws:

SeException - if an error occurs

See Also:

getMinID()

setRasterColumnName

public void setRasterColumnName(java.lang.String rasterColName)
                         throws SeException

Sets the name of this raster column.

Parameters:

rasterColName - a String name for the raster column

Throws:

SeException - if an error occurs

See Also:

getName()

setTableName

public void setTableName(java.lang.String tableName)
                  throws SeException

Sets the name of the table name that contains this raster column.

Parameters:

tableName - the name of the ArcSDE table

Throws:

SeException - if an error occurs

See Also:

getTableName(), getQualifiedTableName()

migrateStorage

public void migrateStorage(java.lang.String config_keyword)
                    throws SeException

Migrate storage type for raster block and auxiliary from LONG RAW to BLOB(Oracle only).

Notes

- It is strongly recommended to create a backup of data before geometry storage type migration. For example, this could be in the form of an sdeexport file.

- Storage migration must be done by the user who owns the table.

Parameters:

config_keyword - The DBTUNE configuration keyword containing a RASTER_STORAGE parameter set to BLOB

Throws:

SeException - if an error occurs

toString

public java.lang.String toString()

toString () method for SeRasterColumn object.

Overrides:

toString in class java.lang.Object

Returns:

a String value