|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.core.internal.value.ClassificationDef com.esri.core.internal.value.ClassBreaksDefinition
public class ClassBreaksDefinition
This class defines a class breaks renderer when requesting a renderer from a dynamic map service's generateDataClasses REST endpoint.
A class breaks renderer is defined by a classification method and field and number of class breaks desired. Optionally a normalization type can also be set. The user can also specify an optional base symbol and color ramp to be used by the renderer. If theStdDeviation
classification method is used, a standard
deviation interval can be set. If the ByField
normalization type
is used, the normalization field should also be specified.
Nested Class Summary | |
---|---|
static class |
ClassBreaksDefinition.ClassificationMethod
The ClassificationMethod to be used by the server when determining class breaks. |
Field Summary | |
---|---|
static float |
HALF
Standard deviation interval of 0.5 |
static float |
ONE
Standard deviation interval of 1.0 |
static float |
QUARTER
Standard deviation interval of 0.25 |
static float |
THIRD
Standard deviation interval of 0.33 |
Fields inherited from class com.esri.core.internal.value.ClassificationDef |
---|
_type |
Constructor Summary | |
---|---|
|
ClassBreaksDefinition(org.codehaus.jackson.JsonNode node)
Instantiates a new class breaks definition from the given JSON node. |
protected |
ClassBreaksDefinition(String classificationField,
ClassBreaksDefinition.ClassificationMethod classificationMethod,
int breakCount,
float stdDeviationInterval,
NormalizationType normalizationType,
String normalizationField)
Instantiates a new class breaks definition. |
Method Summary | |
---|---|
static ClassBreaksDefinition |
createByClassificationMethod(String classificationField,
ClassBreaksDefinition.ClassificationMethod classificationMethod,
int breakCount)
Create a new ClassBreaksDefinition instance with the given classification field and method and desired number of breaks. |
static ClassBreaksDefinition |
createByNormalizationMethod(String classificationField,
ClassBreaksDefinition.ClassificationMethod classificationMethod,
int breakCount,
NormalizationType normalizationType)
Create a new ClassBreaksDefinition instance with the given classification field and method, desired number of breaks and normalization method. |
static ClassBreaksDefinition |
createByStdDeviation(String classificationField,
float stdDeviationInterval)
Create a new ClassBreaksDefinition instance with classification by standard deviation with the given classification field, desired number of breaks and standard deviation interval. |
static ClassBreaksDefinition |
createWithNormalizeByField(String classificationField,
ClassBreaksDefinition.ClassificationMethod classificationMethod,
int breakCount,
String normalizationField)
Create a new ClassBreaksDefinition instance with the given classification field and method, desired number of breaks and normalizing by a given field. |
int |
getBreakCount()
Gets the break count. |
String |
getClassificationField()
Gets the classification field. |
ClassBreaksDefinition.ClassificationMethod |
getClassificationMethod()
Gets the classification method. |
String |
getNormalizationField()
Gets the normalization field. |
NormalizationType |
getNormalizationType()
Gets the normalization type. |
float |
getStdDevInterval()
Gets the standard deviation interval. |
void |
setBreakCount(int breakCount)
Sets the break count. |
void |
setClassificationField(String classificationField)
Sets the classification field. |
void |
setClassificationMethod(ClassBreaksDefinition.ClassificationMethod classificationMethod)
Sets the classification method. |
void |
setNormalizationField(String normalizationField)
Sets the normalization field. |
void |
setNormalizationType(NormalizationType normalizationType)
Sets the normalization type. |
void |
setStdDevInterval(float stdDevInterval)
Sets the standard deviation interval. |
protected void |
toJson(org.codehaus.jackson.JsonGenerator node)
This method is used by ClassificationDef.toJson() to turn this instance
into a JSON string. |
Methods inherited from class com.esri.core.internal.value.ClassificationDef |
---|
getBaseSymbol, getColorRamp, setBaseSymbol, setColorRamp, toJson |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final float ONE
public static final float HALF
public static final float THIRD
public static final float QUARTER
Constructor Detail |
---|
protected ClassBreaksDefinition(String classificationField, ClassBreaksDefinition.ClassificationMethod classificationMethod, int breakCount, float stdDeviationInterval, NormalizationType normalizationType, String normalizationField)
classificationField
- the classification fieldclassificationMethod
- the classification methodbreakCount
- the break countstdDeviationInterval
- the standard deviation intervalnormalizationType
- the normalization typenormalizationField
- the normalization fieldpublic ClassBreaksDefinition(org.codehaus.jackson.JsonNode node)
node
- the node defining a class breaks definitionMethod Detail |
---|
public static ClassBreaksDefinition createByClassificationMethod(String classificationField, ClassBreaksDefinition.ClassificationMethod classificationMethod, int breakCount)
setStdDevInterval(float)
method or use
#createByStdDeviation(String, int, float)
.
classificationField
- the classification fieldclassificationMethod
- the classification methodbreakCount
- the break count
public static ClassBreaksDefinition createByStdDeviation(String classificationField, float stdDeviationInterval)
classificationField
- the classification fieldbreakCount
- the break countstdDeviationInterval
- the std deviation interval
public static ClassBreaksDefinition createByNormalizationMethod(String classificationField, ClassBreaksDefinition.ClassificationMethod classificationMethod, int breakCount, NormalizationType normalizationType)
setNormalizationField(String)
method or use
createWithNormalizeByField(String, ClassificationMethod, int, String)
classificationField
- the classification fieldclassificationMethod
- the classification methodbreakCount
- the break countnormalizationType
- the normalization type
public static ClassBreaksDefinition createWithNormalizeByField(String classificationField, ClassBreaksDefinition.ClassificationMethod classificationMethod, int breakCount, String normalizationField)
classificationField
- the classification fieldclassificationMethod
- the classification methodbreakCount
- the break countnormalizationField
- the normalization field
public void setClassificationField(String classificationField)
classificationField
- the new classification fieldpublic String getClassificationField()
public void setClassificationMethod(ClassBreaksDefinition.ClassificationMethod classificationMethod)
classificationMethod
- the new classification methodClassBreaksDefinition.ClassificationMethod
public ClassBreaksDefinition.ClassificationMethod getClassificationMethod()
public void setBreakCount(int breakCount)
breakCount
- the new break countpublic int getBreakCount()
public void setStdDevInterval(float stdDevInterval)
stdDevInterval
- the new standard deviation intervalpublic float getStdDevInterval()
public void setNormalizationField(String normalizationField)
normalizationField
- the new normalization fieldpublic String getNormalizationField()
public void setNormalizationType(NormalizationType normalizationType)
normalizationType
- the new normalization typeNormalizationType
public NormalizationType getNormalizationType()
protected void toJson(org.codehaus.jackson.JsonGenerator node) throws IOException, org.codehaus.jackson.JsonGenerationException, Exception
ClassificationDef
ClassificationDef.toJson()
to turn this instance
into a JSON string.
This method should be overridden in subclasses to add their class
data to the given JSON node. Note that this base class method should
be called by the override.
toJson
in class ClassificationDef
node
- the node to add fields to
IOException
- Signals that an I/O exception has occurred.
org.codehaus.jackson.JsonGenerationException
- the json generation exception
Exception
- the exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |