Module lbsntransform.output.hll.base.temporal

Hll bases for temporal facet

# -*- coding: utf-8 -*-

"""Hll bases for temporal facet
"""

import lbsnstructure as lbsn
from lbsntransform.output.hll import hll_bases as hll

from lbsntransform.output.hll.hll_functions import HLLFunctions as HLF
from lbsntransform.tools.helper_functions import HelperFunctions as HF

FACET = "temporal"


class TimestampBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="timestamp")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["timestamp"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["timestamp"] = post_date_time


class DateBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="date")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["date"] = None
        self.attrs["name"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # optional: add name of date here (e.g. "New Year's Eve")
            date = post_date_time.date()
            self.key["date"] = date


class MonthBase(hll.HllBase):
    """Extends Temporal Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="month")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month


class YearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="year")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year


class TimeofdayBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="timeofday")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["timeofday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # remove microseconds from datetime
            self.key["timeofday"] = post_date_time.time.replace(microsecond=0)


class HourofdayBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="hourofday")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["hourofday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # remove seconds and microseconds from datetime
            self.key["hourofday"] = post_date_time.time.replace(second=0, microsecond=0)


class DayofweekBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofweek")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["weekday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["weekday"] = post_date_time.weekday


class DayofmonthBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofmonth")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["dayofmonth"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["dayofmonth"] = post_date_time.day


class DayofyearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofyear")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["month"] = None
        self.key["day"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["month"] = post_date_time.month
            self.key["day"] = post_date_time.day


class MonthofyearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="monthofyear")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["monthofyear"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["monthofyear"] = post_date_time.month


class MonthHashtagBase(hll.HllBase):
    """Composite Base (c-base) that extends from HLL base Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_hashtag")

    def __init__(self, record: lbsn.Post = None, hashtag: str = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["hashtag"] = None
        if hashtag is None:
            # init empty
            return
        self.key["hashtag"] = hashtag.lower()
        if record is None:
            # init empty
            return
        if isinstance(record, lbsn.Post):
            post_date_time = HLF.merge_dates_post(record)
            if post_date_time:
                date = post_date_time.date()
                self.key["year"] = date.year
                self.key["month"] = date.month
        else:
            raise ValueError(
                "Parsing of MonthHashtagBase only supported " "from lbsn.Post"
            )


class MonthLatLngBase(hll.HllBase):
    """Composite Base (c-base) that extends from HLL base Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_latlng")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["latitude"] = None
        self.key["longitude"] = None
        self.attrs["latlng_geom"] = None
        if record is None:
            # init empty
            return
        if isinstance(record, lbsn.Post):
            post_date_time = HLF.merge_dates_post(record)
            if post_date_time is None:
                return
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month

            coordinates_geom = record.post_latlng
            coordinates = HF.get_coordinates_from_ewkt(coordinates_geom)
            self.key["latitude"] = coordinates.lat
            self.key["longitude"] = coordinates.lng
            # additional (optional) attributes
            # formatted ready for sql upsert
            self.attrs["latlng_geom"] = HF.return_ewkb_from_geotext(coordinates_geom)
        else:
            raise ValueError(
                "Parsing of MonthLatLngBase only supported " "from lbsn.Post"
            )


class MonthHashtagLatLngBase(hll.HllBase):
    """Composite Base (c-base) that extends from hll.HllBase Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_hashtag_latlng")

    def __init__(self, record: lbsn.Post = None, hashtag: str = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["hashtag"] = None
        self.key["latitude"] = None
        self.key["longitude"] = None
        self.attrs["latlng_geom"] = None
        if hashtag is None:
            # init empty
            return
        self.key["hashtag"] = hashtag.lower()

        if record is None:
            # init empty
            return

        if not isinstance(record, lbsn.Post):
            raise ValueError(
                "Parsing of MonthHashtagLatLngBase only supported " "from lbsn.Post"
            )
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month
        coordinates_geom = record.post_latlng
        coordinates = HF.get_coordinates_from_ewkt(coordinates_geom)
        self.key["latitude"] = coordinates.lat
        self.key["longitude"] = coordinates.lng
        # additional (optional) attributes
        # formatted ready for sql upsert
        self.attrs["latlng_geom"] = HF.return_ewkb_from_geotext(coordinates_geom)

Classes

class DateBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class DateBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="date")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["date"] = None
        self.attrs["name"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # optional: add name of date here (e.g. "New Year's Eve")
            date = post_date_time.date()
            self.key["date"] = date

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class DayofmonthBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class DayofmonthBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofmonth")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["dayofmonth"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["dayofmonth"] = post_date_time.day

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class DayofweekBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class DayofweekBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofweek")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["weekday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["weekday"] = post_date_time.weekday

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class DayofyearBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class DayofyearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="dayofyear")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["month"] = None
        self.key["day"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["month"] = post_date_time.month
            self.key["day"] = post_date_time.day

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class HourofdayBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class HourofdayBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="hourofday")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["hourofday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # remove seconds and microseconds from datetime
            self.key["hourofday"] = post_date_time.time.replace(second=0, microsecond=0)

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class MonthBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Temporal Base Class

Expand source code

class MonthBase(hll.HllBase):
    """Extends Temporal Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="month")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class MonthHashtagBase (record: lbsnstructure.topical_pb2.Post = None, hashtag: str = None)

Composite Base (c-base) that extends from HLL base Class

Note: To distinguish c-bases which are composite bases combining aspects from multiple facets, they're termed with a leading underscore

Expand source code

class MonthHashtagBase(hll.HllBase):
    """Composite Base (c-base) that extends from HLL base Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_hashtag")

    def __init__(self, record: lbsn.Post = None, hashtag: str = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["hashtag"] = None
        if hashtag is None:
            # init empty
            return
        self.key["hashtag"] = hashtag.lower()
        if record is None:
            # init empty
            return
        if isinstance(record, lbsn.Post):
            post_date_time = HLF.merge_dates_post(record)
            if post_date_time:
                date = post_date_time.date()
                self.key["year"] = date.year
                self.key["month"] = date.month
        else:
            raise ValueError(
                "Parsing of MonthHashtagBase only supported " "from lbsn.Post"
            )

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class MonthHashtagLatLngBase (record: lbsnstructure.topical_pb2.Post = None, hashtag: str = None)

Composite Base (c-base) that extends from hll.HllBase Class

Note: To distinguish c-bases which are composite bases combining aspects from multiple facets, they're termed with a leading underscore

Expand source code

class MonthHashtagLatLngBase(hll.HllBase):
    """Composite Base (c-base) that extends from hll.HllBase Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_hashtag_latlng")

    def __init__(self, record: lbsn.Post = None, hashtag: str = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["hashtag"] = None
        self.key["latitude"] = None
        self.key["longitude"] = None
        self.attrs["latlng_geom"] = None
        if hashtag is None:
            # init empty
            return
        self.key["hashtag"] = hashtag.lower()

        if record is None:
            # init empty
            return

        if not isinstance(record, lbsn.Post):
            raise ValueError(
                "Parsing of MonthHashtagLatLngBase only supported " "from lbsn.Post"
            )
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month
        coordinates_geom = record.post_latlng
        coordinates = HF.get_coordinates_from_ewkt(coordinates_geom)
        self.key["latitude"] = coordinates.lat
        self.key["longitude"] = coordinates.lng
        # additional (optional) attributes
        # formatted ready for sql upsert
        self.attrs["latlng_geom"] = HF.return_ewkb_from_geotext(coordinates_geom)

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class MonthLatLngBase (record: lbsnstructure.topical_pb2.Post = None)

Composite Base (c-base) that extends from HLL base Class

Note: To distinguish c-bases which are composite bases combining aspects from multiple facets, they're termed with a leading underscore

Expand source code

class MonthLatLngBase(hll.HllBase):
    """Composite Base (c-base) that extends from HLL base Class

    Note: To distinguish c-bases which are composite bases combining
    aspects from multiple facets, they're termed with a leading underscore
    """

    NAME = hll.HllBaseRef(facet=FACET, base="_month_latlng")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        self.key["month"] = None
        self.key["latitude"] = None
        self.key["longitude"] = None
        self.attrs["latlng_geom"] = None
        if record is None:
            # init empty
            return
        if isinstance(record, lbsn.Post):
            post_date_time = HLF.merge_dates_post(record)
            if post_date_time is None:
                return
            date = post_date_time.date()
            self.key["year"] = date.year
            self.key["month"] = date.month

            coordinates_geom = record.post_latlng
            coordinates = HF.get_coordinates_from_ewkt(coordinates_geom)
            self.key["latitude"] = coordinates.lat
            self.key["longitude"] = coordinates.lng
            # additional (optional) attributes
            # formatted ready for sql upsert
            self.attrs["latlng_geom"] = HF.return_ewkb_from_geotext(coordinates_geom)
        else:
            raise ValueError(
                "Parsing of MonthLatLngBase only supported " "from lbsn.Post"
            )

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class MonthofyearBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class MonthofyearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="monthofyear")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["monthofyear"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["monthofyear"] = post_date_time.month

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class TimeofdayBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class TimeofdayBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="timeofday")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["timeofday"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            # remove microseconds from datetime
            self.key["timeofday"] = post_date_time.time.replace(microsecond=0)

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class TimestampBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class TimestampBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="timestamp")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["timestamp"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            self.key["timestamp"] = post_date_time

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header

class YearBase (record: lbsnstructure.topical_pb2.Post = None)

Extends Base Class

Expand source code

class YearBase(hll.HllBase):
    """Extends Base Class"""

    NAME = hll.HllBaseRef(facet=FACET, base="year")

    def __init__(self, record: lbsn.Post = None):
        super().__init__()
        self.key["year"] = None
        if record is None:
            # init empty
            return
        post_date_time = HLF.merge_dates_post(record)
        if post_date_time:
            date = post_date_time.date()
            self.key["year"] = date.year

Ancestors

• HllBase

Class variables

var NAME

Inherited members

• HllBase:
  • get_attr_keys
  • get_key
  • get_key_value
  • get_metric_keys
  • get_prepared_record
  • get_sql_header