pinyomi / eval / models.py

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
# -*- coding: utf-8 -*-
#----------------------------------------------------------------------------#
# models.py
# Zhihui Jin <zhihuijin@gmail.com>
# vim: ts=4 sw=4 sts=4 et tw=78:
# Fri Jan  5 11:49:51 JST 2007
#
#----------------------------------------------------------------------------#

""" The database models for evaluation
"""

#----------------------------------------------------------------------------#

from django.db import models
from www.settings import DEFAULT_ENCODING
import datetime

#----------------------------------------------------------------------------#
# JAPANESE LOOKUP (VIA CHINESE)
#----------------------------------------------------------------------------#

class PinyinStimulus(models.Model):
    """ Stimulus for word reading collection experiment
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The evaluation method, for unknown word reading collection, 
    # or for evaluating word lookup speed
    METHOD_CHOICES = (
            ('R', 'Reading'),
            ('L', 'Lookup'),
        )
    method = models.CharField(max_length=30, choices=METHOD_CHOICES)

    # The stimulus word to be evaluated
    word = models.CharField(max_length=30)

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'%s %s' % (self.method, self.word)

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        verbose_name_plural = 'pinyin stimuli'

#----------------------------------------------------------------------------#

class PinyinUser(models.Model):
    """ A table to keep user infomation for pinyin lookup. This table is for
        native Chinese testers only. The testers should have completed high
        school.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The name of the user (XXX do we need it?)
    #name = models.CharField(max_length=20, unique=True)

    # Have they studied Japanese before?
    studiedJapanese = models.BooleanField()

    # If so, how many years did they study?
    yearsOfStudy = models.IntegerField(null=True, blank=True)

    # What level did they reach in Japanese?
    LEVEL_CHOICES = (
            ('B', 'Beginner'),
            ('I', 'Intermediate'),
            ('A', 'Advanced'),
            ('N', 'Fluent or native-like'),
        )
    level = models.CharField(max_length=1, choices=LEVEL_CHOICES, null=True,
        blank=True)

    # The entire set of stimulus for reading collection evaluation
    readingStimulusSet = models.ManyToManyField(PinyinStimulus, 
            related_name='asReadingStimulus')

    # The entire set of stimulus for word lookup evaluation
    lookupStimulusSet  = models.ManyToManyField(PinyinStimulus,
            related_name='asLookupStimulus')

    # Start and end time for the experiment. These are not crucial, but might
    # be useful in case one user has very strange responses.
    startTime = models.DateTimeField(auto_now_add=True)
    endTime = models.DateTimeField(null=True, blank=True)

    # Open ended comment at the end.
    comment = models.TextField(null=True, blank=True)

    # The user's email address.
    emailAddress = models.EmailField(null=True, blank=True)

    # Whether this user was just for testing.
    testing = models.NullBooleanField()

    # Whether this user's responses contained an error.
    error = models.NullBooleanField()

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        hasFinished = bool(self.endTime)
        if hasFinished:
            finished = 'complete'
        else:
            timeDiff = datetime.datetime.now() - self.startTime
            minsSinceStarted = timeDiff.seconds / 60
            h, m = divmod(minsSinceStarted, 60)
            h += 24 * timeDiff.days
            finished = 'incomplete, %dh %dm' % (h, m)

        if not self.studiedJapanese:
            return u'%d. No experience (%s)' % (self.id, finished)
        else:
            return u'%d. %s years, %s (%s)' % (
                    self.id,
                    self.yearsOfStudy,
                    dict(self.LEVEL_CHOICES).get(self.level),
                    finished,
                )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass

#----------------------------------------------------------------------------#

class PinyinReadingResponse(models.Model):
    """ The readings the user gives when shown a Japanese word as stimulus.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The unique user id
    pinyinUser  = models.ForeignKey(PinyinUser)

    # The word they were asked for. 
    pinyinStimulus = models.ForeignKey(PinyinStimulus)

    # The readings that they guess when shown the stimulus word. Should
    # be comma separated. If the response is blank, then the user skipped this
    # stimulus.
    response = models.CharField(max_length=200, null=True, blank=True)

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'User%s, %s: %s' % (
                self.pinyinUser.id, 
                self.pinyinStimulus.id,
                self.response,
            )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass 


#----------------------------------------------------------------------------#

class PinyinLookupResponse(models.Model):
    """ The time and number of tries a user spend when shown a Japanese word as
    stimulus.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The unique user id
    pinyinUser  = models.ForeignKey(PinyinUser)

    # The word they were asked for. 
    pinyinStimulus = models.ForeignKey(PinyinStimulus)

    # The query that the user used to look up the stimulus word. Should
    # be comma separated. 
    queries = models.CharField(max_length=200, null=True, blank=True)

    # The time the user spend on looking up the word.
    time = models.FloatField()

    # The number of tries the user conduct 
    tries = models.IntegerField(null=True, blank=True)

    #------------------------------------------------------------------------#

    # Skipped if the user fail to find the stimulus word
    #skipped = models.BooleanField()


    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'User%s, %s: %s %f %s' % (
                self.pinyinUser.id, 
                self.pinyinStimulus.id,
                self.queries,
                self.time,
                self.tries,
            )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass 


#----------------------------------------------------------------------------#
# CHINESE LOOKUP (VIA JAPANESE)
#----------------------------------------------------------------------------#

class KanaStimulus(models.Model):
    """ Stimulus for word reading collection experiment
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The evaluation method, for unknown word reading collection, 
    # or for evaluating word lookup speed
    METHOD_CHOICES = (
            ('R', 'Reading'),
            ('L', 'Lookup'),
        )
    method = models.CharField(max_length=30, choices=METHOD_CHOICES)

    # The stimulus word to be evaluated
    word = models.CharField(max_length=30)

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'%s %s' % (self.method, self.word)

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        verbose_name_plural = 'kana stimuli'

#----------------------------------------------------------------------------#

class KanaUser(models.Model):
    """ A table to keep user infomation for kana lookup. This table is for
        native Japanese testers only. The testers should have completed high
        school.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The name of the user (XXX do we need it?)
    #name = models.CharField(max_length=20, unique=True)

    # Have they studied Chinese before?
    studiedChinese = models.BooleanField()

    # If so, how many years did they study?
    yearsOfStudy = models.IntegerField(null=True, blank=True)

    # What level did they reach in Chinese?
    LEVEL_CHOICES = (
            ('B', 'Beginner'),
            ('I', 'Intermediate'),
            ('A', 'Advanced'),
            ('N', 'Fluent or native-like'),
        )
    level = models.CharField(max_length=1, choices=LEVEL_CHOICES, null=True,
        blank=True)

    # The entire set of stimulus for reading collection evaluation
    readingStimulusSet = models.ManyToManyField(KanaStimulus, 
            related_name='asReadingStimulus')

    # The entire set of stimulus for word lookup evaluation
    lookupStimulusSet  = models.ManyToManyField(KanaStimulus,
            related_name='asLookupStimulus')

    # Start and end time for the experiment. These are not crucial, but might
    # be useful in case one user has very strange responses.
    startTime = models.DateTimeField(auto_now_add=True)
    endTime = models.DateTimeField(null=True, blank=True)

    # Open ended comment at the end.
    comment = models.TextField(null=True, blank=True)

    # The user's email address.
    emailAddress = models.EmailField(null=True, blank=True)

    # Whether this user was just for testing.
    testing = models.NullBooleanField()

    # Whether this user's responses contained an error.
    error = models.NullBooleanField()

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        hasFinished = bool(self.endTime)
        if hasFinished:
            finished = 'complete'
        else:
            timeDiff = datetime.datetime.now() - self.startTime
            minsSinceStarted = timeDiff.seconds / 60
            h, m = divmod(minsSinceStarted, 60)
            h += 24 * timeDiff.days
            finished = 'incomplete, %dh %dm' % (h, m)

        if not self.studiedChinese:
            return u'%d. No experience (%s)' % (self.id, finished)
        else:
            return u'%d. %s years, %s (%s)' % (
                    self.id,
                    self.yearsOfStudy,
                    dict(self.LEVEL_CHOICES).get(self.level),
                    finished,
                )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass

#----------------------------------------------------------------------------#

class KanaReadingResponse(models.Model):
    """ The readings the user gives when shown a Chinese word as stimulus.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The unique user id
    kanaUser  = models.ForeignKey(KanaUser)

    # The word they were asked for. 
    kanaStimulus = models.ForeignKey(KanaStimulus)

    # The readings that they guess when shown the stimulus word. Should
    # be comma separated. If the response is blank, then the user skipped this
    # stimulus.
    response = models.CharField(max_length=200, null=True, blank=True)

    #------------------------------------------------------------------------#

    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'User%s, %s: %s' % (
                self.kanaUser.id, 
                self.kanaStimulus.id,
                self.response,
            )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass 


#----------------------------------------------------------------------------#

class KanaLookupResponse(models.Model):
    """ The time and number of tries a user spend when shown a Chinese word as
    stimulus.
    """
    #------------------------------------------------------------------------#
    # PUBLIC
    #------------------------------------------------------------------------#

    # The unique user id
    kanaUser  = models.ForeignKey(KanaUser)

    # The word they were asked for. 
    kanaStimulus = models.ForeignKey(KanaStimulus)

    # The query that the user used to look up the stimulus word. Should
    # be comma separated. 
    queries = models.CharField(max_length=200, null=True, blank=True)

    # The time the user spend on looking up the word.
    time = models.FloatField()

    # The number of tries the user conduct 
    tries = models.IntegerField(null=True, blank=True)

    #------------------------------------------------------------------------#

    # Skipped if the user fail to find the stimulus word
    #skipped = models.BooleanField()


    def __str__(self):
        return unicode(self).encode(DEFAULT_ENCODING)

    #------------------------------------------------------------------------#

    def __unicode__(self):
        return u'User%s, %s: %s %f %s' % (
                self.kanaUser.id, 
                self.kanaStimulus.id,
                self.queries,
                self.time,
                self.tries,
            )

    #------------------------------------------------------------------------#

    class Admin:
        pass

    #------------------------------------------------------------------------#

    class Meta:
        pass 



# vim: ts=4 sw=4 sts=4 et tw=78:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.