com.esri.arcgis.location
Class GenericLocatorStyle

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

All Implemented Interfaces:

IClone, ILocator, ILocatorStyle, IPropertySet, ISupportErrorInfo, java.io.Serializable

public class GenericLocatorStyle

extends java.lang.Object

implements ILocator, ILocatorStyle, IPropertySet, IClone, ISupportErrorInfo

A generic style for creating a new locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

GenericLocatorStyle()
Constructs a GenericLocatorStyle using ArcGIS Engine.

GenericLocatorStyle(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getAllProperties(java.lang.Object[] names, java.lang.Object[] values) The name and value of all the properties in the property set.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILocator	getAsILocator() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ILocatorStyle	getAsILocatorStyle() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPropertySet	getAsIPropertySet() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getCategory() Category of the locator.
static java.lang.String	getClsid()
int	getCount() The number of properties contained in the property set.
java.lang.String	getDescription() Description of the locator.
java.lang.String	getName() Name of the locator.
void	getProperties(java.lang.Object names, java.lang.Object[] values) The values of the specified properties.
java.lang.Object	getProperty(java.lang.String name) The value of the specified property.
ILocatorUI	getUserInterface() User interface for the locator.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isEqual(IPropertySet propertySet) True if the property set is the same as the input property set.
boolean	isIdentical(IClone other) Returns TRUE when the receiver and other are the same object.
void	removeProperty(java.lang.String name) Removes a property from the set.
void	setDescription(java.lang.String description) Description of the locator.
void	setProperties(java.lang.Object names, java.lang.Object values) The values of the specified properties.
void	setProperty(java.lang.String name, java.lang.Object value) The value of the specified property.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericLocatorStyle

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

Constructs a GenericLocatorStyle using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GenericLocatorStyle

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a GenericLocatorStyle using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GenericLocatorStyle.
GenericLocatorStyle theGenericLocatorStyle = (GenericLocatorStyle) obj;

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

getAsILocator

public ILocator getAsILocator()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsILocatorStyle

public ILocatorStyle getAsILocatorStyle()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPropertySet

public IPropertySet getAsIPropertySet()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

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

Description copied from interface: ILocator

Name of the locator.

Supported Platforms

Windows, Solaris, Linux

Remarks

Locators and locator styles stored in an ArcSDE locator workspace are prefixed by the name of the ArcSDE user that owns the locator styles, as in "SDE.US Streets with Zone".

Specified by:

getName in interface ILocator

Returns:

The name

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDescription

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

Description copied from interface: ILocator

Description of the locator.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface ILocator

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 copied from interface: ILocator

Description of the locator.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDescription in interface ILocator

Parameters:

description - The description (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

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

Description copied from interface: ILocator

Category of the locator.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Category property returns a string indicating the category to which the locator belongs. There are two categories that are defined for locators provided with ArcGIS:

• Address - Locators that are used to geocode addresses
• RouteEvent - Locators that are used for linear referencing

Specified by:

getCategory in interface ILocator

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getUserInterface

public ILocatorUI getUserInterface()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: ILocator

User interface for the locator.

Supported Platforms

Windows, Solaris, Linux

Description

The UserInterface property returns an object that you can use to display the user interfaces for the locator.

Specified by:

getUserInterface in interface ILocator

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

Description copied from interface: IPropertySet

The number of properties contained in the property set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Count value will always be one when used with the XmlPropertySet CoClass. To determine the number of occurances of a metadata element use IXmlPropertySet::CountX

Specified by:

getCount in interface IPropertySet

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

com.esri.arcgis.geodatabase.IXmlPropertySet#, com.esri.arcgis.geodatabase.IXmlPropertySet2#

getProperty

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

Description copied from interface: IPropertySet

The value of the specified property.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Name parameter uses XSL Patterns to specify metadata elements. Additional information on XSL can be found in the the IXmlPropertySet documentation.

Specified by:

getProperty in interface IPropertySet

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.

See Also:

com.esri.arcgis.system.IPropertySet#getProperties(java.lang.Object, [Ljava.lang.Object;), com.esri.arcgis.system.IPropertySet#getAllProperties([Ljava.lang.Object;, [Ljava.lang.Object;)

getProperties

public void getProperties(java.lang.Object names,
                          java.lang.Object[] values)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IPropertySet

The values of the specified properties.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetProperties method returns values from a PropertySet CoClass.

The Name parameter for the GetProperties method uses XSL Patterns. More information is available through the IXmlPropertySet documentation.

Specified by:

getProperties in interface IPropertySet

Parameters:

names - A Variant (in)

values - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IPropertySet.getProperty(java.lang.String), com.esri.arcgis.system.IPropertySet#getAllProperties([Ljava.lang.Object;, [Ljava.lang.Object;)

getAllProperties

public void getAllProperties(java.lang.Object[] names,
                             java.lang.Object[] values)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IPropertySet

The name and value of all the properties in the property set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The GetAllProperties retrieves all names and values in the property set.

The Name parameter for the GetAllProperties method uses XSL Patterns. More information is available through the IXmlPropertySet documentation.

Specified by:

getAllProperties in interface IPropertySet

Parameters:

names - A Variant (out: use single element array)

values - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IPropertySet.getProperty(java.lang.String), com.esri.arcgis.system.IPropertySet#getProperties(java.lang.Object, [Ljava.lang.Object;)

setProperty

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

Description copied from interface: IPropertySet

The value of the specified property.

Specified by:

setProperty in interface IPropertySet

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setProperties

public void setProperties(java.lang.Object names,
                          java.lang.Object values)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IPropertySet

The values of the specified properties.

Specified by:

setProperties in interface IPropertySet

Parameters:

names - A Variant (in)

values - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IPropertySet propertySet)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPropertySet

True if the property set is the same as the input property set.

Specified by:

isEqual in interface IPropertySet

Parameters:

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

Returns:

The isEqual

Throws:

AutomationException - If the ArcObject component throws an exception.

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

removeProperty

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

Description copied from interface: IPropertySet

Removes a property from the set.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Name parameter uses XSL Patterns to specify metadata elements. Additional information on XSL can be found in the the IXmlPropertySet documentation.

If the Name parameter specifies an node that contains several elements, all sub-nodes will also be removed. In the image below setting the Name parameter equal to "metainfo/metc/cntinfo" will remove all the ESRI contact information between the highlighted elements.

Specified by:

removeProperty in interface IPropertySet

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

See Also:

IXmlPropertySet.deletePropertyByAttribute(java.lang.String, java.lang.String, boolean)

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

AutomationException - If the ArcObject component throws an exception.

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

interfaceSupportsErrorInfo

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

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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