Bestimmung der Zeitpunkte von Ereignissen
ulrich
2023-03-23 d20d989f5495492f1258c8313db7c19b429111a3
commit | author | age
66d68b 1 /*
U 2   Zeitrechnung - a class library to determine calendar events
3   Copyright (c) 1984-2022 Ulrich Hilger, http://uhilger.de
4
5   This program is free software: you can redistribute it and/or modify
6   it under the terms of the GNU Affero General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   This program is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU Affero General Public License for more details.
14
15   You should have received a copy of the GNU Affero General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 package de.uhilger.zeitrechnung.ereignis;
19
20 import de.uhilger.zeitrechnung.Datum;
21 import de.uhilger.zeitrechnung.Definition;
22 import java.util.List;
23
24 /**
25  * Die Schnittstelle Ereignis modelliert Kalenderereignisse in Form von 
26  * Ereignis-Typen und bis zu vier Ganzzahl-Parametern, die je nach 
27  * Ereignis-Typ den Zeitpunkt beschreiben, an dem ein Ereignis stattfindet.
28  * 
29  * Die Bedeutung und Verwendung der Parameter ist fuer jeden Ereignis-Typ 
30  * in der Klassenbeschreibung des jeweiligen Ereignis-Typs enthalten.
31  * 
32  * @author Ulrich Hilger
33  */
34 public interface Ereignis {
35
36   /* Typnummer fuer DatumEreignis */
37   public static final int TYP_DATUM = 1;
38   
39   /* Typnummer TagWocheMonatEreignis */
40   public static final int TYP_TAG_WOCHE_MONAT = 2;
41   
42   /** Typnummer fuer TagDatumEreignis */
43   public static final int TYP_TAG_DATUM = 3;
44   
45   /** Typnummer fuer OsterEreignis */
46   public static final int TYP_OSTERN = 4;
47   
48   /** Typnummer fuer JahreszeitEreignis */
49   public static final int TYP_JAHRESZEIT = 5;
50   
51   /** Typnummer fuer HebraeischesEreignis */
52   public static final int TYP_HEBRAEISCH = 6;
53
54   /** Typnummer fuer EinzelEreignis */
55   public static final int TYP_EINZEL = 7;
56   
57   /** Typnummer fuer MuslimischesEreignis */
58   public static final int TYP_MUSLIMISCH = 8;
59   
8cf849 60   /** Typnummer fuer JulianischesEreignis */
U 61   public static final int TYP_JULIANISCH = 9;
62   
d20d98 63   /** Typnummer fuer ChinesischesEreignis */
U 64   public static final int TYP_CHINESISCH = 10;
65   
2f6b9a 66   public static final int GREGORIANISCHER_KALENDER = 1;
U 67   public static final int JULIANISCHER_KALENDER = 2;
68   
66d68b 69   /**
U 70    * Den Typ des Ereignisses ermitteln
71    * 
72    * @return Ereignis.TYP_DATUM oder Ereignis.TYP_OSTERN oder 
73    * Ereignis.TYP_WOCHENTAG_DATUM usw. 
74    */
75   public int getTyp();
76   
77   /**
78    * Die Definition des Ereignisses ermitteln
79    * @return das Definitionsobjekt fuer dieses Ereignis
80    */
81   public Definition getDefinition();
82   
83   /**
84    * Die Definition dieses Ereignisses angeben
85    * @param definition  das Definitionsobjekt dieses Ereignisses
86    */
87   public void setDefinition(Definition definition);
88   
89   /**
90    * Die Tage eines Jahres im gregorianischen Kalendersystem 
91    * ermitteln, an denen das Ereignis stattfindet.
92    * 
93    * @param isoJahr das Jahr im gregorianischen Kalender, 
94    * fuer das ermittelt werden soll, an welchen Tagen das Ereignis stattfindet
95    * @return die Liste aus Datum-Objekten, die die Tage im gregorianischen 
96    * Kalender bezeichnet, an denen das Ereignis stattfindet
97    */
98   public List<Datum> getZeitpunkte(long isoJahr);
99 }