CIMLabelClass (ArcObjects Java API)

java.lang.Object
- com.esri.arcgis.cartox.cim.CIMObject
- - com.esri.arcgis.cartox.cim.CIMLabelClass

```
public class CIMLabelClass
extends CIMObject
```
Represents a label class which describes how to generate a set of text labels from a group of features in a feature layer.

Constructor Summary

Constructors
Constructor and Description

CIMLabelClass()

Constructors
Constructor and Description
`CIMLabelClass()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deserialize(JSONObject jsonObject)` Deserializes this object from its JSON representation.
`static CIMLabelClass`	`fromJSON(java.lang.String json)` Creates the object with a specified state from a JSON encoding.
`java.lang.String`	`getExpression()` Gets the label expression.
`LabelExpressionEngine`	`getExpressionEngine()` Gets the label expression engine (the language the expression is written in).
`java.lang.String`	`getExpressionTitle()` Gets the human readable text title that describes the label expression.
`FeaturesToLabel`	`getFeaturesToLabel()` Gets a parameter indicating which features to label.
`int`	`getID()` Gets the ID of the label class.
`CIMMaplexLabelPlacementProperties`	`getMaplexLabelPlacementProperties()` Gets the Maplex placement properties which are used when the map uses the Maplex label engine.
`double`	`getMaximumScale()` Gets the maximum scale for labeling (set as the denominator of the scale's representative fraction).
`double`	`getMinimumScale()` Gets the minimum scale for labeling (set as the denominator of the scale's representative fraction).
`java.lang.String`	`getName()` Gets the name of the label class.
`int`	`getPriority()` Gets the priority of the label class.
`CIMStandardLabelPlacementProperties`	`getStandardLabelPlacementProperties()` Gets the standard placement properties which are used when the map uses the standard label engine.
`CIMSymbolReference`	`getTextSymbol()` Gets the text symbol of the label class.
`boolean`	`getUseCodedValue()` Gets a value indicating whether or not to use coded value domain descriptions when labeling.
`boolean`	`getVisibility()` Gets a value indicating whether this label class is visible.
`java.lang.String`	`getWhereClause()` Gets the SQL where clause of which features to label with this label class.
`void`	`serialize(JSONObject jsonObject)` Serializes this object to its JSON representation.
`void`	`setExpression(java.lang.String expression)` Sets the label expression.
`void`	`setExpressionEngine(LabelExpressionEngine expressionEngine)` Sets the label expression engine (the language the expression is written in).
`void`	`setExpressionTitle(java.lang.String expressionTitle)` Sets the human readable text title that describes the label expression.
`void`	`setFeaturesToLabel(FeaturesToLabel featuresToLabel)` Sets a parameter indicating which features to label.
`void`	`setID(int iD)` Sets the ID of the label class.
`void`	`setMaplexLabelPlacementProperties(CIMMaplexLabelPlacementProperties maplexLabelPlacementProperties)` Sets the Maplex placement properties which are used when the map uses the Maplex label engine.
`void`	`setMaximumScale(double maximumScale)` Sets the maximum scale for labeling (set as the denominator of the scale's representative fraction).
`void`	`setMinimumScale(double minimumScale)` Sets the minimum scale for labeling (set as the denominator of the scale's representative fraction).
`void`	`setName(java.lang.String name)` Sets the name of the label class.
`void`	`setPriority(int priority)` Sets the priority of the label class.
`void`	`setStandardLabelPlacementProperties(CIMStandardLabelPlacementProperties standardLabelPlacementProperties)` Sets the standard placement properties which are used when the map uses the standard label engine.
`void`	`setTextSymbol(CIMSymbolReference textSymbol)` Sets the text symbol of the label class.
`void`	`setUseCodedValue(boolean useCodedValue)` Sets a value indicating whether or not to use coded value domain descriptions when labeling.
`void`	`setVisibility(boolean visibility)` Sets a value indicating whether this label class is visible.
`void`	`setWhereClause(java.lang.String whereClause)` Sets the SQL where clause of which features to label with this label class.
`java.lang.String`	`toJSON()` Creates a JSON encoding of the object and its current state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CIMLabelClass
```
public CIMLabelClass()
```
- Method Detail
  - getExpressionTitle
```
public java.lang.String getExpressionTitle()
```
    Gets the human readable text title that describes the label expression.
  - setExpressionTitle
```
public void setExpressionTitle(java.lang.String expressionTitle)
```
    Sets the human readable text title that describes the label expression.
  - getExpression
```
public java.lang.String getExpression()
```
    Gets the label expression.
  - setExpression
```
public void setExpression(java.lang.String expression)
```
    Sets the label expression.
  - getExpressionEngine
```
public LabelExpressionEngine getExpressionEngine()
```
    Gets the label expression engine (the language the expression is written in).
  - setExpressionEngine
```
public void setExpressionEngine(LabelExpressionEngine expressionEngine)
```
    Sets the label expression engine (the language the expression is written in).
  - getFeaturesToLabel
```
public FeaturesToLabel getFeaturesToLabel()
```
    Gets a parameter indicating which features to label.
  - setFeaturesToLabel
```
public void setFeaturesToLabel(FeaturesToLabel featuresToLabel)
```
    Sets a parameter indicating which features to label.
  - getMaplexLabelPlacementProperties
```
public CIMMaplexLabelPlacementProperties getMaplexLabelPlacementProperties()
```
    Gets the Maplex placement properties which are used when the map uses the Maplex label engine.
  - setMaplexLabelPlacementProperties
```
public void setMaplexLabelPlacementProperties(CIMMaplexLabelPlacementProperties maplexLabelPlacementProperties)
```
    Sets the Maplex placement properties which are used when the map uses the Maplex label engine.
  - getMaximumScale
```
public double getMaximumScale()
```
    Gets the maximum scale for labeling (set as the denominator of the scale's representative fraction).
  - setMaximumScale
```
public void setMaximumScale(double maximumScale)
```
    Sets the maximum scale for labeling (set as the denominator of the scale's representative fraction).
  - getMinimumScale
```
public double getMinimumScale()
```
    Gets the minimum scale for labeling (set as the denominator of the scale's representative fraction).
  - setMinimumScale
```
public void setMinimumScale(double minimumScale)
```
    Sets the minimum scale for labeling (set as the denominator of the scale's representative fraction).
  - getName
```
public java.lang.String getName()
```
    Gets the name of the label class.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of the label class.
  - getPriority
```
public int getPriority()
```
    Gets the priority of the label class.
  - setPriority
```
public void setPriority(int priority)
```
    Sets the priority of the label class.
  - getStandardLabelPlacementProperties
```
public CIMStandardLabelPlacementProperties getStandardLabelPlacementProperties()
```
    Gets the standard placement properties which are used when the map uses the standard label engine.
  - setStandardLabelPlacementProperties
```
public void setStandardLabelPlacementProperties(CIMStandardLabelPlacementProperties standardLabelPlacementProperties)
```
    Sets the standard placement properties which are used when the map uses the standard label engine.
  - getTextSymbol
```
public CIMSymbolReference getTextSymbol()
```
    Gets the text symbol of the label class.
  - setTextSymbol
```
public void setTextSymbol(CIMSymbolReference textSymbol)
```
    Sets the text symbol of the label class.
  - getUseCodedValue
```
public boolean getUseCodedValue()
```
    Gets a value indicating whether or not to use coded value domain descriptions when labeling.
  - setUseCodedValue
```
public void setUseCodedValue(boolean useCodedValue)
```
    Sets a value indicating whether or not to use coded value domain descriptions when labeling.
  - getWhereClause
```
public java.lang.String getWhereClause()
```
    Gets the SQL where clause of which features to label with this label class.
  - setWhereClause
```
public void setWhereClause(java.lang.String whereClause)
```
    Sets the SQL where clause of which features to label with this label class.
  - getVisibility
```
public boolean getVisibility()
```
    Gets a value indicating whether this label class is visible.
  - setVisibility
```
public void setVisibility(boolean visibility)
```
    Sets a value indicating whether this label class is visible.
  - getID
```
public int getID()
```
    Gets the ID of the label class. This property is only used in the context of annotation.
  - setID
```
public void setID(int iD)
```
    Sets the ID of the label class. This property is only used in the context of annotation.
  - fromJSON
```
public static CIMLabelClass fromJSON(java.lang.String json)
                              throws CIMJSONException
```
    Creates the object with a specified state from a JSON encoding.
    
    Throws:
    
    CIMJSONException
  - toJSON
```
public java.lang.String toJSON()
```
    Creates a JSON encoding of the object and its current state.
    
    Specified by:
    
    toJSON in class CIMObject
  - deserialize
```
public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException
```
    Deserializes this object from its JSON representation.
    
    Overrides:
    
    deserialize in class CIMObject
    
    Throws:
    
    CIMJSONException
  - serialize
```
public void serialize(JSONObject jsonObject)
```
    Serializes this object to its JSON representation.
    
    Overrides:
    
    serialize in class CIMObject

Class CIMLabelClass

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CIMLabelClass

Method Detail

getExpressionTitle

setExpressionTitle

getExpression

setExpression

getExpressionEngine

setExpressionEngine

getFeaturesToLabel

setFeaturesToLabel

getMaplexLabelPlacementProperties

setMaplexLabelPlacementProperties

getMaximumScale

setMaximumScale

getMinimumScale

setMinimumScale

getName

setName

getPriority

setPriority

getStandardLabelPlacementProperties

setStandardLabelPlacementProperties

getTextSymbol

setTextSymbol

getUseCodedValue

setUseCodedValue

getWhereClause

setWhereClause

getVisibility

setVisibility

getID

setID

fromJSON

toJSON

deserialize

serialize