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, java.io.Externalizable, java.io.Serializable

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

COM Class 'WorkspaceName'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Workspace Name 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

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceName2

IID, IID05fc30e9_3007_11d4_8140_00c04f686238, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceName

IIDfadd975c_e36f_11d1_aa81_00c04fa33a15

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.geodatabase.IDatabaseCompact

IID, IID660214d1_7c1b_11d3_80ea_00c04f686238, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

Constructors

Constructor and Description
WorkspaceName() Constructs a WorkspaceName using ArcGIS Engine.
WorkspaceName(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. WorkspaceName theWorkspaceName = (WorkspaceName) obj;

Method Summary

Modifier and Type	Method and Description
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(java.lang.Object o) Compare this object with another
java.lang.String	getBrowseName() The browse name of the WorkspaceName.
java.lang.String	getCategory() The category of the WorkspaceName.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IPropertySet	getConnectionProperties() The connection properties of the WorkspaceName.
java.lang.String	getConnectionString() The connection properties of the WorkspaceName.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getNameString() The name string of the object.
java.lang.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.
java.lang.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
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBrowseName(java.lang.String browseName) The browse name of the WorkspaceName.
void	setConnectionProperties(IPropertySet connectionProperties) The connection properties of the WorkspaceName.
void	setConnectionString(java.lang.String connectionSting) The connection properties of the WorkspaceName.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setPathName(java.lang.String pathName) The path name of the WorkspaceName.
void	setWorkspaceFactoryProgID(java.lang.String progID) The ProgID of the WorkspaceName's workspace factory.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

WorkspaceName

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

Constructs a WorkspaceName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

WorkspaceName

public WorkspaceName(java.lang.Object obj)
              throws java.io.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:

java.io.IOException - if there are interop problems

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.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:

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

AutomationException - If the ArcObject component throws an exception.

getPathName

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

The path name of the WorkspaceName.

Specified by:

getPathName in interface IWorkspaceName

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPathName

public void setPathName(java.lang.String pathName)
                 throws java.io.IOException,
                        AutomationException

The path name of the WorkspaceName.

Specified by:

setPathName in interface IWorkspaceName

Parameters:

pathName - The pathName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactoryProgID

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

The ProgID of the WorkspaceName's workspace factory.

Specified by:

getWorkspaceFactoryProgID in interface IWorkspaceName

Returns:

The progID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceFactoryProgID

public void setWorkspaceFactoryProgID(java.lang.String progID)
                               throws java.io.IOException,
                                      AutomationException

The ProgID of the WorkspaceName's workspace factory.

Specified by:

setWorkspaceFactoryProgID in interface IWorkspaceName

Parameters:

progID - The progID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrowseName

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

The browse name of the WorkspaceName.

Specified by:

getBrowseName in interface IWorkspaceName

Returns:

The browseName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String browseName)
                   throws java.io.IOException,
                          AutomationException

The browse name of the WorkspaceName.

Specified by:

setBrowseName in interface IWorkspaceName

Parameters:

browseName - The browseName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws java.io.IOException,
                                             AutomationException

The workspace factory of the WorkspaceName.

Specified by:

getWorkspaceFactory in interface IWorkspaceName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws java.io.IOException,
                                    AutomationException

The connection properties of the WorkspaceName.

Specified by:

setConnectionProperties in interface IWorkspaceName

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

The connection properties of the WorkspaceName.

Specified by:

getConnectionProperties in interface IWorkspaceName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

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

The type of the associated workspace.

Specified by:

getType in interface IWorkspaceName

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

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 WorkspaceName.

Specified by:

getCategory in interface IWorkspaceName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionString

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

The connection properties of the WorkspaceName.

Specified by:

getConnectionString in interface IWorkspaceName2

Returns:

The connectionSting

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConnectionString

public void setConnectionString(java.lang.String connectionSting)
                         throws java.io.IOException,
                                AutomationException

The connection properties of the WorkspaceName.

Specified by:

setConnectionString in interface IWorkspaceName2

Parameters:

connectionSting - The connectionSting (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

compact

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

Compacts the database.

Specified by:

compact in interface IDatabaseCompact

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canCompact

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

True if this dataset can be compacted.

Specified by:

canCompact in interface IDatabaseCompact

Returns:

The canCompact

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException