com.esri.arcgis.catalog
Class GxDataServer

java.lang.Object
  com.esri.arcgis.catalog.GxDataServer

All Implemented Interfaces:

IGxGDSConnection, IGxObject, IGxObjectContainer, IGxObjectProperties, IGxObjectUI, IGxObjectWizard, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxDataServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectUI, IGxObjectProperties, IGxObjectWizard, IGxObjectContainer, IGxGDSConnection

COM Class 'GxDataServer'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'The one and only Data Server object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.catalog.IGxObject

IID, IIDbdbbb3eb_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI

IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectProperties

IID, IIDd342626e_f9da_11d3_a68d_0008c7d3ae8d, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectWizard

IID, IIDc6df682d_a28c_476a_924c_44d1194cf78d, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxObjectContainer

IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxGDSConnection

IID, IIDe10b6c94_58ed_4e45_84b2_285559bfa11e, xxDummy

Constructor Summary

GxDataServer()
Constructs a GxDataServer using ArcGIS Engine.

GxDataServer(java.lang.Object obj)
Construct a GxDataServer using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
void	attach(IGxObject parent, IGxCatalog pCatalog) Attaches the object to its parent and the catalog.
void	attachGeoDatabase(java.lang.String gdbName, java.lang.String gdbFileName) Attaches a Geodatabase.
void	connect() Connects to a GIS Data server.
void	createGeoDatabase(java.lang.String gdbName, java.lang.String gdbFileName, int gdbFileSize) Creates a new Geodatabase.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	disconnect() Disconnects from a GIS Data server.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getBaseName() The base name of the object (i.e.
java.lang.String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
IUID	getClassID() The class ID of this object.
static java.lang.String	getClsid() getClsid.
IUID	getContextMenu() The class ID of the context menu for this object.
java.lang.Object	getDataServerManager() The Data Server Manager object.
java.lang.String	getFullName() The full name of the object.
IName	getInternalObjectName() The Name for the internal object that this GxObject represents.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getLargeImage() The large image that represents the object.
int	getLargeSelectedImage() The large image that represents the object when it is selected.
java.lang.String	getName() The short name of the object.
IUID	getNewMenu() The class ID of the New menu for this object.
IGxObject	getParent() The parent of the object.
void	getPropByIndex(int index, java.lang.String[] name, java.lang.Object[] value) The name and value of the indexed property in the GxObject.
java.lang.Object	getProperty(java.lang.String name) The value of the named property in the GxObject.
int	getPropertyCount() The number of properties in the GxObject.
java.lang.String	getServerName() The server name.
int	getSmallImage() The small image that represents the object.
int	getSmallSelectedImage() The small image that represents the object when it is selected.
int	hashCode() the hashcode for this object
boolean	isAdministrator() Indicates whether the connected user is an administrator or not.
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isConnected() Indicates whether the GIS Data server connection has been made.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isValid() Indicates if the object is still valid.
void	pause() Pauses a Database server.
void	refresh() Updates the object and any children of the object.
void	release() Release a GxDataServer.
void	restoreGeodatabase(java.lang.String gdbName, java.lang.String backupFileName, java.lang.String dbFileName) Restores a backup to the specified Geodatabase.
void	resume() Resumes a Database server.
void	setProperty(java.lang.String name, java.lang.Object value) Set the value of the named property in the GxObject.
void	start() Starts a Database server.
void	stop() Stops a Database server.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GxDataServer

public GxDataServer()
             throws java.io.IOException,
                    java.net.UnknownHostException

Constructs a GxDataServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxDataServer

public GxDataServer(java.lang.Object obj)
             throws java.io.IOException

Construct a GxDataServer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GxDataServer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems GxDataServer theGxDataServer = (GxDataServer) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GxDataServer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The short name of the object.

Specified by:

getName in interface IGxObject

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullName

public java.lang.String getFullName()
                             throws java.io.IOException,
                                    AutomationException

The full name of the object.

Specified by:

getFullName in interface IGxObject

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException

The base name of the object (i.e. no extension).

Specified by:

getBaseName in interface IGxObject

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException

The category of the object.

Specified by:

getCategory in interface IGxObject

Returns:

The category

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws java.io.IOException,
                           AutomationException

The parent of the object.

Specified by:

getParent in interface IGxObject

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException

The class ID of this object.

Specified by:

getClassID in interface IGxObject

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws java.io.IOException,
                                   AutomationException

The Name for the internal object that this GxObject represents.

Specified by:

getInternalObjectName in interface IGxObject

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException

Indicates if the object is still valid.

Specified by:

isValid in interface IGxObject

Returns:

The isValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws java.io.IOException,
                   AutomationException

Attaches the object to its parent and the catalog.

Specified by:

attach in interface IGxObject

Parameters:

parent - A reference to a com.esri.arcgis.catalog.IGxObject (in)

pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException

Instructs the object to detach itself from its parent and the catalog.

Specified by:

detach in interface IGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException

Updates the object and any children of the object.

Specified by:

refresh in interface IGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException

The small image that represents the object.

Specified by:

getSmallImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

The small image that represents the object when it is selected.

Specified by:

getSmallSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException

The large image that represents the object.

Specified by:

getLargeImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException

The large image that represents the object when it is selected.

Specified by:

getLargeSelectedImage in interface IGxObjectUI

Returns:

The hBitmap (A COM typedef)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws java.io.IOException,
                           AutomationException

The class ID of the context menu for this object.

Specified by:

getContextMenu in interface IGxObjectUI

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws java.io.IOException,
                       AutomationException

The class ID of the New menu for this object.

Specified by:

getNewMenu in interface IGxObjectUI

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertyCount

public int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException

The number of properties in the GxObject.

Specified by:

getPropertyCount in interface IGxObjectProperties

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropByIndex

public void getPropByIndex(int index,
                           java.lang.String[] name,
                           java.lang.Object[] value)
                    throws java.io.IOException,
                           AutomationException

The name and value of the indexed property in the GxObject.

Specified by:

getPropByIndex in interface IGxObjectProperties

Parameters:

index - The index (in)

name - The name (in/out: use single element array)

value - A Variant (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

The value of the named property in the GxObject.

Specified by:

getProperty in interface IGxObjectProperties

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws java.io.IOException,
                        AutomationException

Set the value of the named property in the GxObject.

Specified by:

setProperty in interface IGxObjectProperties

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasChildren

public boolean isHasChildren()
                      throws java.io.IOException,
                             AutomationException

Indicates if the object has any children.

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws java.io.IOException,
                                 AutomationException

An enumeration of the child objects.

Specified by:

getChildren in interface IGxObjectContainer

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws java.io.IOException,
                          AutomationException

Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Specified by:

addChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(IGxObject child)
                 throws java.io.IOException,
                        AutomationException

Deletes the specified child object.

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConnected

public boolean isConnected()
                    throws java.io.IOException,
                           AutomationException

Indicates whether the GIS Data server connection has been made.

Specified by:

isConnected in interface IGxGDSConnection

Returns:

The isConnected

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAdministrator

public boolean isAdministrator()
                        throws java.io.IOException,
                               AutomationException

Indicates whether the connected user is an administrator or not.

Specified by:

isAdministrator in interface IGxGDSConnection

Returns:

The isAdministrator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect()
             throws java.io.IOException,
                    AutomationException

Connects to a GIS Data server.

Specified by:

connect in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException

Disconnects from a GIS Data server.

Specified by:

disconnect in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerName

public java.lang.String getServerName()
                               throws java.io.IOException,
                                      AutomationException

The server name.

Specified by:

getServerName in interface IGxGDSConnection

Returns:

The serverName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataServerManager

public java.lang.Object getDataServerManager()
                                      throws java.io.IOException,
                                             AutomationException

The Data Server Manager object.

Specified by:

getDataServerManager in interface IGxGDSConnection

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createGeoDatabase

public void createGeoDatabase(java.lang.String gdbName,
                              java.lang.String gdbFileName,
                              int gdbFileSize)
                       throws java.io.IOException,
                              AutomationException

Creates a new Geodatabase.

Specified by:

createGeoDatabase in interface IGxGDSConnection

Parameters:

gdbName - The gdbName (in)

gdbFileName - The gdbFileName (in)

gdbFileSize - The gdbFileSize (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attachGeoDatabase

public void attachGeoDatabase(java.lang.String gdbName,
                              java.lang.String gdbFileName)
                       throws java.io.IOException,
                              AutomationException

Attaches a Geodatabase.

Specified by:

attachGeoDatabase in interface IGxGDSConnection

Parameters:

gdbName - The gdbName (in)

gdbFileName - The gdbFileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreGeodatabase

public void restoreGeodatabase(java.lang.String gdbName,
                               java.lang.String backupFileName,
                               java.lang.String dbFileName)
                        throws java.io.IOException,
                               AutomationException

Restores a backup to the specified Geodatabase.

Specified by:

restoreGeodatabase in interface IGxGDSConnection

Parameters:

gdbName - The gdbName (in)

backupFileName - The backupFileName (in)

dbFileName - The dbFileName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

start

public void start()
           throws java.io.IOException,
                  AutomationException

Starts a Database server.

Specified by:

start in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws java.io.IOException,
                 AutomationException

Stops a Database server.

Specified by:

stop in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resume

public void resume()
            throws java.io.IOException,
                   AutomationException

Resumes a Database server.

Specified by:

resume in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pause

public void pause()
           throws java.io.IOException,
                  AutomationException

Pauses a Database server.

Specified by:

pause in interface IGxGDSConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.