com.esri.arcgis.location
Class GenericLocatorStyle

java.lang.Object
  extended by com.esri.arcgis.location.GenericLocatorStyle
All Implemented Interfaces:
ILocator, ILocatorStyle, com.esri.arcgis.interop.RemoteObjRef, IClone, IPropertySet, ISupportErrorInfo, Serializable

public class GenericLocatorStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, 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(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GenericLocatorStyle theGenericLocatorStyle = (GenericLocatorStyle) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getAllProperties(Object[] names, Object[] values)
          The name and value of all the properties in the property set.
 String getCategory()
          Category of the locator.
static String getClsid()
          getClsid.
 int getCount()
          The number of properties contained in the property set.
 String getDescription()
          Description of the locator.
 String getName()
          Name of the locator.
 void getProperties(Object names, Object[] values)
          The values of the specified properties.
 Object getProperty(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)
          interfaceSupportsErrorInfo
 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(String name)
          Removes a property from the set.
 void setDescription(String description)
          Description of the locator.
 void setProperties(Object names, Object values)
          The values of the specified properties.
 void setProperty(String name, Object value)
          The value of the specified property.
 
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

GenericLocatorStyle

public GenericLocatorStyle()
                    throws IOException,
                           UnknownHostException
Constructs a GenericLocatorStyle using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GenericLocatorStyle

public GenericLocatorStyle(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GenericLocatorStyle theGenericLocatorStyle = (GenericLocatorStyle) obj;

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.

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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the locator.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface ILocator
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Description of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface ILocator
Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String description)
                    throws IOException,
                           AutomationException
Description of the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDescription in interface ILocator
Parameters:
description - The description (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
Category of the locator.

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:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCategory in interface ILocator
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserInterface

public ILocatorUI getUserInterface()
                            throws IOException,
                                   AutomationException
User interface for the locator.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUserInterface in interface ILocator
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocatorUI
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of properties contained in the property set.

Remarks

The Count value will always be one when used with the esriGeodatabase.XmlPropertySet coclass. For more information, see the remarks for the XmlPropertySet coclass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IPropertySet
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.system.IXmlPropertySet, com.esri.arcgis.system.IXmlPropertySet2

getProperty

public Object getProperty(String name)
                   throws IOException,
                          AutomationException
The value of the specified property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getProperty in interface IPropertySet
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPropertySet.getProperties(java.lang.Object, Object[]), IPropertySet.getAllProperties(Object[], Object[])

getProperties

public void getProperties(Object names,
                          Object[] values)
                   throws IOException,
                          AutomationException
The values of the specified properties.

Remarks

The GetProperties method returns values from a PropertySet CoClass.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getProperties in interface IPropertySet
Parameters:
names - A Variant (in)
values - A Variant (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPropertySet.getAllProperties(Object[], Object[]), IPropertySet.getProperty(String)

getAllProperties

public void getAllProperties(Object[] names,
                             Object[] values)
                      throws IOException,
                             AutomationException
The name and value of all the properties in the property set.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAllProperties in interface IPropertySet
Parameters:
names - A Variant (out: use single element array)
values - A Variant (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPropertySet.getProperties(java.lang.Object, Object[]), IPropertySet.getProperty(String)

setProperty

public void setProperty(String name,
                        Object value)
                 throws IOException,
                        AutomationException
The value of the specified property.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setProperty in interface IPropertySet
Parameters:
name - The name (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.system.IXmlPropertySet, com.esri.arcgis.system.IXmlPropertySet2, IPropertySet.setProperties(java.lang.Object, java.lang.Object)

setProperties

public void setProperties(Object names,
                          Object values)
                   throws IOException,
                          AutomationException
The values of the specified properties.

Remarks

Using the Name parameter to locate the specified element, the SetProperties method populates the elements, or adds an new element if it already exists, and sets the value to the coorseponding Values parameter.

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

esriXmlSetPropertyAction constants are NOT available to handle situations where an element value already exists. Upon encountering elements that already have values, the new values will replace or add values to existing elements. For more control dealing with elements the IXmlPropertySet::SetPropertyX should be used.

In order to populated nodes further along in the Xml tree, nodes necessary to navigate must first be established. For instance in order to populate the "idinfo/ptcontact/cntinfo/cntperp/cntorg" node each subsequent nodes, "idinfo", "idinfo/ptcontact", "idinfo/ptcontact/cntinfo" and "idinfo/ptcontact/cntinfo/cntperp" must already be in place.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setProperties in interface IPropertySet
Parameters:
names - A Variant (in)
values - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IPropertySet.setProperty(String, java.lang.Object), com.esri.arcgis.system.IXmlPropertySet,

This method is not interop compliant and hence unsupported in Java. Use setProperty() instead.


isEqual

public boolean isEqual(IPropertySet propertySet)
                throws IOException,
                       AutomationException
True if the property set is the same as the input property set.

Remarks

This method indicates whether two property sets are equal.

Note that it will always return false if the property set is an esriGeodatabase.XmlPropertySet (for metadata). See the XmlPropertySet coclass' documentation for more information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IPropertySet
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:
The isEqual
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeProperty

public void removeProperty(String name)
                    throws IOException,
                           AutomationException
Removes a property from the set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
removeProperty in interface IPropertySet
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.system.IXmlPropertySet

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.