org.graylog2.dashboards.widgets

Class DashboardWidget

java.lang.Object

org.graylog2.dashboards.widgets.DashboardWidget

All Implemented Interfaces:

EmbeddedPersistable

Direct Known Subclasses:

ChartWidget, QuickvaluesWidget, SearchResultCountWidget

public abstract class DashboardWidget
extends 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 String	FIELD_CACHE_TIME
static String	FIELD_CONFIG
static String	FIELD_CREATOR_USER_ID
static String	FIELD_DESCRIPTION
static String	FIELD_ID
static String	FIELD_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DashboardWidget(com.codahale.metrics.MetricRegistry metricRegistry, DashboardWidget.Type type, String id, TimeRange timeRange, String description, WidgetCacheTime cacheTime, Map<String,Object> config, String creatorUserId)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ComputationResult	compute()
int	getCacheTime()
ComputationResult	getComputationResult()
Map<String,Object>	getConfig()
String	getCreatorUserId()
String	getDescription()
String	getId()
Map<String,Object>	getPersistedConfig()
Map<String,Object>	getPersistedFields()
TimeRange	getTimeRange()
DashboardWidget.Type	getType()
void	setCacheTime(int cacheTime)
void	setDescription(String description)

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_CACHE_TIME

public static final String FIELD_CACHE_TIME

See Also:

Constant Field Values

FIELD_CREATOR_USER_ID

public static final String FIELD_CREATOR_USER_ID

See Also:

Constant Field Values

FIELD_CONFIG

public static final String FIELD_CONFIG

See Also:

Constant Field Values

Constructor Detail

DashboardWidget

protected DashboardWidget(com.codahale.metrics.MetricRegistry metricRegistry,
               DashboardWidget.Type type,
               String id,
               TimeRange timeRange,
               String description,
               WidgetCacheTime cacheTime,
               Map<String,Object> config,
               String creatorUserId)

Method Detail

getType

public DashboardWidget.Type getType()

getId

public String getId()

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

setCacheTime

public void setCacheTime(int cacheTime)

getCacheTime

public int getCacheTime()

getTimeRange

public TimeRange getTimeRange()

getConfig

public Map<String,Object> getConfig()

getCreatorUserId

public String getCreatorUserId()

getPersistedFields

public Map<String,Object> getPersistedFields()

Specified by:

getPersistedFields in interface EmbeddedPersistable

getComputationResult

public ComputationResult getComputationResult()
                                       throws ExecutionException

Throws:

ExecutionException

getPersistedConfig

public Map<String,Object> getPersistedConfig()

compute

protected abstract ComputationResult compute()