source: trunk/grails-app/domain/dbnp/studycapturing/Event.groovy @ 541

Last change on this file since 541 was 541, checked in by duh, 11 years ago
  • more indentation and documentation shite....
  • Property svn:keywords set to Date Rev Author
File size: 2.5 KB
Line 
1package dbnp.studycapturing
2
3import groovy.time.*
4
5/**
6 * The Event class describes an actual event, as it has happened to a certain subject. Often, the same event occurs
7 * to multiple subjects at the same time. That is why the actual description of the event is factored out into a more
8 * general EventDescription class. Events that also lead to sample(s) should be instantiated as SamplingEvents.
9 *
10 * Revision information:
11 * $Rev: 541 $
12 * $Author: duh $
13 * $Date: 2010-06-08 13:13:20 +0000 (di, 08 jun 2010) $
14 */
15class Event extends TemplateEntity implements Serializable {
16        long startTime
17        long endTime
18
19        /**
20         * Constraints
21         */
22        static constraints = {
23                endTime(validator: { fields, obj, errors ->
24                        def error = false
25
26                        // endTime must be >= the startTime
27                        if (fields && fields.compareTo(obj.startTime) < 0) {
28                                error = true
29                                errors.rejectValue(
30                                        'endTime',
31                                        'event.endTime.greaterThanStartTime',
32                                        ['endTime', fields] as Object[],
33                                        'End time should be greater than or equal to the Start Time'
34                                )
35                        }
36
37                        return (!error)
38                })
39        }
40
41        /**
42         * return the domain fields for this domain class
43         * @return List
44         */
45        static List<TemplateField> giveDomainFields() { return Event.domainFields }
46
47        // TODO: Kees start documenting your code
48        static final List<TemplateField> domainFields = [
49                new TemplateField(
50                        name: 'startTime',
51                        type: TemplateFieldType.RELTIME),
52                new TemplateField(
53                        name: 'endTime',
54                        type: TemplateFieldType.RELTIME)
55        ]
56
57        def getDuration() {
58                return new RelTime(startTime, endTime);
59        }
60
61        /**
62         * get a prettified duration
63         * @return String
64         */
65        static def getPrettyDuration(RelTime duration) {
66                return duration.toPrettyRoundedString();
67        }
68
69        // TODO: Kees start documenting your code
70        def getPrettyDuration() {
71                getPrettyDuration(getDuration())
72        }
73
74        // TODO: Kees start documenting your code
75        def getDurationString() {
76                def d = getDuration()
77                return getDuration().toPrettyString();
78        }
79
80        // TODO: Kees start documenting your code
81        def getShortDuration() {
82                def d = getDuration()
83                return getDuration().toString();
84        }
85
86        // TODO: Kees start documenting your code
87        def isSamplingEvent() {
88                return (this instanceof SamplingEvent)
89        }
90
91        // TODO: Kees start documenting your code
92        def belongsToGroup(Set<EventGroup> groups) {
93                def eventFound = false;
94                def that = this;
95                groups.each { eventgroup ->
96                        if (!eventFound) {
97                                eventFound = (that.id in eventgroup.events.id);
98                        }
99                }
100
101                return eventFound;
102        }
103
104        // TODO: Kees start documenting your code
105        def String toString() {
106                return fieldExists('Description') ? getFieldValue('Description') : ""
107        }
108}
Note: See TracBrowser for help on using the repository browser.