com.esri.arcgis.carto
Class ACValueMapRenderer

java.lang.Object
  com.esri.arcgis.carto.ACValueMapRenderer

All Implemented Interfaces:

IACAxl, IACRenderer, IACValueMapRenderer, IClone, IPersist, IPersistStream, java.io.Serializable

public class ACValueMapRenderer

extends java.lang.Object

implements IACAxl, IACRenderer, IACValueMapRenderer, IPersist, IPersistStream, IClone

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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	add(IACSymbol symbol, int range, java.lang.String value, java.lang.String label, java.lang.String lower, java.lang.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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
IACAxl	getAsIACAxl() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACRenderer	getAsIACRenderer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IACValueMapRenderer	getAsIACValueMapRenderer() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
int	getCount() Number of unique values used to categorize the data.
java.lang.Object	getElement() The element that represents the XML.
java.lang.String	getLabel(int index) Label for the specified value.
java.lang.String	getLookupField() Field name that is used to categorize features.
java.lang.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) Supported Platforms
IACSymbol	getSymbol(int index) Symbol associated with the specified value.
java.lang.String	getUpper(int index) The upper value of the range.
java.lang.String	getValue(int index) The unique value for the specified field.
int	hashCode() the hashcode for this object
void	isDirty() Supported Platforms
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) Supported Platforms
void	remove(int index) Removes a value.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setElementByRef(java.lang.Object element) The element that represents the XML.
void	setLabel(int index, java.lang.String label) Label for the specified value.
void	setLookupField(java.lang.String lookupField) Field name that is used to categorize features.
void	setLower(int index, java.lang.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, java.lang.String value) The upper value of the range.
void	setValue(int index, java.lang.String value) The unique value for the specified field.

Methods inherited from class java.lang.Object

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

Constructor Detail

ACValueMapRenderer

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

Constructs a ACValueMapRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ACValueMapRenderer

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

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

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.
ACValueMapRenderer theACValueMapRenderer = (ACValueMapRenderer) 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()

getAsIACAxl

public IACAxl getAsIACAxl()

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

getAsIACRenderer

public IACRenderer getAsIACRenderer()

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

getAsIACValueMapRenderer

public IACValueMapRenderer getAsIACValueMapRenderer()

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

getAsIPersist

public IPersist getAsIPersist()

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

getAsIPersistStream

public IPersistStream getAsIPersistStream()

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.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getElement

public java.lang.Object getElement()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getElement in interface IACAxl

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setElementByRef

public void setElementByRef(java.lang.Object element)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IACAxl

The element that represents the XML.

Specified by:

setElementByRef in interface IACAxl

Parameters:

element - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLookupField

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

Description copied from interface: IACValueMapRenderer

Field name that is used to categorize features.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLookupField in interface IACValueMapRenderer

Returns:

The lookupField

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLookupField

public void setLookupField(java.lang.String lookupField)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACValueMapRenderer

Field name that is used to categorize features.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLookupField in interface IACValueMapRenderer

Parameters:

lookupField - The lookupField (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCount

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

Description copied from interface: IACValueMapRenderer

Number of unique values used to categorize the data.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IACValueMapRenderer

Returns:

The count

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSymbol

public IACSymbol getSymbol(int index)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IACValueMapRenderer

Symbol associated with the specified value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSymbol in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.IACSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(int index,
                      IACSymbol symbol)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IACValueMapRenderer

Symbol associated with the specified value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbol in interface IACValueMapRenderer

Parameters:

index - The index (in)

symbol - A reference to a com.esri.arcgis.carto.IACSymbol (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getRangeType

public int getRangeType(int index)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IACValueMapRenderer

The type of categorization for the values within the specified field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRangeType in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

A com.esri.arcgis.carto.acRangeType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRangeType

public void setRangeType(int index,
                         int range)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IACValueMapRenderer

The type of categorization for the values within the specified field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRangeType in interface IACValueMapRenderer

Parameters:

index - The index (in)

range - A com.esri.arcgis.carto.acRangeType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.String getValue(int index)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACValueMapRenderer

The unique value for the specified field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getValue in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValue

public void setValue(int index,
                     java.lang.String value)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACValueMapRenderer

The unique value for the specified field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setValue in interface IACValueMapRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel(int index)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACValueMapRenderer

Label for the specified value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLabel in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

The label

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setLabel

public void setLabel(int index,
                     java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACValueMapRenderer

Label for the specified value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLabel in interface IACValueMapRenderer

Parameters:

index - The index (in)

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUpper

public java.lang.String getUpper(int index)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACValueMapRenderer

The upper value of the range.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getUpper in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setUpper

public void setUpper(int index,
                     java.lang.String value)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACValueMapRenderer

The upper value of the range.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUpper in interface IACValueMapRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLower

public java.lang.String getLower(int index)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IACValueMapRenderer

The lower value of the range.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLower in interface IACValueMapRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLower

public void setLower(int index,
                     java.lang.String value)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IACValueMapRenderer

The lower value of the range.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLower in interface IACValueMapRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

add

public void add(IACSymbol symbol,
                int range,
                java.lang.String value,
                java.lang.String label,
                java.lang.String lower,
                java.lang.String upper)
         throws java.io.IOException,
                AutomationException

Description copied from interface: IACValueMapRenderer

Adds a value and corresponding symbol to the list.

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:

AutomationException - If the ArcObject component throws an exception.

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

clear

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

Description copied from interface: IACValueMapRenderer

Clears all values.

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IACValueMapRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(int index)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IACValueMapRenderer

Removes a value.

Supported Platforms

Windows, Solaris, Linux

Specified by:

remove in interface IACValueMapRenderer

Parameters:

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

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.