com.illumon.iris.db.plot

Class LineStyle

java.lang.Object

com.illumon.iris.db.plot.LineStyle

All Implemented Interfaces:

Serializable

public class LineStyle
extends Object
implements Serializable

Specifies the drawing style of a line.

LineStyle specifies the line thickness, dash pattern and join and end styles.

Line thickness is 1 by default. Larger numbers draw thicker lines.

Dash pattern is defined by an array. If only one value is included in the array, the dash and the gap after the dash will be the same. If more than one value is used in the array, the first value represents the length of the first dash in the line. The next value represents the length of the gap between it and the next dash.
Additional values can be added into the array for subsequent dash/gap combinations. For example, the array [20,5] creates a dash pattern with a 20 length dash and a 5 length gap. This pattern is repeated till the end of the line.
LineStyle.LineEndStyle specifies the shape drawn at the end of a line. LineStyle.LineJoinStyle specifies the shape drawn at data points along the line.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LineStyle.LineEndStyle Style for drawing the end of a line.
static class	LineStyle.LineJoinStyle Style for drawing the connections between line segments.

Constructor Summary

Constructors

Constructor and Description
LineStyle() Creates a LineStyle.
LineStyle(double... dashPattern) Creates a LineStyle with specified dash pattern.
LineStyle(double width) Creates a LineStyle with specified thickness.
LineStyle(double width, double[] dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(double width, float[] dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(double width, int[] dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(double width, LineStyle.LineEndStyle endStyle, LineStyle.LineJoinStyle joinStyle, double... dashPattern) Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
LineStyle(double width, LineStyle.LineEndStyle endStyle, LineStyle.LineJoinStyle joinStyle, List<T> dashPattern) Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
LineStyle(double width, List<T> dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(double width, long[] dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(double width, String endStyle, String joinStyle, double... dashPattern) Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
LineStyle(double width, String endStyle, String joinStyle, List<T> dashPattern) Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
LineStyle(double width, T[] dashPattern) Creates a LineStyle with specified thickness and dash pattern.
LineStyle(List<T> dashPattern) Creates a LineStyle with specified dash pattern.
LineStyle(String endStyle, String joinStyle) Creates a LineStyle with specified LineStyle.LineEndStyle and LineStyle.LineJoinStyle Defaults line width to 1.0.

Method Summary

Modifier and Type	Method and Description
float[]	getDashPattern() Gets the dash pattern of this LineStyle.
LineStyle.LineEndStyle	getEndStyle() Gets the LineStyle.LineEndStyle of this LineStyle.
LineStyle.LineJoinStyle	getJoinStyle() Gets the LineStyle.LineJoinStyle of this LineStyle.
double	getWidth() Gets the width of this LineStyle.
static LineStyle.LineEndStyle	lineEndStyle(String style) Gets the LineEndStyle.
static String[]	lineEndStyleNames() Gets the names of available LineEndStyles.
static LineStyle.LineJoinStyle	lineJoinStyle(String style) Gets the LineJoinStyle.
static String[]	lineJoinStyleNames() Gets the names of available LineJoinStyles.
static LineStyle	lineStyle() Creates a LineStyle.
static LineStyle	lineStyle(double... dashPattern) Gets a LineStyle instance with specified dash pattern.
static LineStyle	lineStyle(double width) Gets a LineStyle instance with specified thickness.
static LineStyle	lineStyle(double width, double[] dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static LineStyle	lineStyle(double width, float[] dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static LineStyle	lineStyle(double width, int[] dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static LineStyle	lineStyle(double width, LineStyle.LineEndStyle endStyle, LineStyle.LineJoinStyle joinStyle, double... dashPattern) Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
static <T extends Number> LineStyle	lineStyle(double width, LineStyle.LineEndStyle endStyle, LineStyle.LineJoinStyle joinStyle, List<T> dashPattern) Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
static <T extends Number> LineStyle	lineStyle(double width, List<T> dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static LineStyle	lineStyle(double width, long[] dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static LineStyle	lineStyle(double width, String endStyle, String joinStyle, double... dashPattern) Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
static <T extends Number> LineStyle	lineStyle(double width, String endStyle, String joinStyle, List<T> dashPattern) Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.
static <T extends Number> LineStyle	lineStyle(double width, T[] dashPattern) Gets a LineStyle instance with specified thickness and dash pattern.
static <T extends Number> LineStyle	lineStyle(List<T> dashPattern) Gets a LineStyle instance with specified dash pattern.
static LineStyle	lineStyle(String endStyle, String joinStyle) Gets a LineStyle instance with specified LineStyle.LineEndStyle and LineStyle.LineJoinStyle Defaults line width to 1.0.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LineStyle

public LineStyle(double width,
                 LineStyle.LineEndStyle endStyle,
                 LineStyle.LineJoinStyle joinStyle,
                 double... dashPattern)

Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Parameters:

width - line thickness

endStyle - line end style

joinStyle - line join style

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 LineStyle.LineEndStyle endStyle,
                 LineStyle.LineJoinStyle joinStyle,
                 List<T> dashPattern)

Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

endStyle - line end style

joinStyle - line join style

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 String endStyle,
                 String joinStyle,
                 double... dashPattern)

Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Parameters:

width - line thickness

endStyle - line end style descriptor

joinStyle - line join style descriptor

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 String endStyle,
                 String joinStyle,
                 List<T> dashPattern)

Creates a LineStyle with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

endStyle - line end style descriptor

joinStyle - line join style descriptor

dashPattern - dash pattern

LineStyle

public LineStyle(double width)

Creates a LineStyle with specified thickness. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND. No dash pattern is set.

Parameters:

width - line thickness

LineStyle

public LineStyle(double width,
                 double[] dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 int[] dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 long[] dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 float[] dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 T[] dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double width,
                 List<T> dashPattern)

Creates a LineStyle with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

dashPattern - dash pattern

LineStyle

public LineStyle(double... dashPattern)

Creates a LineStyle with specified dash pattern. Defaults line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

dashPattern - dash pattern

LineStyle

public LineStyle(List<T> dashPattern)

Creates a LineStyle with specified dash pattern. Defaults line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

dashPattern - dash pattern

LineStyle

public LineStyle(String endStyle,
                 String joinStyle)

Creates a LineStyle with specified LineStyle.LineEndStyle and LineStyle.LineJoinStyle Defaults line width to 1.0. No dash pattern is set.

Parameters:

endStyle - line end style

joinStyle - line join style

LineStyle

public LineStyle()

Creates a LineStyle. Defaults the line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND. No dash pattern is set.

Method Detail

lineEndStyle

public static LineStyle.LineEndStyle lineEndStyle(String style)

Gets the LineEndStyle.

Parameters:

style - case insensitive style name.

Returns:

LineEndStyle specified by style

Throws:

IllegalArgumentException - style can not be null

lineEndStyleNames

public static String[] lineEndStyleNames()

Gets the names of available LineEndStyles.

Returns:

array of LineEndStyle names

lineJoinStyle

public static LineStyle.LineJoinStyle lineJoinStyle(String style)

Gets the LineJoinStyle.

Parameters:

style - case insensitive style name

Returns:

LineJoinStyle specified by style

Throws:

IllegalArgumentException - style can not be null

lineJoinStyleNames

public static String[] lineJoinStyleNames()

Gets the names of available LineJoinStyles.

Returns:

array of LineJoinStyle names

lineStyle

public static LineStyle lineStyle(double width,
                                  LineStyle.LineEndStyle endStyle,
                                  LineStyle.LineJoinStyle joinStyle,
                                  double... dashPattern)

Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Parameters:

width - line thickness

endStyle - line end style

joinStyle - line join style

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width, dash pattern, LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static <T extends Number> LineStyle lineStyle(double width,
                                                     LineStyle.LineEndStyle endStyle,
                                                     LineStyle.LineJoinStyle joinStyle,
                                                     List<T> dashPattern)

Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

endStyle - line end style

joinStyle - line join style

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width, dash pattern, LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width,
                                  String endStyle,
                                  String joinStyle,
                                  double... dashPattern)

Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Parameters:

width - line thickness

endStyle - line end style descriptor

joinStyle - line join style descriptor

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width, dash pattern, LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static <T extends Number> LineStyle lineStyle(double width,
                                                     String endStyle,
                                                     String joinStyle,
                                                     List<T> dashPattern)

Gets a LineStyle instance with specified thickness, LineStyle.LineEndStyle, LineStyle.LineJoinStyle, and dash pattern.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

endStyle - line end style descriptor

joinStyle - line join style descriptor

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width, dash pattern, LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width)

Gets a LineStyle instance with specified thickness. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND. No dash pattern is set.

Parameters:

width - line thickness

Returns:

default LineStyle instance with specified line width and the default dash pattern, LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width,
                                  double[] dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width,
                                  int[] dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width,
                                  long[] dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double width,
                                  float[] dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static <T extends Number> LineStyle lineStyle(double width,
                                                     T[] dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static <T extends Number> LineStyle lineStyle(double width,
                                                     List<T> dashPattern)

Gets a LineStyle instance with specified thickness and dash pattern. Defaults the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

width - line thickness

dashPattern - dash pattern

Returns:

default LineStyle instance with specified line width and dash pattern and the default LineStyle.LineEndStyle and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(double... dashPattern)

Gets a LineStyle instance with specified dash pattern. Defaults line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Parameters:

dashPattern - dash pattern

Returns:

default LineStyle instance with specified dash pattern and default line width, LineStyle.LineEndStyle, and LineStyle.LineJoinStyle.

lineStyle

public static <T extends Number> LineStyle lineStyle(List<T> dashPattern)

Gets a LineStyle instance with specified dash pattern. Defaults line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND.

Type Parameters:

T - data type of dashPattern

Parameters:

dashPattern - dash pattern

Returns:

default LineStyle instance with specified dash pattern and default line width, LineStyle.LineEndStyle, and LineStyle.LineJoinStyle.

lineStyle

public static LineStyle lineStyle(String endStyle,
                                  String joinStyle)

Gets a LineStyle instance with specified LineStyle.LineEndStyle and LineStyle.LineJoinStyle Defaults line width to 1.0. No dash pattern is set.

Parameters:

endStyle - line end style

joinStyle - line join style

Returns:

default LineStyle instance with specified LineStyle.LineEndStyle and LineStyle.LineJoinStyle and default line width and dash pattern.

lineStyle

public static LineStyle lineStyle()

Creates a LineStyle. Defaults the line width to 1.0 and the LineStyle.LineEndStyle and LineStyle.LineJoinStyle to LineStyle.LineJoinStyle.ROUND. No dash pattern is set.

Returns:

default LineStyle instance

getWidth

public double getWidth()

Gets the width of this LineStyle.

Returns:

this LineStyle's width

getEndStyle

public LineStyle.LineEndStyle getEndStyle()

Gets the LineStyle.LineEndStyle of this LineStyle.

Returns:

this LineStyle's LineStyle.LineEndStyle

getJoinStyle

public LineStyle.LineJoinStyle getJoinStyle()

Gets the LineStyle.LineJoinStyle of this LineStyle.

Returns:

this LineStyle's LineStyle.LineJoinStyle

getDashPattern

public float[] getDashPattern()

Gets the dash pattern of this LineStyle.

Returns:

this LineStyle's dash pattern

toString

public String toString()

Overrides:

toString in class Object