com.gooddata.sdk.model.md.dashboard.filter

Class DashboardDateFilter

java.lang.Object

com.gooddata.sdk.model.md.dashboard.filter.DashboardDateFilter

All Implemented Interfaces:

DashboardFilter, Serializable

public class DashboardDateFilter
extends Object
implements DashboardFilter

Date filter located on analytical dashboard. Is not standalone metadata object - always must be part of DashboardFilterContext.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ABSOLUTE_FILTER_TYPE
static DateTimeFormatter	DATE_FORMAT
static String	RELATIVE_FILTER_TYPE

Method Summary

Modifier and Type	Method and Description
static DashboardDateFilter	absoluteDateFilter(LocalDate from, LocalDate to, String datasetUri) Creates absolute date filter with the given interval
String	getDataSet()
String	getFrom() Returns from value of date filter interval.
String	getGranularity()
String	getTo() Returns to value of date filter interval.
String	getType()
static DashboardDateFilter	relativeDateFilter(int from, int to, String granularity, String datasetUri) Creates relative date filter with the given interval and granularity.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE_FILTER_TYPE

public static final String RELATIVE_FILTER_TYPE

See Also:

Constant Field Values

ABSOLUTE_FILTER_TYPE

public static final String ABSOLUTE_FILTER_TYPE

See Also:

Constant Field Values

DATE_FORMAT

public static final DateTimeFormatter DATE_FORMAT

Method Detail

relativeDateFilter

public static DashboardDateFilter relativeDateFilter(int from,
                                                     int to,
                                                     String granularity,
                                                     String datasetUri)

Creates relative date filter with the given interval and granularity.

Parameters:

from - interval from

to - interval to

granularity - granularity (e.g. GDC.time.year)

datasetUri - date dataset URI (optional)

Returns:

created filter

absoluteDateFilter

public static DashboardDateFilter absoluteDateFilter(LocalDate from,
                                                     LocalDate to,
                                                     String datasetUri)

Creates absolute date filter with the given interval

Parameters:

from - interval from

to - interval to

datasetUri - date dataset URI (optional)

Returns:

created filter

getFrom

public String getFrom()

Returns from value of date filter interval. Value represents in the case of:

• relative date filter - integer value
• absolute date filter - date value with format DD-MM-YYYY

Returns:

date filter from interval value

getTo

public String getTo()

Returns to value of date filter interval. Value represents in the case of:

• relative date filter - integer value
• absolute date filter - date value with format YYYY-DD-MM

Returns:

date filter from interval value

getGranularity

public String getGranularity()

Returns:

date interval granularity in the case of relative date filter

getDataSet

public String getDataSet()

Returns:

date dataset URI of this filter

getType

public String getType()

Returns:

date filter type, can be either relative or absolute

toString

public String toString()

Overrides:

toString in class Object