com.esri.arcgis.geodatabase
Class WorkspaceName

java.lang.Object
  com.esri.arcgis.geodatabase.WorkspaceName

All Implemented Interfaces:

IDatabaseCompact, IWorkspaceName, IWorkspaceName2, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class WorkspaceName
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, IWorkspaceName, IWorkspaceName2, IPersist, IPersistStream, IDatabaseCompact, IXMLSerialize, Externalizable

ESRI WorkspaceName object.

Remarks

A workspace name specifies a workspace object and can be used to instantiate it. The workspace is specified using the connection properties for the workspace. A workspace name is a key component of any dataset name for datasets in the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

WorkspaceName()
Constructs a WorkspaceName using ArcGIS Engine.

WorkspaceName(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WorkspaceName theWorkspaceName = (WorkspaceName) obj;

Method Summary

boolean	canCompact() True if this dataset can be compacted.
void	compact() Compacts the database.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
String	getBrowseName() The browse name of the WorkspaceName.
String	getCategory() The category of the WorkspaceName.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IPropertySet	getConnectionProperties() The connection properties of the WorkspaceName.
String	getConnectionString() The connection properties of the WorkspaceName.
String	getNameString() The name string of the object.
String	getPathName() The path name of the WorkspaceName.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of the associated workspace.
IWorkspaceFactory	getWorkspaceFactory() The workspace factory of the WorkspaceName.
String	getWorkspaceFactoryProgID() The ProgID of the WorkspaceName's workspace factory.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
Object	open() Opens the object referred to by this name.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBrowseName(String browseName) The browse name of the WorkspaceName.
void	setConnectionProperties(IPropertySet connectionProperties) The connection properties of the WorkspaceName.
void	setConnectionString(String connectionSting) The connection properties of the WorkspaceName.
void	setNameString(String nameString) The name string of the object.
void	setPathName(String pathName) The path name of the WorkspaceName.
void	setWorkspaceFactoryProgID(String progID) The ProgID of the WorkspaceName's workspace factory.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

WorkspaceName

public WorkspaceName()
              throws IOException,
                     UnknownHostException

Constructs a WorkspaceName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

WorkspaceName

public WorkspaceName(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WorkspaceName theWorkspaceName = (WorkspaceName) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setNameString

public void setNameString(String nameString)
                   throws IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws IOException,
                            AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws IOException,
                   AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathName

public String getPathName()
                   throws IOException,
                          AutomationException

The path name of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPathName in interface IWorkspaceName

Returns:

The pathName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathName

public void setPathName(String pathName)
                 throws IOException,
                        AutomationException

The path name of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPathName in interface IWorkspaceName

Parameters:

pathName - The pathName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactoryProgID

public String getWorkspaceFactoryProgID()
                                 throws IOException,
                                        AutomationException

The ProgID of the WorkspaceName's workspace factory.

Description

The WorkspaceFactoryProgID identifies the ProgID of the WorkspaceFactory object that is used to open that particular workspace.

Here is a list of some of the possible WorkspaceFactoryProgIDs:

• esriDataSourcesGDB.AccessWorkspaceFactory
• esriDataSourcesFile.ArcInfoWorkspaceFactory
• esriDataSourcesFile.CadWorkspaceFactory
• esriDataSourcesGDB.FileGDBWorkspaceFactory
• esriDataSourcesOleDB.OLEDBWorkspaceFactory
• esriDataSourcesFile.PCCoverageWorkspaceFactory
• esriDataSourcesRaster.RasterWorkspaceFactory
• esriDataSourcesGDB.SdeWorkspaceFactory
• esriDataSourcesFile.ShapefileWorkspaceFactory
• esriDataSourcesOleDB.TextFileWorkspaceFactory
• esriDataSourcesFile.TinWorkspaceFactory
• esriDataSourcesFile.VpfWorkspaceFactory

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceFactoryProgID in interface IWorkspaceName

Returns:

The progID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceFactoryProgID

public void setWorkspaceFactoryProgID(String progID)
                               throws IOException,
                                      AutomationException

The ProgID of the WorkspaceName's workspace factory.

Description

The WorkspaceFactoryProgID identifies the ProgID of the COM WorkspaceFactory object used to open a workspace through a WorkspaceName object. You must set this property when you are using the WorkspaceName to open a workspace.

Here is a list of some of the possible WorkspaceFactoryProgIDs:

• esriDataSourcesGDB.AccessWorkspaceFactory
• esriDataSourcesFile.ArcInfoWorkspaceFactory
• esriDataSourcesFile.CadWorkspaceFactory
• esriDataSourcesGDB.FileGDBWorkspaceFactory
• esriDataSourcesOleDB.OLEDBWorkspaceFactory
• esriDataSourcesFile.PCCoverageWorkspaceFactory
• esriDataSourcesRaster.RasterWorkspaceFactory
• esriDataSourcesGDB.SdeWorkspaceFactory
• esriDataSourcesFile.ShapefileWorkspaceFactory
• esriDataSourcesOleDB.TextFileWorkspaceFactory
• esriDataSourcesFile.TinWorkspaceFactory
• esriDataSourcesFile.VpfWorkspaceFactory

To set the WorkspaceName's WorkspaceFactoryProgID, simply pass it the string representing the correct type of workspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorkspaceFactoryProgID in interface IWorkspaceName

Parameters:

progID - The progID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseName

public String getBrowseName()
                     throws IOException,
                            AutomationException

The browse name of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrowseName in interface IWorkspaceName

Returns:

The browseName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(String browseName)
                   throws IOException,
                          AutomationException

The browse name of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IWorkspaceName

Parameters:

browseName - The browseName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws IOException,
                                             AutomationException

The workspace factory of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceFactory in interface IWorkspaceName

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceFactory

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws IOException,
                                    AutomationException

The connection properties of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConnectionProperties in interface IWorkspaceName

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws IOException,
                                            AutomationException

The connection properties of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IWorkspaceName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of the associated workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IWorkspaceName

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException

The category of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IWorkspaceName

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionString

public String getConnectionString()
                           throws IOException,
                                  AutomationException

The connection properties of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionString in interface IWorkspaceName2

Returns:

The connectionSting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(String connectionSting)
                         throws IOException,
                                AutomationException

The connection properties of the WorkspaceName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConnectionString in interface IWorkspaceName2

Parameters:

connectionSting - The connectionSting (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

compact

public void compact()
             throws IOException,
                    AutomationException

Compacts the database.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

compact in interface IDatabaseCompact

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canCompact

public boolean canCompact()
                   throws IOException,
                          AutomationException

True if this dataset can be compacted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canCompact in interface IDatabaseCompact

Returns:

The canCompact

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException