com.esri.arcgis.carto
Interface IUniqueValueRenderer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IUniqueValueRendererProxy, UniqueValueRenderer

public interface IUniqueValueRenderer
extends java.io.Serializable

COM Interface 'IUniqueValueRenderer'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control a renderer where symbols are assigned to features based on unique attribute values.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDc3346d2a_b2bc_11d1_8817_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addReferenceValue(java.lang.String value, java.lang.String refValue) Adds a value to the renderer to be grouped with refValue, which has already been added to the renderer.
void	addValue(java.lang.String value, java.lang.String heading, ISymbol symbol) Adds a value and corresponding symbol to the list.
java.lang.String	getColorScheme() Color scheme (user interface property only).
java.lang.String	getDefaultLabel() Label used for unspecified values.
ISymbol	getDefaultSymbol() Symbol used to draw any unspecified values (may be NULL).
java.lang.String	getDescription(java.lang.String value) Desription for the specified label.
java.lang.String	getField(int index) Field at the specified index that is used to categorize features.
int	getFieldCount() Number of fields used by the renderer (0-3).
java.lang.String	getFieldDelimiter() Delimiter used to separate field values.
java.lang.String	getHeading(java.lang.String value) Heading that contains the specified value.
java.lang.String	getLabel(java.lang.String value) Label for the specified value.
java.lang.String	getLookupStyleset() Style used for matching (user interface property only).
java.lang.String	getReferenceValue(java.lang.String value) Reference value for the specified value.
ISymbol	getSymbol(java.lang.String value) Symbol associated with the specified value.
java.lang.String	getValue(int index) Value at the specified index.
int	getValueCount() Number of unique values used to categorize the data.
boolean	isUseDefaultSymbol() Indicates if DefaultSymbol is used for drawing unspecified values.
void	removeAllValues() Removes all values from the renderer.
void	removeValue(java.lang.String value) Removes a value from the renderer.
void	setColorScheme(java.lang.String name) Color scheme (user interface property only).
void	setDefaultLabel(java.lang.String label) Label used for unspecified values.
void	setDefaultSymbol(ISymbol symbol) Symbol used to draw any unspecified values (may be NULL).
void	setDescription(java.lang.String value, java.lang.String text) Desription for the specified label.
void	setField(int index, java.lang.String field) Field at the specified index that is used to categorize features.
void	setFieldCount(int fieldCount) Number of fields used by the renderer (0-3).
void	setFieldDelimiter(java.lang.String delimiter) Delimiter used to separate field values.
void	setFieldType(int index, boolean rhs2) Indicates if the field at the specified index is a string.
void	setHeading(java.lang.String value, java.lang.String heading) Heading that contains the specified value.
void	setLabel(java.lang.String value, java.lang.String label) Label for the specified value.
void	setLookupStyleset(java.lang.String name) Style used for matching (user interface property only).
void	setSymbol(java.lang.String value, ISymbol symbol) Symbol associated with the specified value.
void	setUseDefaultSymbol(boolean flag) Indicates if DefaultSymbol is used for drawing unspecified values.
void	setValue(int index, java.lang.String value) Value at the specified index.

Field Detail

IIDc3346d2a_b2bc_11d1_8817_080009ec732a

static final int IIDc3346d2a_b2bc_11d1_8817_080009ec732a

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getField

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

Field at the specified index that is used to categorize features.

Parameters:

index - The index (in)

Returns:

The field

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

void setField(int index,
              java.lang.String field)
              throws java.io.IOException,
                     AutomationException

Field at the specified index that is used to categorize features.

Parameters:

index - The index (in)

field - The field (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldType

void setFieldType(int index,
                  boolean rhs2)
                  throws java.io.IOException,
                         AutomationException

Indicates if the field at the specified index is a string.

Parameters:

index - The index (in)

rhs2 - The rhs2 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldDelimiter

java.lang.String getFieldDelimiter()
                                   throws java.io.IOException,
                                          AutomationException

Delimiter used to separate field values.

Returns:

The delimiter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldDelimiter

void setFieldDelimiter(java.lang.String delimiter)
                       throws java.io.IOException,
                              AutomationException

Delimiter used to separate field values.

Parameters:

delimiter - The delimiter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

int getFieldCount()
                  throws java.io.IOException,
                         AutomationException

Number of fields used by the renderer (0-3).

Returns:

The fieldCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldCount

void setFieldCount(int fieldCount)
                   throws java.io.IOException,
                          AutomationException

Number of fields used by the renderer (0-3).

Parameters:

fieldCount - The fieldCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSymbol

ISymbol getDefaultSymbol()
                         throws java.io.IOException,
                                AutomationException

Symbol used to draw any unspecified values (may be NULL).

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSymbol

void setDefaultSymbol(ISymbol symbol)
                      throws java.io.IOException,
                             AutomationException

Symbol used to draw any unspecified values (may be NULL).

Parameters:

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

java.lang.String getDefaultLabel()
                                 throws java.io.IOException,
                                        AutomationException

Label used for unspecified values.

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultLabel

void setDefaultLabel(java.lang.String label)
                     throws java.io.IOException,
                            AutomationException

Label used for unspecified values.

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseDefaultSymbol

boolean isUseDefaultSymbol()
                           throws java.io.IOException,
                                  AutomationException

Indicates if DefaultSymbol is used for drawing unspecified values.

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseDefaultSymbol

void setUseDefaultSymbol(boolean flag)
                         throws java.io.IOException,
                                AutomationException

Indicates if DefaultSymbol is used for drawing unspecified values.

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValueCount

int getValueCount()
                  throws java.io.IOException,
                         AutomationException

Number of unique values used to categorize the data.

Returns:

The valueCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

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

Value at the specified index.

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

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

Value at the specified index.

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.

getReferenceValue

java.lang.String getReferenceValue(java.lang.String value)
                                   throws java.io.IOException,
                                          AutomationException

Reference value for the specified value.

Parameters:

value - The value (in)

Returns:

The refValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addReferenceValue

void addReferenceValue(java.lang.String value,
                       java.lang.String refValue)
                       throws java.io.IOException,
                              AutomationException

Adds a value to the renderer to be grouped with refValue, which has already been added to the renderer.

Parameters:

value - The value (in)

refValue - The refValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbol

ISymbol getSymbol(java.lang.String value)
                  throws java.io.IOException,
                         AutomationException

Symbol associated with the specified value.

Parameters:

value - The value (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(java.lang.String value,
               ISymbol symbol)
               throws java.io.IOException,
                      AutomationException

Symbol associated with the specified value.

Parameters:

value - The value (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabel

java.lang.String getLabel(java.lang.String value)
                          throws java.io.IOException,
                                 AutomationException

Label for the specified value.

Parameters:

value - The value (in)

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabel

void setLabel(java.lang.String value,
              java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Label for the specified value.

Parameters:

value - The value (in)

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Desription for the specified label.

Parameters:

value - The value (in)

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String value,
                    java.lang.String text)
                    throws java.io.IOException,
                           AutomationException

Desription for the specified label.

Parameters:

value - The value (in)

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

java.lang.String getHeading(java.lang.String value)
                            throws java.io.IOException,
                                   AutomationException

Heading that contains the specified value.

Parameters:

value - The value (in)

Returns:

The heading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

void setHeading(java.lang.String value,
                java.lang.String heading)
                throws java.io.IOException,
                       AutomationException

Heading that contains the specified value.

Parameters:

value - The value (in)

heading - The heading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addValue

void addValue(java.lang.String value,
              java.lang.String heading,
              ISymbol symbol)
              throws java.io.IOException,
                     AutomationException

Adds a value and corresponding symbol to the list. For multivariate cases, the specified value is a delimitted list of individual values.

Parameters:

value - The value (in)

heading - The heading (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeValue

void removeValue(java.lang.String value)
                 throws java.io.IOException,
                        AutomationException

Removes a value from the renderer.

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllValues

void removeAllValues()
                     throws java.io.IOException,
                            AutomationException

Removes all values from the renderer.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorScheme

java.lang.String getColorScheme()
                                throws java.io.IOException,
                                       AutomationException

Color scheme (user interface property only).

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorScheme

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

Color scheme (user interface property only).

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLookupStyleset

java.lang.String getLookupStyleset()
                                   throws java.io.IOException,
                                          AutomationException

Style used for matching (user interface property only).

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLookupStyleset

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

Style used for matching (user interface property only).

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.