com.esri.arcgis.datasourcesraster
Interface IBasicRasterSdeConnection

All Superinterfaces:
Serializable
All Known Implementing Classes:
BasicRasterSdeLoader

public interface IBasicRasterSdeConnection
extends Serializable

Provides access to members that control the RasterSDE connection.

Description

IBasicRasterSdeConnection allows you to set up the ArcSDE connection information before loading or manipulating raster dataset in ArcSDE. This interface is used internally and is not recommended in ArcGIS 9.x. Please see IRasterWorkspace or IRasterWorkspaceEx instead.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
BasicRasterSdeLoader

Method Summary
 String getDatabase()
          The database name.
 String getInputBitMaskName()
          The input 1-bit raster dataset name to be used as mask.
 String getInputRasterName()
          The input raster dataset name.
 String getInstance()
          The server instance.
 IRaster getMaskRaster()
          The input raster mask to be loaded to SDE.
 String getPassword()
          The password.
 IRaster getRaster()
          The input raster to be loaded to SDE.
 String getSdeRasterName()
          The output raster dataset name.
 String getServerName()
          The server name.
 String getUserName()
          The username.
 void setDatabase(String databaseName)
          The database name.
 void setInputBitMaskName(String bitMaskName)
          The input 1-bit raster dataset name to be used as mask.
 void setInputRasterName(String inputName)
          The input raster dataset name.
 void setInstance(String name)
          The server instance.
 void setMaskRasterByRef(IRaster maskRaster)
          The input raster mask to be loaded to SDE.
 void setPassword(String password)
          The password.
 void setRasterByRef(IRaster raster)
          The input raster to be loaded to SDE.
 void setSdeRasterName(String outputName)
          The output raster dataset name.
 void setSdeWorkspaceName(IWorkspaceName rhs1)
          The SDE Connection, set through WorkspaceName object.
 void setServerName(String name)
          The server name.
 void setUserName(String userName)
          The username.
 

Method Detail

setServerName

void setServerName(String name)
                   throws IOException,
                          AutomationException
The server name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerName

String getServerName()
                     throws IOException,
                            AutomationException
The server name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInstance

void setInstance(String name)
                 throws IOException,
                        AutomationException
The server instance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInstance

String getInstance()
                   throws IOException,
                          AutomationException
The server instance.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDatabase

void setDatabase(String databaseName)
                 throws IOException,
                        AutomationException
The database name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
databaseName - The databaseName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatabase

String getDatabase()
                   throws IOException,
                          AutomationException
The database name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The databaseName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSdeRasterName

void setSdeRasterName(String outputName)
                      throws IOException,
                             AutomationException
The output raster dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
outputName - The outputName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSdeRasterName

String getSdeRasterName()
                        throws IOException,
                               AutomationException
The output raster dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The outputName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserName

void setUserName(String userName)
                 throws IOException,
                        AutomationException
The username.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
userName - The userName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserName

String getUserName()
                   throws IOException,
                          AutomationException
The username.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The userName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPassword

void setPassword(String password)
                 throws IOException,
                        AutomationException
The password.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
password - The password (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPassword

String getPassword()
                   throws IOException,
                          AutomationException
The password.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The password
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputRasterName

void setInputRasterName(String inputName)
                        throws IOException,
                               AutomationException
The input raster dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
inputName - The inputName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputRasterName

String getInputRasterName()
                          throws IOException,
                                 AutomationException
The input raster dataset name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The inputName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputBitMaskName

void setInputBitMaskName(String bitMaskName)
                         throws IOException,
                                AutomationException
The input 1-bit raster dataset name to be used as mask.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
bitMaskName - The bitMaskName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputBitMaskName

String getInputBitMaskName()
                           throws IOException,
                                  AutomationException
The input 1-bit raster dataset name to be used as mask.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The bitMaskName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSdeWorkspaceName

void setSdeWorkspaceName(IWorkspaceName rhs1)
                         throws IOException,
                                AutomationException
The SDE Connection, set through WorkspaceName object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException
The input raster to be loaded to SDE.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(IRaster raster)
                    throws IOException,
                           AutomationException
The input raster to be loaded to SDE.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaskRaster

IRaster getMaskRaster()
                      throws IOException,
                             AutomationException
The input raster mask to be loaded to SDE.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskRasterByRef

void setMaskRasterByRef(IRaster maskRaster)
                        throws IOException,
                               AutomationException
The input raster mask to be loaded to SDE.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
maskRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.