com.esri.arcgis.geodatabasedistributed
Interface IGeoDataServerInit

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeoDataServer

public interface IGeoDataServerInit
extends Serializable

Provides access to members that support initializing a GeoDataServer.

Remarks

The IGeoDataServerInit interface is used to initialize the GeoDataServer coclass. The coclass must be intialized before any of the other interfaces in the coclass can be used. GeoDataServers that are already published in ArcGIS for Server can also be accessed using the GISClient or Server libraries depending on the type of connection.

Product Availability

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

Method Summary

int	getMaxRecordCount() The maximum number of records returned for query results.
String	getPhysicalOutputDirectory() The physical directory for output files.
String	getVirtualOutputDirectory() The virtual directory for output files.
void	initFromConnectionString(String connectionString) Initializes a GeoDataServer object from a connection string to a geodatabase.
void	initFromFile(String file) Initializes a GeoDataServer object from a geodatabase or an sde connection file (*.sde).
void	initFromMap(String filePath) Initializes a GeoDataServer object with a map document.
void	initWithWorkspace(IWorkspace pWorkspace) Initializes a GeoDataServer object with a workspace.
void	setMaxRecordCount(int count) The maximum number of records returned for query results.
void	setPhysicalOutputDirectory(String dirPath) The physical directory for output files.
void	setVirtualOutputDirectory(String dirPath) The virtual directory for output files.

Method Detail

initFromMap

void initFromMap(String filePath)
                 throws IOException,
                        AutomationException

Initializes a GeoDataServer object with a map document.

Remarks

The InitFromMap method uses a file system path to an ArcMap document to initialize the GeoDataServer. The document must contain layers or tables from a single geodatabase connection.

Product Availability

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

Parameters:

filePath - The filePath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromFile

void initFromFile(String file)
                  throws IOException,
                         AutomationException

Initializes a GeoDataServer object from a geodatabase or an sde connection file (*.sde).

Remarks

The InitFromFile method uses a file system path to a geodatabase or an ArcSDE geodatabase connection file to initialize the GeoDataServer.

Product Availability

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

Parameters:

file - The file (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initFromConnectionString

void initFromConnectionString(String connectionString)
                              throws IOException,
                                     AutomationException

Initializes a GeoDataServer object from a connection string to a geodatabase.

Product Availability

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

Parameters:

connectionString - The connectionString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initWithWorkspace

void initWithWorkspace(IWorkspace pWorkspace)
                       throws IOException,
                              AutomationException

Initializes a GeoDataServer object with a workspace.

Remarks

The InitWithWorkspace method initializes a GeoDataServer object with a workspace object for the geodatabase.

Product Availability

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

Parameters:

pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPhysicalOutputDirectory

void setPhysicalOutputDirectory(String dirPath)
                                throws IOException,
                                       AutomationException

The physical directory for output files.

Product Availability

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

Parameters:

dirPath - The dirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

String getPhysicalOutputDirectory()
                                  throws IOException,
                                         AutomationException

The physical directory for output files.

Remarks

The PhysicalOutputDirectory method represents the physical directory for output files. This is a path to a local directory where files are placed when executing operations on a GeoDataServer. If the GeoDataServer is running inside ArcGIS for Server, this refers to a directory on the server machine. This value is set when configuring a geodata service inside ArcGIS for Server.

Product Availability

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

Returns:

The dirPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

void setVirtualOutputDirectory(String dirPath)
                               throws IOException,
                                      AutomationException

The virtual directory for output files.

Product Availability

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

Parameters:

dirPath - The dirPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

String getVirtualOutputDirectory()
                                 throws IOException,
                                        AutomationException

The virtual directory for output files.

Remarks

The VirtualOutputDirectory property refers to a virtual directory where output files are placed when executing operations on a GeoDataServer. This value is set when configuring a geodata service inside ArcGIS for Server.

The VirtualOutputDirectory should reference the same directory as the PhysicalOutputDirectory.

Product Availability

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

Returns:

The dirPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

int getMaxRecordCount()
                      throws IOException,
                             AutomationException

The maximum number of records returned for query results.

Remarks

The MaxRecordCount property represents the maximum number of records returned for a query result. This property is used when calling the IGeoDataServer::TableSearch method.

You can use this property to prevent large queries from being executed against the GeoDataServer. For example, if 130,000 rows satisfy the query and the MaxRecordCount is 100,000, only 100,000 records will be returned. For GeoDataServers published with ArcGIS for Server, this value is set by the administrator when the GeoDataServer is created. For locally initialized GeoDataServers, this value can be reset at any time.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

void setMaxRecordCount(int count)
                       throws IOException,
                              AutomationException

The maximum number of records returned for query results.

Product Availability

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

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.