Package types.collections.time

Class datespanset

java.lang.Object
types.collections.base.SpanSet<LocalDate>
types.collections.time.datespanset
All Implemented Interfaces:
Base, Collection, Time, TimeCollection, TemporalObject
public class datespanset extends SpanSet<LocalDate> implements Time, TimeCollection
Class for representing lists of disjoint tstzspans.

:class:``DateSpanSet`` objects can be created with a single argument of type string as in MobilityDB.

>>> DateSpanSet(string='{[2019-09-08, 2019-09-10], [2019-09-11, 2019-09-12]}')

Another possibility is to give a list specifying the composing
tstzspans, which can be instances of :class:``str`` or :class:``DateSpan``.
The composing datespans must be given in increasing order.

>>> DateSpanSet(span_list=['[2019-09-08, 2019-09-10]', '[2019-09-11, 2019-09-12]'])
>>> DateSpanSet(span_list=[TsTzSpan('[2019-09-08, 2019-09-10]'), TsTzSpan('[2019-09-11, 2019-09-12]')])

Author:
ARIJIT SAMAL

  • Field Details

    • _inner

      private final jnr.ffi.Pointer _inner

  • Constructor Details

    • datespanset

      public datespanset(jnr.ffi.Pointer inner)

    • datespanset

      public datespanset(String str)

    • datespanset

      public datespanset(List<?> dspan)

  • Method Details

    • to_span

      public datespan to_span() throws InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException
      Returns a :class:`DateSpanSet` set containing ``self``. Returns: A new :class:`DateSpanSet` instance MEOS Functions: span_to_spanset
      Throws:
      InvocationTargetException
      NoSuchMethodException
      InstantiationException
      IllegalAccessException

    • to_tstzspanset

      public tstzspanset to_tstzspanset() throws InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException
      Returns a :class:`TsTzSpan equivalent to ``self``. Returns: A new :class:`TsTzSpan` instance MEOS Functions: datespan_to_tstzspan
      Throws:
      InvocationTargetException
      NoSuchMethodException
      InstantiationException
      IllegalAccessException

    • duration

      public Duration duration(boolean ignore_gaps) throws InvocationTargetException, NoSuchMethodException, InstantiationException, IllegalAccessException
      Returns the duration of ``self``. Returns: A :class:`datetime.timedelta` instance representing the duration of the :class:`DateSpan` MEOS Functions: datespan_duration
      Throws:
      InvocationTargetException
      NoSuchMethodException
      InstantiationException
      IllegalAccessException

    • num_dates

      public int num_dates()

    • createInner

      public jnr.ffi.Pointer createInner(jnr.ffi.Pointer inner)
      Specified by:
      createInner in class SpanSet<LocalDate>

    • createStringInner

      public jnr.ffi.Pointer createStringInner(String str)
      Specified by:
      createStringInner in class SpanSet<LocalDate>

    • get_inner

      public jnr.ffi.Pointer get_inner()
      Specified by:
      get_inner in class SpanSet<LocalDate>

    • start_date

      public LocalDate start_date()

    • end_date

      public LocalDate end_date()

    • date_n

      public LocalDate date_n(int n) throws Exception
      Returns the n-th date in ``self``. Returns: A :class:`date` instance MEOS Functions:
      Throws:
      Exception

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • date_adt_to_date

      public LocalDate date_adt_to_date(int ts)
      Function to convert the integer timestamp to LocalDate format so that it can be used by other libraries

    • start_span

      public datespan start_span() throws org.locationtech.jts.io.ParseException
      Returns the first date in ``self``. Returns: A :class:`date` instance MEOS Functions: dateset_start_value
      Throws:
      org.locationtech.jts.io.ParseException

    • end_element

      public datespan end_element() throws org.locationtech.jts.io.ParseException
      Returns the last date in ``self``. Returns: A :class:`date` instance MEOS Functions: dateset_end_value
      Throws:
      org.locationtech.jts.io.ParseException

    • span_n

      public datespan span_n(int n) throws org.locationtech.jts.io.ParseException
      Throws:
      org.locationtech.jts.io.ParseException

    • elements

      public List<datespan> elements() throws Exception
      Throws:
      Exception

    • scale

      public datespan scale(int duration)
      Returns a new :class:`DateSpan` that starts as ``self`` but has duration ``duration``. Examples: >>> DateSpan('[2000-01-01, 2000-01-10]').scale(timedelta(days=2)) >>> 'DateSpan([2000-01-01, 2000-01-03])' Args: duration: :class:`datetime.timedelta` instance representing the duration of the new dateSpan Returns: A new :class:`DateSpan` instance MEOS Functions: datespan_shift_scale

    • shift

      public datespanset shift(int shift)
      Returns a new :class:`DateSpan` that is the result of shifting ``self`` by ``delta``. Examples: >>> DateSpan('[2000-01-01, 2000-01-10]').shift(timedelta(days=2)) >>> 'DateSpan([2000-01-03, 2000-01-12])' Args: delta: :class:`datetime.timedelta` instance to shift Returns: A new :class:`DateSpan` instance MEOS Functions: datespan_shift_scale

    • shift_scale

      public datespanset shift_scale(Integer shift, Integer duration)
      Returns a new :class:`DateSpan` that starts at ``self`` shifted by ``shift`` and has duration ``duration`` Examples: >>> DateSpan('[2000-01-01, 2000-01-10]').shift_scale(shift=timedelta(days=2), duration=timedelta(days=4)) >>> 'DateSpan([2000-01-03, 2000-01-07])' Args: shift: :class:`datetime.timedelta` instance to shift duration: :class:`datetime.timedelta` instance representing the duration of the new dateSpan Returns: A new :class:`DateSpan` instance MEOS Functions: datespan_shift_scale

    • dateToTimestamp

      public int dateToTimestamp(LocalDate date)
      Returns whether ``self`` temporally contains ``content``. Examples: >>> DateSpan('[2012-01-01, 2012-01-04]').contains(DateSpan('[2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-01, 2012-01-02]').contains(DateSpan('(2012-01-01, 2012-01-02)')) >>> True >>> DateSpan('(2012-01-01, 2012-01-02)').contains(DateSpan('[2012-01-01, 2012-01-02]')) >>> False Args: content: temporal object to compare with Returns: True if contains, False otherwise MEOS Functions: contains_span_span, contains_span_spanset, contains_span_date

    • contains

      public boolean contains(Object other) throws Exception
      Throws:
      Exception

    • is_adjacent

      public boolean is_adjacent(Object other) throws Exception
      Returns whether ``self`` is adjacent to ``other``. That is, they share a bound but only one of them contains it. Args: other: object to compare with Returns: True if adjacent, False otherwise MEOS Functions: adjacent_span_span, adjacent_span_spanset, adjacent_span_date
      Throws:
      Exception

    • overlaps

      public boolean overlaps(Object other) throws Exception
      Returns whether ``self`` temporally overlaps ``other``. That is, both share at least an instant Examples: >>> DateSpan('[2012-01-01, 2012-01-02]').overlaps(DateSpan('[2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-01, 2012-01-02)').overlaps(DateSpan('[2012-01-02, 2012-01-03]')) >>> False >>> DateSpan('[2012-01-01, 2012-01-02)').overlaps(DateSpan('(2012-01-02, 2012-01-03]')) >>> False Args: other: temporal object to compare with Returns: True if overlaps, False otherwise MEOS Functions: overlaps_span_span, overlaps_span_spanset
      Throws:
      Exception

    • is_left

      public boolean is_left(Object other) throws Exception
      Returns whether ``self`` is strictly before ``other``. That is, ``self`` ends before ``other`` starts. Examples: >>> DateSpan('[2012-01-01, 2012-01-02)').is_left(DateSpan('[2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-01, 2012-01-02)').is_left(DateSpan('(2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-01, 2012-01-02]').is_left(DateSpan('[2012-01-02, 2012-01-03]')) >>> False Args: other: temporal object to compare with Returns: True if before, False otherwise MEOS Functions: left_span_span, left_span_spanset, before_span_date,
      Throws:
      Exception

    • is_over_or_left

      public boolean is_over_or_left(Object other) throws Exception
      Returns whether ``self`` is before ``other`` allowing overlap. That is, ``self`` ends before ``other`` ends (or at the same time). Examples: >>> DateSpan('[2012-01-01, 2012-01-02)').is_over_or_left(DateSpan('[2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-01, 2012-01-02]').is_over_or_left(DateSpan('[2012-01-02, 2012-01-03]')) >>> True >>> DateSpan('[2012-01-03, 2012-01-05]').is_over_or_left(DateSpan('[2012-01-01, 2012-01-04]')) >>> False Args: other: temporal object to compare with Returns: True if before, False otherwise MEOS Functions: overleft_span_span, overleft_span_spanset, overbefore_span_date,
      Throws:
      Exception

    • is_over_or_right

      public boolean is_over_or_right(Object other) throws Exception
      Returns whether ``self`` is after ``other`` allowing overlap. That is, ``self`` starts after ``other`` starts (or at the same time). Examples: >>> DateSet('{2012-01-02, 2012-01-03}').is_over_or_right(DateSpan('[2012-01-01, 2012-01-02)')) >>> True >>> DateSet('{2012-01-02, 2012-01-03}').is_over_or_right(DateSpan('[2012-01-01, 2012-01-02]')) >>> True >>> DateSet('{2012-01-02, 2012-01-03}').is_over_or_right(DateSpan('[2012-01-01, 2012-01-03]')) >>> False Args: other: temporal object to compare with Returns: True if overlapping or after, False otherwise MEOS Functions: overafter_set_date, overright_span_span, overright_span_spanset
      Throws:
      Exception

    • is_right

      public boolean is_right(Object other) throws Exception
      Returns whether ``self`` is strictly after ``other``. That is, ``self`` starts after ``other`` ends. Examples: >>> DateSpan('[2012-01-02, 2012-01-03]').is_right(DateSpan('[2012-01-01, 2012-01-02)')) >>> True >>> DateSpan('(2012-01-02, 2012-01-03]').is_right(DateSpan('[2012-01-01, 2012-01-02)')) >>> True >>> DateSpan('[2012-01-02, 2012-01-03]').is_right(DateSpan('[2012-01-01, 2012-01-02]')) >>> False Args: other: temporal object to compare with Returns: True if after, False otherwise MEOS Functions: right_span_span, right_span_spanset, after_span_date,
      Throws:
      Exception

    • is_before

      public boolean is_before(Object other) throws Exception
      Specified by:
      is_before in interface TimeCollection
      Throws:
      Exception

    • is_over_or_before

      public boolean is_over_or_before(Object other) throws Exception
      Specified by:
      is_over_or_before in interface TimeCollection
      Throws:
      Exception

    • is_over_or_after

      public boolean is_over_or_after(Object other) throws Exception
      Specified by:
      is_over_or_after in interface TimeCollection
      Throws:
      Exception

    • is_after

      public boolean is_after(Object other) throws Exception
      Specified by:
      is_after in interface TimeCollection
      Throws:
      Exception

    • distance

      public Duration distance(Object other) throws Exception
      Returns the temporal distance between ``self`` and ``other``. Args: other: temporal object to compare with Returns: A :class:`datetime.timedelta` instance MEOS Functions: distance_set_date, distance_dateset_dateset, distance_datespanset_datespan, distance_datespanset_datespanset
      Throws:
      Exception

    • timestampToLocalDateTime

      public static LocalDateTime timestampToLocalDateTime(int timestamp)
      Convert timestamp (number of seconds since epoch) to LocalDateTime

    • intersection

      public datespanset intersection(Object other) throws Exception
      Returns the temporal intersection of ``self`` and ``other``. Args: other: temporal object to intersect with Returns: A :class:`TimeDate` instance. The actual class depends on ``other``. MEOS Functions: intersection_set_date, intersection_set_set, intersection_spanset_span, intersection_spanset_spanset
      Throws:
      Exception

    • minus

      public datespanset minus(Object other) throws Exception
      Returns the temporal difference of ``self`` and ``other``. Args: other: temporal object to diff with Returns: A :class:`DateSpanSet` instance. MEOS Functions: minus_span_date, minus_span_spanset, minus_span_span
      Throws:
      Exception

    • timestampToLocalDate

      public static LocalDate timestampToLocalDate(int timestamp)
      convert timestamp (number of seconds since epoch) to LocalDate

    • subtract_from

      public LocalDate subtract_from(Object other) throws Exception
      Throws:
      Exception

    • union

      public datespanset union(Object other) throws Exception
      Returns the temporal union of ``self`` and ``other``. Args: other: temporal object to merge with Returns: A :class:`DateSpanSet` instance. MEOS Functions: union_span_date, union_spanset_span, union_span_span
      Throws:
      Exception