Package com.wavefront.slug.chart

Class ChartSlugBuilderImpl

java.lang.Object

com.wavefront.slug.chart.ChartSlugBuilderImpl

All Implemented Interfaces:

ChartSlugBuilder

public class ChartSlugBuilderImpl
extends Object
implements ChartSlugBuilder

Builder implementation for ChartSlugBuilder using Jackson RISON Lib (https://github.com/bazaarvoice/rison).

Author:

Yutian Wu (wyutian@vmware.com)

Constructor Summary

Constructors

Constructor	Description
ChartSlugBuilderImpl(SlugVersion slugVersion)

Method Summary

Modifier and Type	Method	Description
ChartSlugBuilderImpl	addFocusedHost(String hostName)	Add a host that is focused upon when the page loads.
ChartSlugBuilderImpl	addSource(String name, String query)	Add a new source query to the chart.
ChartSlugBuilderImpl	addSource(String name, String query, boolean disabled)	Add a new source query to the chart.
ChartSlugBuilderImpl	addSource(String name, String query, boolean disabled, String queryBuilderSerialization, boolean queryBuilderEnabled)	Add a new source query to the chart.
String	build()	Build the chart slug.
String	buildAndEncode()	Deprecated.
String	buildAndEscape()	Build and escape the chart slug to be used in the chart url.
ChartSlugBuilderImpl	setBase(int base)	Sets the base of the y-axis of the chart.
ChartSlugBuilder	setChartAttributes(String chartSettings)	Sets the chart's attributes from a JSON serialized string.
ChartSlugBuilder	setChartSettings(ChartSettings chartSettings)	Sets the chart's settings from a ChartSettings objects.
ChartSlugBuilder	setChartSettings(String chartSettings)	Sets the chart's settings from a JSON serialized string.
ChartSlugBuilderImpl	setCompare(String compare)	Sets the comparison option for the entire chart.
ChartSlugBuilderImpl	setCustomerId(String customerId)	Set the customer id for the chart.
ChartSlugBuilder	setDescription(String description)	Sets the description of the chart.
ChartSlugBuilderImpl	setEnd(long endMillis)	Set the end millis.
ChartSlugBuilderImpl	setEnd(org.joda.time.ReadableInstant instant)	Set the end millis.
ChartSlugBuilderImpl	setGranularity(String granularity)	Set the granularity of the entire chart.
ChartSlugBuilderImpl	setId(String id)	Set the chart id.
ChartSlugBuilderImpl	setName(String name)	Set the name of the chart.
ChartSlugBuilderImpl	setStart(long startMillis)	Set the start millis.
ChartSlugBuilderImpl	setStart(org.joda.time.ReadableInstant instant)	Set the start instant.
ChartSlugBuilderImpl	setUnits(String units)	Units to use for the chart (rendered to the right of the Y-axis).

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartSlugBuilderImpl

public ChartSlugBuilderImpl(SlugVersion slugVersion)

Method Detail

setCustomerId

public ChartSlugBuilderImpl setCustomerId(String customerId)

Description copied from interface: ChartSlugBuilder

Set the customer id for the chart.

Specified by:

setCustomerId in interface ChartSlugBuilder

Parameters:

customerId - Customer Id for the chart.

Returns:

The builder.

setId

public ChartSlugBuilderImpl setId(String id)

Description copied from interface: ChartSlugBuilder

Set the chart id. This is technically used only when redirected from a dashboard and defaults to "chart".

Specified by:

setId in interface ChartSlugBuilder

Parameters:

id - The id for the chart.

Returns:

The builder.

setName

public ChartSlugBuilderImpl setName(String name)

Description copied from interface: ChartSlugBuilder

Set the name of the chart.

Specified by:

setName in interface ChartSlugBuilder

Parameters:

name - Name of the chart.

Returns:

The builder.

setStart

public ChartSlugBuilderImpl setStart(long startMillis)

Description copied from interface: ChartSlugBuilder

Set the start millis.

Specified by:

setStart in interface ChartSlugBuilder

Parameters:

startMillis - Start millis.

Returns:

The builder.

setStart

public ChartSlugBuilderImpl setStart(org.joda.time.ReadableInstant instant)

Description copied from interface: ChartSlugBuilder

Set the start instant.

Specified by:

setStart in interface ChartSlugBuilder

Parameters:

instant - The start instant.

Returns:

The builder.

setEnd

public ChartSlugBuilderImpl setEnd(long endMillis)

Description copied from interface: ChartSlugBuilder

Set the end millis.

Specified by:

setEnd in interface ChartSlugBuilder

Parameters:

endMillis - End millis.

Returns:

The builder.

setEnd

public ChartSlugBuilderImpl setEnd(org.joda.time.ReadableInstant instant)

Description copied from interface: ChartSlugBuilder

Set the end millis.

Specified by:

setEnd in interface ChartSlugBuilder

Parameters:

instant - The end instant.

Returns:

The builder.

setGranularity

public ChartSlugBuilderImpl setGranularity(String granularity)

Description copied from interface: ChartSlugBuilder

Set the granularity of the entire chart. Valid values are determined by the FE. Possible values include: "m", "h", "d" and "auto". Defaults to "auto".

Specified by:

setGranularity in interface ChartSlugBuilder

Parameters:

granularity - The granularity to use.

Returns:

The builder.

setCompare

public ChartSlugBuilderImpl setCompare(String compare)

Description copied from interface: ChartSlugBuilder

Sets the comparison option for the entire chart. Valid values are determined by the FE. Possible values include: "1d", "1w", "1m". Defaults to null.

Specified by:

setCompare in interface ChartSlugBuilder

Parameters:

compare - Comparison option to set for the chart.

Returns:

The builder.

setUnits

public ChartSlugBuilderImpl setUnits(String units)

Description copied from interface: ChartSlugBuilder

Units to use for the chart (rendered to the right of the Y-axis).

Specified by:

setUnits in interface ChartSlugBuilder

Parameters:

units - Units to use for the chart.

Returns:

The builder.

setBase

public ChartSlugBuilderImpl setBase(int base)

Description copied from interface: ChartSlugBuilder

Sets the base of the y-axis of the chart. Value must be >= 1. A value of 1 indicates that a linear y-axis should be used.

Specified by:

setBase in interface ChartSlugBuilder

Parameters:

base - Y-axis base.

Returns:

The builder.

setDescription

public ChartSlugBuilder setDescription(String description)

Description copied from interface: ChartSlugBuilder

Sets the description of the chart.

Specified by:

setDescription in interface ChartSlugBuilder

Parameters:

description - chart description.

Returns:

The builder.

setChartSettings

public ChartSlugBuilder setChartSettings(String chartSettings)

Description copied from interface: ChartSlugBuilder

Sets the chart's settings from a JSON serialized string.

Specified by:

setChartSettings in interface ChartSlugBuilder

Parameters:

chartSettings - chart settings string

Returns:

The builder.

setChartSettings

public ChartSlugBuilder setChartSettings(ChartSettings chartSettings)

Description copied from interface: ChartSlugBuilder

Sets the chart's settings from a ChartSettings objects.

Specified by:

setChartSettings in interface ChartSlugBuilder

Parameters:

chartSettings - chart settings string

Returns:

The builder.

setChartAttributes

public ChartSlugBuilder setChartAttributes(String chartSettings)

Description copied from interface: ChartSlugBuilder

Sets the chart's attributes from a JSON serialized string.

Specified by:

setChartAttributes in interface ChartSlugBuilder

Parameters:

chartSettings - chart settings string

Returns:

The builder.

addSource

public ChartSlugBuilderImpl addSource(String name,
                                      String query)

Description copied from interface: ChartSlugBuilder

Add a new source query to the chart.

Specified by:

addSource in interface ChartSlugBuilder

Parameters:

name - Name of the query.

query - The query.

Returns:

The builder.

addSource

public ChartSlugBuilderImpl addSource(String name,
                                      String query,
                                      boolean disabled)

Description copied from interface: ChartSlugBuilder

Add a new source query to the chart.

Specified by:

addSource in interface ChartSlugBuilder

Parameters:

name - Name of the query.

query - The query.

disabled - True if this query should be disabled (unchecked) in the chart.

Returns:

The builder.

addSource

public ChartSlugBuilderImpl addSource(String name,
                                      String query,
                                      boolean disabled,
                                      String queryBuilderSerialization,
                                      boolean queryBuilderEnabled)

Description copied from interface: ChartSlugBuilder

Add a new source query to the chart.

Specified by:

addSource in interface ChartSlugBuilder

Parameters:

name - Name of the query.

query - The query.

disabled - True if this query should be disabled (unchecked) in the chart.

queryBuilderSerialization - Serialization of the querybuilder

queryBuilderEnabled - True if the querybuilder is enabled

Returns:

The builder.

addFocusedHost

public ChartSlugBuilderImpl addFocusedHost(String hostName)

Description copied from interface: ChartSlugBuilder

Add a host that is focused upon when the page loads. The chart must contain queries that yield host tags (e.g. host=abcd01 or host=*) for focusing to work.

Specified by:

addFocusedHost in interface ChartSlugBuilder

Parameters:

hostName - Host name for series tagged by it to be focused on.

Returns:

The builder.

build

public String build()

Description copied from interface: ChartSlugBuilder

Build the chart slug.

Specified by:

build in interface ChartSlugBuilder

Returns:

The chart slug.

buildAndEscape

public String buildAndEscape()

Description copied from interface: ChartSlugBuilder

Build and escape the chart slug to be used in the chart url.

Specified by:

buildAndEscape in interface ChartSlugBuilder

buildAndEncode

@Deprecated
public String buildAndEncode()

Deprecated.

This only works in v1 slugs, as it encodes special characters as well. So the result it generated will only be v1 slugs.

Specified by:

buildAndEncode in interface ChartSlugBuilder