com.esri.arcgis.carto
Class ACValueMapRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.ACValueMapRenderer
All Implemented Interfaces:
IACAxl, IACRenderer, IACValueMapRenderer, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class ACValueMapRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IACAxl, IACRenderer, IACValueMapRenderer, IPersist, IPersistStream, IClone, Externalizable

ArcIMS Value Map Renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
ACValueMapRenderer()
          Constructs a ACValueMapRenderer using ArcGIS Engine.
ACValueMapRenderer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ACValueMapRenderer theACValueMapRenderer = (ACValueMapRenderer) obj;
 
Method Summary
 void add(IACSymbol symbol, int range, String value, String label, String lower, String upper)
          Adds a value and corresponding symbol to the list.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clear()
          Clears all values.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          Number of unique values used to categorize the data.
 Object getElement()
          The element that represents the XML.
 String getLabel(int index)
          Label for the specified value.
 String getLookupField()
          Field name that is used to categorize features.
 String getLower(int index)
          The lower value of the range.
 int getRangeType(int index)
          The type of categorization for the values within the specified field.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IACSymbol getSymbol(int index)
          Symbol associated with the specified value.
 String getUpper(int index)
          The upper value of the range.
 String getValue(int index)
          The unique value for the specified field.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void remove(int index)
          Removes a value.
 void save(IStream pstm, int fClearDirty)
          save
 void setElementByRef(Object element)
          The element that represents the XML.
 void setLabel(int index, String label)
          Label for the specified value.
 void setLookupField(String lookupField)
          Field name that is used to categorize features.
 void setLower(int index, String value)
          The lower value of the range.
 void setRangeType(int index, int range)
          The type of categorization for the values within the specified field.
 void setSymbol(int index, IACSymbol symbol)
          Symbol associated with the specified value.
 void setUpper(int index, String value)
          The upper value of the range.
 void setValue(int index, String value)
          The unique value for the specified field.
 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

ACValueMapRenderer

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

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

ACValueMapRenderer

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

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

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

getElement

public Object getElement()
                  throws IOException,
                         AutomationException
The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getElement in interface IACAxl
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(Object element)
                     throws IOException,
                            AutomationException
The element that represents the XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setElementByRef in interface IACAxl
Parameters:
element - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLookupField

public String getLookupField()
                      throws IOException,
                             AutomationException
Field name that is used to categorize features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLookupField in interface IACValueMapRenderer
Returns:
The lookupField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLookupField

public void setLookupField(String lookupField)
                    throws IOException,
                           AutomationException
Field name that is used to categorize features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of unique values used to categorize the data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IACValueMapRenderer
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

public IACSymbol getSymbol(int index)
                    throws IOException,
                           AutomationException
Symbol associated with the specified value.

Product Availability

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

Specified by:
getSymbol in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.carto.IACSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(int index,
                      IACSymbol symbol)
               throws IOException,
                      AutomationException
Symbol associated with the specified value.

Product Availability

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

Specified by:
setSymbol in interface IACValueMapRenderer
Parameters:
index - The index (in)
symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRangeType

public int getRangeType(int index)
                 throws IOException,
                        AutomationException
The type of categorization for the values within the specified field.

Product Availability

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

Specified by:
getRangeType in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.carto.acRangeType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRangeType

public void setRangeType(int index,
                         int range)
                  throws IOException,
                         AutomationException
The type of categorization for the values within the specified field.

Product Availability

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

Specified by:
setRangeType in interface IACValueMapRenderer
Parameters:
index - The index (in)
range - A com.esri.arcgis.carto.acRangeType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValue

public String getValue(int index)
                throws IOException,
                       AutomationException
The unique value for the specified field.

Product Availability

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

Specified by:
getValue in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     String value)
              throws IOException,
                     AutomationException
The unique value for the specified field.

Product Availability

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

Specified by:
setValue in interface IACValueMapRenderer
Parameters:
index - The index (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel(int index)
                throws IOException,
                       AutomationException
Label for the specified value.

Product Availability

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

Specified by:
getLabel in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(int index,
                     String label)
              throws IOException,
                     AutomationException
Label for the specified value.

Product Availability

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

Specified by:
setLabel in interface IACValueMapRenderer
Parameters:
index - The index (in)
label - The label (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUpper

public String getUpper(int index)
                throws IOException,
                       AutomationException
The upper value of the range.

Product Availability

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

Specified by:
getUpper in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpper

public void setUpper(int index,
                     String value)
              throws IOException,
                     AutomationException
The upper value of the range.

Product Availability

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

Specified by:
setUpper in interface IACValueMapRenderer
Parameters:
index - The index (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLower

public String getLower(int index)
                throws IOException,
                       AutomationException
The lower value of the range.

Product Availability

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

Specified by:
getLower in interface IACValueMapRenderer
Parameters:
index - The index (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLower

public void setLower(int index,
                     String value)
              throws IOException,
                     AutomationException
The lower value of the range.

Product Availability

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

Specified by:
setLower in interface IACValueMapRenderer
Parameters:
index - The index (in)
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IACSymbol symbol,
                int range,
                String value,
                String label,
                String lower,
                String upper)
         throws IOException,
                AutomationException
Adds a value and corresponding symbol to the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
add in interface IACValueMapRenderer
Parameters:
symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)
range - A com.esri.arcgis.carto.acRangeType constant (in)
value - The value (in)
label - The label (in)
lower - The lower (in)
upper - The upper (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException
Clears all values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
clear in interface IACValueMapRenderer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws IOException,
                   AutomationException
Removes a value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
remove in interface IACValueMapRenderer
Parameters:
index - The index (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.

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.

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