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

Class DashboardDateFilter

java.lang.Object
com.gooddata.sdk.model.md.dashboard.filter.DashboardDateFilter
All Implemented Interfaces:
DashboardFilter, java.io.Serializable
public class DashboardDateFilter
extends java.lang.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 Description
    static java.lang.String ABSOLUTE_FILTER_TYPE  
    static java.time.format.DateTimeFormatter DATE_FORMAT  
    static java.lang.String RELATIVE_FILTER_TYPE  

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • relativeDateFilter

      public static DashboardDateFilter relativeDateFilter​(int from, int to, java.lang.String granularity, java.lang.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​(java.time.LocalDate from, java.time.LocalDate to, java.lang.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 java.lang.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 java.lang.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 java.lang.String getGranularity()
      Returns:
      date interval granularity in the case of relative date filter

    • getDataSet

      public java.lang.String getDataSet()
      Returns:
      date dataset URI of this filter

    • getType

      public java.lang.String getType()
      Returns:
      date filter type, can be either relative or absolute

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object