edu.ucdavis.cstars.client.tasks

Class ClassBreaksDefinition

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.tasks.ClassificationDefinition

edu.ucdavis.cstars.client.tasks.ClassBreaksDefinition

public class ClassBreaksDefinition
extends ClassificationDefinition

Class added v2.6 Define a class breaks classification scheme used by the GenerateDataTask to generate classes. Class breaks renderers symbolize data based on the value of a numeric attribute. Data with similar values for the attribute use the same symbol.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassBreaksDefinition.ClassificationMethod
static class	ClassBreaksDefinition.NormalizationType
static class	ClassBreaksDefinition.StandardDeviationInterval

Nested classes/interfaces inherited from class edu.ucdavis.cstars.client.tasks.ClassificationDefinition

ClassificationDefinition.Type

Method Summary

Methods

Modifier and Type	Method and Description
static ClassBreaksDefinition	create() Creates a new ClassBreaksDefinition object
int	getBreakCount() The number of class breaks.
java.lang.String	getClassificationField() The name of the field used to match values.
ClassBreaksDefinition.ClassificationMethod	getClassificationMethod() The name of the classification method.
java.lang.String	getNormalizationField() The name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'.
ClassBreaksDefinition.NormalizationType	getNormalizationType() The type of normalization used to normalize class breaks.
ClassBreaksDefinition.StandardDeviationInterval	getStandardDeviationInterval() The standard deviation interval.
void	setBreakCount(int breakCount) Set the breakCount parameter.
void	setClassificationField(java.lang.String classificationField) Set the classificationField parameter.
void	setClassificationMethod(ClassBreaksDefinition.ClassificationMethod classificationMethod) set the classificationMethod parameter.
void	setNormalizationField(java.lang.String normalizationField) Set the normalizationField parameter.
void	setNormalizationType(ClassBreaksDefinition.NormalizationType normalizationType) Set the normalizationType parameter
void	setStandardDeviationInterval(ClassBreaksDefinition.StandardDeviationInterval standardDeviationInterval) Set the standardDeviationInterval parameter.
com.google.gwt.core.client.JavaScriptObject	toJson() Returns an easily serializable object representation of the class breaks definition.

Methods inherited from class edu.ucdavis.cstars.client.tasks.ClassificationDefinition

getBaseSymbol, getColorRampAsAlgorithmicColorRamp, getColorRampAsMultiPartColorRamp, getType, setBaseSymbol, setColorRamp, setColorRamp, setType

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ClassBreaksDefinition create()

Creates a new ClassBreaksDefinition object

Returns:

ClassBreaksDefinition

getBreakCount

public final int getBreakCount()

The number of class breaks.

Returns:

int

setBreakCount

public final void setBreakCount(int breakCount)

Set the breakCount parameter.

Parameters:

breakCount - - The number of class breaks.

getClassificationField

public final java.lang.String getClassificationField()

The name of the field used to match values.

Returns:

String

setClassificationField

public final void setClassificationField(java.lang.String classificationField)

Set the classificationField parameter.

Parameters:

classificationField - - The name of the field used to match values.

getClassificationMethod

public final ClassBreaksDefinition.ClassificationMethod getClassificationMethod()

The name of the classification method.

Returns:

ClassificationMethod

setClassificationMethod

public final void setClassificationMethod(ClassBreaksDefinition.ClassificationMethod classificationMethod)

set the classificationMethod parameter.

Parameters:

classificationMethod - - The name of the classification method.

getNormalizationField

public final java.lang.String getNormalizationField()

The name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'.

Returns:

String

setNormalizationField

public final void setNormalizationField(java.lang.String normalizationField)

Set the normalizationField parameter.

Parameters:

normalizationField - - The name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'.

getNormalizationType

public final ClassBreaksDefinition.NormalizationType getNormalizationType()

The type of normalization used to normalize class breaks.

Returns:

NormalizationType

setNormalizationType

public final void setNormalizationType(ClassBreaksDefinition.NormalizationType normalizationType)

Set the normalizationType parameter

Parameters:

normalizationType - - The type of normalization used to normalize class breaks.

getStandardDeviationInterval

public final ClassBreaksDefinition.StandardDeviationInterval getStandardDeviationInterval()

The standard deviation interval. When standardDeviationInterval is specified breakCount is ignored. Only valid when the classificationMethod is set to 'standard-deviation'.

Returns:

StandardDeviationInterval

setStandardDeviationInterval

public final void setStandardDeviationInterval(ClassBreaksDefinition.StandardDeviationInterval standardDeviationInterval)

Set the standardDeviationInterval parameter.

Parameters:

standardDeviationInterval - - The standard deviation interval. When standardDeviationInterval is specified breakCount is ignored. Only valid when the classificationMethod is set to 'standard-deviation'.

toJson

public final com.google.gwt.core.client.JavaScriptObject toJson()

Returns an easily serializable object representation of the class breaks definition.

Returns:

JavaScriptObject