com.esri.arcgis.location
Class LocatorName

java.lang.Object
  com.esri.arcgis.location.LocatorName

All Implemented Interfaces:

ILocatorName, IMetadata, ISQLPrivilege, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class LocatorName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, ILocatorName, IPersistStream, ISupportErrorInfo, IMetadata, ISQLPrivilege, java.io.Externalizable

COM Class 'LocatorName'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'Name object for a locator.' 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

static long

serialVersionUID

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

IID, IID837a9cf2_88c9_11d3_9f66_00c04f6bdf06, xxDummy

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.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

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

IID, IIDa867a185_c5cb_11d2_aae2_00c04fa37849, xxDummy

Constructor Summary

LocatorName()
Constructs a LocatorName using ArcGIS Engine.

LocatorName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocatorName theLocatorName = (LocatorName) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() Category of the locator.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getDescription() Description of the locator.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILocatorWorkspaceName	getLocatorWorkspaceName() Name object for the locator workspace that contains the locator.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getName() Name of the locator.
java.lang.String	getNameString() The name string of the object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getSQLPrivileges() The database privileges.
void	grant(java.lang.String userName, int privileges, boolean withGrant) Grants privileges for the database user.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isStyle() Indicates if this is a locator style.
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 a LocatorName.
void	revoke(java.lang.String userName, int privileges) Revokes privileges for the database user.
void	save(IStream pstm, int fClearDirty) save
void	setCategory(java.lang.String category) Category of the locator.
void	setDescription(java.lang.String description) Description of the locator.
void	setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName) Name object for the locator workspace that contains the locator.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setName(java.lang.String name) Name of the locator.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setStyle(boolean isStyle) Indicates if this is a locator style.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.
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

LocatorName

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

Constructs a LocatorName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LocatorName

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

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

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

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a LocatorName.

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.

getName

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

Name of the locator.

Specified by:

getName in interface ILocatorName

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Name of the locator.

Specified by:

setName in interface ILocatorName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Description of the locator.

Specified by:

getDescription in interface ILocatorName

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

Description of the locator.

Specified by:

setDescription in interface ILocatorName

Parameters:

description - The description (in)

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

Category of the locator.

Specified by:

getCategory in interface ILocatorName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

Category of the locator.

Specified by:

setCategory in interface ILocatorName

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isStyle

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

Indicates if this is a locator style.

Specified by:

isStyle in interface ILocatorName

Returns:

The isStyle

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStyle

public void setStyle(boolean isStyle)
              throws java.io.IOException,
                     AutomationException

Indicates if this is a locator style.

Specified by:

setStyle in interface ILocatorName

Parameters:

isStyle - The isStyle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorWorkspaceName

public ILocatorWorkspaceName getLocatorWorkspaceName()
                                              throws java.io.IOException,
                                                     AutomationException

Name object for the locator workspace that contains the locator.

Specified by:

getLocatorWorkspaceName in interface ILocatorName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocatorWorkspaceNameByRef

public void setLocatorWorkspaceNameByRef(ILocatorWorkspaceName locatorWorkspaceName)
                                  throws java.io.IOException,
                                         AutomationException

Name object for the locator workspace that contains the locator.

Specified by:

setLocatorWorkspaceNameByRef in interface ILocatorName

Parameters:

locatorWorkspaceName - A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspaceName (in)

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMetadata

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

The PropertySet containing metadata.

Specified by:

getMetadata in interface IMetadata

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.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Specified by:

setMetadata in interface IMetadata

Parameters:

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

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSQLPrivileges

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

The database privileges.

Specified by:

getSQLPrivileges in interface ISQLPrivilege

Returns:

The privileges

Throws:

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

AutomationException - If the ArcObject component throws an exception.

grant

public void grant(java.lang.String userName,
                  int privileges,
                  boolean withGrant)
           throws java.io.IOException,
                  AutomationException

Grants privileges for the database user.

Specified by:

grant in interface ISQLPrivilege

Parameters:

userName - The userName (in)

privileges - The privileges (in)

withGrant - The withGrant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

revoke

public void revoke(java.lang.String userName,
                   int privileges)
            throws java.io.IOException,
                   AutomationException

Revokes privileges for the database user.

Specified by:

revoke in interface ISQLPrivilege

Parameters:

userName - The userName (in)

privileges - The privileges (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