Class TimelineDefinition

java.lang.Object
com.onenetwork.platform.data.tlv.TimelineDefinition

public class TimelineDefinition
extends java.lang.Object
Defines the overall bucketization for a Timeline View.
  • Constructor Summary

    Constructors 
    Constructor Description
    TimelineDefinition()  
    TimelineDefinition​(java.util.Calendar startDate)  
  • Method Summary

    Modifier and Type Method Description
    java.util.List<DataMeasure> getAncestorDMs()
    TimelineDefinitions can be used to represent overall Timelines, as well as timelines for specific DMS.
    java.util.List<Pair<Bucketization,​java.util.Calendar>> getBuckets()  
    java.util.Calendar getStartDate()
    Start date of timeline.
    java.time.DayOfWeek getStartDayOfWeek()  
    void setAncestorDMs​(java.util.List<DataMeasure> ancestorDMs)
    TimelineDefinitions can be used to represent overall Timelines, as well as timelines for specific DMS.
    void setBuckets​(java.util.List<Pair<Bucketization,​java.util.Calendar>> buckets)  
    void setStartDate​(java.util.Calendar startDate)  
    void setStartDayOfWeek​(java.time.DayOfWeek startDayOfWeek)  

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • getStartDate

      public java.util.Calendar getStartDate()
      Start date of timeline. If its null then user provided start date is used
      Returns:
    • getBuckets

      public java.util.List<Pair<Bucketization,​java.util.Calendar>> getBuckets()
      Returns:
      List of Bucketization with bucket count
    • setStartDate

      public void setStartDate​(java.util.Calendar startDate)
      Parameters:
      startDate - the startDate to set
    • setBuckets

      public void setBuckets​(java.util.List<Pair<Bucketization,​java.util.Calendar>> buckets)
      Parameters:
      buckets - the buckets to set
    • getStartDayOfWeek

      public java.time.DayOfWeek getStartDayOfWeek()
      Returns:
      the startDayOfWeek
    • setStartDayOfWeek

      public void setStartDayOfWeek​(java.time.DayOfWeek startDayOfWeek)
      Parameters:
      startDayOfWeek - the startDayOfWeek to set
    • getAncestorDMs

      public java.util.List<DataMeasure> getAncestorDMs()
      TimelineDefinitions can be used to represent overall Timelines, as well as timelines for specific DMS. In the case where we are representing a DM, this method returns the list of all ancestor DMs for this DM.
      For example, if 'DMC' is a child DM of 'DMB' and 'DMB' is a child DM of 'DMA', and this TimelineDefinition represents 'DMC'm then getAncestorDMs contains 'DMA' and 'DMB'
    • setAncestorDMs

      public void setAncestorDMs​(java.util.List<DataMeasure> ancestorDMs)
      TimelineDefinitions can be used to represent overall Timelines, as well as timelines for specific DMS. In the case where we are representing a DM, this method can be used to set the list of all ancestor DMs for this DM.