René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Identifying a zman?","articleBody":"I would like some input on the most ergonomic API surface for identifying a given zman.\n\nI am developing [KosherKotlin](https://github.com/Sternbach-Software/KosherKotlin) in tandem with [BeautifulZmanim](https://github.com/Sternbach-Software/BeautifulZmanim), and the need came up to indicate a user-readable description of each zman, and to filter/group together similar zmanim (e.g. all opinions for a given zman, all zmanim for a given opinion, etc.).\n\nRight now, the function name and javadoc are the only info provided - which aren’t easily manipulated at runtime (not to mention the slight inconsistency in function naming which would make that even harder (e.g. alos60 vs. **minchaGedola30**~~Minutes~~)).\n\nI assume that this is something that most user-facing apps had to do, which would imply that it is the responsibility of the library (instead of everyone making their own library on top of the library).\n\nIdeally, the zman should also have some strongly-typed classification of how it was calculated (e.g. `if(zman.opinion instanceof ZmanOpinion.FixedMinutes) print(zman.opinion.minutes)`). This could be useful for translating the description into other languages (at the discretion of the library client), more in-depth user-facing explanations (ditto), grouping or filtering zmanim by their opinion/how they were calculated (not just what zman type they represent, such as latest shema), some simple data science/number-crunching, etc.\n\nI have already wrapped all public APIs in a Zman object (defined below) with a `ZmanType`. I am wondering if this should be translated to Java and ported upstream?\n\nMoshe Waisberg (author of Halachic Prayer Times Android) came up with 4 classifications for describing a zman to the user:\n-  “Day is $fixedMinutes minutes before sunrise / after sunset”\n-  “Day is $halachicMinutes minutes zmaniyos before sunrise / after sunset”\n-  “Day is $degrees˚ below sunrise / sunset”\n-  “According to $authority”\nIt Seems like there is 1 more:\n-  Widely accepted or only opinion\n\nSo far, these use-cases lead me to the following abstraction:\n-  Every zman is one of two types:\n  -  ValueBased: a zman that does not occur at a moment in time, but rather holds a duration/length of time (e.g. sha’ah zmanis)\n  -  DateBased: a zman that has a `momentOfOccurence`.\n    -  I (re)discovered after I came up with the two types that there is already a Zman.java object with 4 properties: \n label: string\n duration: long\n zman: Date\n description: string, \n-  Every zman has a ZmanOpinion, one of (as in Moshe Waisberg’s model): \n  -  FixedMinutes\n  - ZmaniyosMinutes\n  - Degrees\n  - Authority\n  - Unanimous\n-  Every zman has a ZmanType, (a user-friendly english and hebrew name is included here, but must be refactored into a localization mechanism). One of:\n- SHAA_ZMANIS(“Halachic hour”, “שעה זמנית“),\n     CHATZOS_HALAYLAH(“Halachic midnight”, “חצות הלילה“),\n     MISHMAR(“Watch”, “משמר“), //synonymous with אשמורת\n     ALOS(“Dawn”, “עלות השחר“),\n     MISHEYAKIR(“Earliest Tallis and Teffillin (Misheyakir)“, ” (משיכיר) טלית ותפילין הכי מוקדם“), //pardon the modern Hebrew הכי vs. ביותר\n     HANAITZ(“Sunrise”, “הנץ החמה“), //not NAITZ because the ה in Hanaitz is not a ה הידיעה (“the”), it is part of the participle (comparable to “הנצת“)\n     CHATZOS_HAYOM(“Halachic midday”, “חצות היום“),\n     MINCHA_GEDOLAH(“Greater Mincha”, “מנחה גדולה“), //any better translation? Just transliterate?\n     MINCHA_KETANAH(“Lesser Mincha”, “מנחה קטנה“), //any better translation? Just transliterate?\n     PLAG_HAMINCHA(“Plag Hamincha”, “פלג המנחה“), //should this be translated or transliterated?\n     SHKIAH(“Sunset”, “שקיעה“),\n     BAIN_HASHMASHOS(“Twilight”, “בין השמשות“),\n     TZAIS(“Nightfall”, “צאת הכוכבים“),\n     MOLAD(“New moon”, “מולד“), //accurate translation?\n \n     //Related to rituals:\n     SAMUCH_LEMINCHA_KETANA(“Close to Mincha Ketana”, “סמוך למנחה קטנה“), //see note on MINCHA_KETANAH\n     SOF_ZMAN_KRIAS_SHEMA(“Latest time to say Shema”, “סוף זמן קריאת שמע“),\n     SOF_ZMAN_TEFILLAH(“Latest time to daven Shacharis”, “סוף זמן תפילה“),\n     SOF_ZMAN_ACHILAS_CHAMETZ(“Latest time to eat Chametz”, “סוף זמן אכילת חמץ“),\n     SOF_ZMAN_BIUR_CHAMETZ(“Latest time to burn Chametz”, “סוף זמן ביעור חמץ“),\n     EARLIEST_MINCHA(“Earliest Mincha”, “מנחה הכי מוקדם“),\n     EARLIEST_KIDDUSH_LEVANA(“Earliest time to sanctify the moon”, “תחילת זמן קידוש לבנה“),\n     SOF_ZMAN_KIDDUSH_LEVANA(“Latest time to sanctify the moon”, “סוף זמן קידוש לבנה“),\n     CANDLE_LIGHTING(“Candle lighting”, “הדלקת נרות“)\n\nThe two edge-cases I saw in Moshe Waisberg’s classification and the possible solutions I see:\n-  what about when a zman has multiple originating authorities, or is known or held by several well-known authorities?\n  -  Put the first author to formulate the calculation.\n  - Put all authors\n  - Put the most well known author(s)\n - Put the most authoritative (e.g. I think R’ Moshe Feinstein is more authoritative for our generation than the Aruch Hashulchan)\n - Put the first + most well known, in case it is known by an author other than the first one (e.g “Komarno” zmanim were sometimes from much older sources)\n-  or it is according to one authority’s understanding of another authority’s opinion? (e.g. , Rabeinu Tam as 72 minutes, Rabeinu Tam  as 16.1 degrees, etc., or more complicated: R’Moshe’s understanding of the Magen Avraham as calculated using 18˚ to fixed local chatzos, 16.1˚,  etc.)\n-  or it does not fit into the neat boxes  defined by ZmanOpinion (e.g. sofZmanShmaAlos16Point1ToSunset)?\n  -  A general description\n  -  “Day starts at $startZman.description and ends at $endZman.description”\n  -  A map of ZmanType to ZmanOpinion (possible split into start and end - or before or after?)\n    -  e.g. plagAlosToSunset: \n      -  day starts at alos16Point1Degrees\n      - day ends at sunset, \n      -  sha’ah zmanis is calculated based on the opinion that the day is calculated from a alos16Point1Degrees of 16.1 degrees before sunrise to seaLevelSunset.\n     - bainHashmashosRT13Point5MinutesBefore7Point083Degrees\n       -  Rabeinu tam\n       -  FixedMinutes(13.5)\n       -  Before: 7.083 degrees\n\nWhat about when there is only one way to calculate a zman? What should the ZmanOpinion type be?\nAnd should authority names be in Hebrew (e.g. sefer names), transliterated English (for languages that need ASCII), etc.? Should they be standardized across ports?\nI am not sure which alternatives would be best, and would like input.","author":{"url":"https://github.com/Sternbach-Software","@type":"Person","name":"Sternbach-Software"},"datePublished":"2023-08-10T06:36:38.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/217/zmanim/issues/217"}