org.graylog2.dashboards.widgets

Class DashboardWidget

java.lang.Object

org.graylog2.dashboards.widgets.DashboardWidget

All Implemented Interfaces:

EmbeddedPersistable

Direct Known Subclasses:

FieldChartWidget, QuickvaluesWidget, SearchResultChartWidget, SearchResultCountWidget, StreamSearchResultCountWidget

public abstract class DashboardWidget
extends java.lang.Object
implements EmbeddedPersistable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DashboardWidget.NoSuchWidgetTypeException
static class	DashboardWidget.Type

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CACHE_TIME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DashboardWidget(com.codahale.metrics.MetricRegistry metricRegistry, DashboardWidget.Type type, java.lang.String id, java.lang.String description, int cacheTimeS, java.util.Map<java.lang.String,java.lang.Object> config, java.lang.String creatorUserId)

Method Summary

Modifier and Type	Method and Description
static DashboardWidget	buildDashboardWidget(DashboardWidget.Type type, com.codahale.metrics.MetricRegistry metricRegistry, Searches searches, java.lang.String widgetId, java.lang.String description, int cacheTime, java.util.Map<java.lang.String,java.lang.Object> config, java.lang.String query, TimeRange timeRange, java.lang.String creatorUserId)
protected abstract ComputationResult	compute()
static DashboardWidget	fromPersisted(com.codahale.metrics.MetricRegistry metricRegistry, Searches searches, com.mongodb.BasicDBObject fields)
static DashboardWidget	fromRequest(com.codahale.metrics.MetricRegistry metricRegistry, Searches searches, AddWidgetRequest awr, java.lang.String userId)
int	getCacheTime()
ComputationResult	getComputationResult()
java.util.Map<java.lang.String,java.lang.Object>	getConfig()
java.lang.String	getCreatorUserId()
java.lang.String	getDescription()
java.lang.String	getId()
abstract java.util.Map<java.lang.String,java.lang.Object>	getPersistedConfig()
java.util.Map<java.lang.String,java.lang.Object>	getPersistedFields()
DashboardWidget.Type	getType()
void	setCacheTime(int cacheTime)
void	setDescription(java.lang.String description)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_TIME

public static final int DEFAULT_CACHE_TIME

See Also:

Constant Field Values

Constructor Detail

DashboardWidget

protected DashboardWidget(com.codahale.metrics.MetricRegistry metricRegistry,
                          DashboardWidget.Type type,
                          java.lang.String id,
                          java.lang.String description,
                          int cacheTimeS,
                          java.util.Map<java.lang.String,java.lang.Object> config,
                          java.lang.String creatorUserId)

Method Detail

fromRequest

public static DashboardWidget fromRequest(com.codahale.metrics.MetricRegistry metricRegistry,
                                          Searches searches,
                                          AddWidgetRequest awr,
                                          java.lang.String userId)
                                   throws DashboardWidget.NoSuchWidgetTypeException,
                                          InvalidRangeParametersException,
                                          InvalidWidgetConfigurationException

Throws:

DashboardWidget.NoSuchWidgetTypeException

InvalidRangeParametersException

InvalidWidgetConfigurationException

fromPersisted

public static DashboardWidget fromPersisted(com.codahale.metrics.MetricRegistry metricRegistry,
                                            Searches searches,
                                            com.mongodb.BasicDBObject fields)
                                     throws DashboardWidget.NoSuchWidgetTypeException,
                                            InvalidRangeParametersException,
                                            InvalidWidgetConfigurationException

Throws:

DashboardWidget.NoSuchWidgetTypeException

InvalidRangeParametersException

InvalidWidgetConfigurationException

buildDashboardWidget

public static DashboardWidget buildDashboardWidget(DashboardWidget.Type type,
                                                   com.codahale.metrics.MetricRegistry metricRegistry,
                                                   Searches searches,
                                                   java.lang.String widgetId,
                                                   java.lang.String description,
                                                   int cacheTime,
                                                   java.util.Map<java.lang.String,java.lang.Object> config,
                                                   java.lang.String query,
                                                   TimeRange timeRange,
                                                   java.lang.String creatorUserId)
                                            throws DashboardWidget.NoSuchWidgetTypeException,
                                                   InvalidWidgetConfigurationException

Throws:

DashboardWidget.NoSuchWidgetTypeException

InvalidWidgetConfigurationException

getType

public DashboardWidget.Type getType()

getId

public java.lang.String getId()

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

setCacheTime

public void setCacheTime(int cacheTime)

getCacheTime

public int getCacheTime()

getConfig

public java.util.Map<java.lang.String,java.lang.Object> getConfig()

getCreatorUserId

public java.lang.String getCreatorUserId()

getPersistedFields

public java.util.Map<java.lang.String,java.lang.Object> getPersistedFields()

Specified by:

getPersistedFields in interface EmbeddedPersistable

getComputationResult

public ComputationResult getComputationResult()
                                       throws java.util.concurrent.ExecutionException

Throws:

java.util.concurrent.ExecutionException

getPersistedConfig

public abstract java.util.Map<java.lang.String,java.lang.Object> getPersistedConfig()

compute

protected abstract ComputationResult compute()