1 // Do not edit this file! It was generated by Melati POEM's DSD preprocessor.
2
3 package org.melati.poem.generated;
4
5
6 import org.melati.poem.AccessPoemException;
7 import org.melati.poem.Column;
8 import org.melati.poem.Field;
9 import org.melati.poem.JdbcPersistent;
10 import org.melati.poem.PoemDatabaseTables;
11 import org.melati.poem.PoemTypeFactory;
12 import org.melati.poem.ValidationPoemException;
13 import org.melati.poem.ValueInfo;
14 import org.melati.poem.ValueInfoTable;
15
16
17 /**
18 * Melati POEM generated abstract base class for a <code>Persistent</code>
19 * <code>ValueInfo</code> Object.
20 *
21 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
22 */
23 public abstract class ValueInfoBase extends JdbcPersistent {
24
25
26 /**
27 * Retrieves the Database object.
28 *
29 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
30 * @return the database
31 */
32 public PoemDatabaseTables getPoemDatabaseTables() {
33 return (PoemDatabaseTables)getDatabase();
34 }
35
36
37 /**
38 * Retrieves the <code>ValueInfoTable</code> table
39 * which this <code>Persistent</code> is from.
40 *
41 * See org.melati.poem.prepro.TableDef#generatePersistentBaseJava
42 * @return the ValueInfoTable
43 */
44 @SuppressWarnings("unchecked")
45 public ValueInfoTable<ValueInfo> getValueInfoTable() {
46 return (ValueInfoTable<ValueInfo>)getTable();
47 }
48
49 @SuppressWarnings("unchecked")
50 private ValueInfoTable<ValueInfo> _getValueInfoTable() {
51 return (ValueInfoTable<ValueInfo>)getTable();
52 }
53
54 // Fields in this table
55 /**
56 * Display name - A user-friendly name for the field
57 */
58 protected String displayname;
59 /**
60 * description - A brief description of the field's function
61 */
62 protected String description;
63 /**
64 * User-editable - Whether it makes sense for the user to update the field's
65 * value
66 */
67 protected Boolean usereditable;
68 /**
69 * Type - The field's POEM type
70 */
71 protected Integer typefactory;
72 /**
73 * nullable - Whether the field can be empty
74 */
75 protected Boolean nullable;
76 /**
77 * size - For character fields, the maximum number of characters that can be
78 * stored, (-1 for unlimited)
79 */
80 protected Integer size;
81 /**
82 * Input-box width - A sensible width for text boxes used for entering the
83 * field, where appropriate
84 */
85 protected Integer width;
86 /**
87 * Input-box height - A sensible height for text boxes used for entering the
88 * field, where appropriate
89 */
90 protected Integer height;
91 /**
92 * Precision - Precision (total number of digits) for fixed-point numbers
93 */
94 protected Integer precision;
95 /**
96 * Scale - Scale (number of digits after the decimal) for fixed-point
97 * numbers
98 */
99 protected Integer scale;
100 /**
101 * Rendering information - The name of the Melati templet (if not the
102 * default) to use for input controls for the field
103 */
104 protected String renderinfo;
105 /**
106 * Range: low - The low end of the range of permissible values for the field
107 */
108 protected String rangelow_string;
109 /**
110 * Range: limit - The (exclusive) limit of the range of permissible values
111 * for the field
112 */
113 protected String rangelimit_string;
114
115
116 /**
117 * Retrieves the <code>Displayname</code> value, without locking,
118 * for this <code>ValueInfo</code> <code>Persistent</code>.
119 *
120 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
121 * @return the String displayname
122 */
123 public String getDisplayname_unsafe() {
124 return displayname;
125 }
126
127
128 /**
129 * Sets the <code>Displayname</code> value directly, without checking,
130 * for this ValueInfo <code>Persistent</code>.
131 *
132 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
133 * @param cooked the pre-validated value to set
134 */
135 public void setDisplayname_unsafe(String cooked) {
136 displayname = cooked;
137 }
138
139 /**
140 * Retrieves the Displayname value, with locking, for this
141 * <code>ValueInfo</code> <code>Persistent</code>.
142 * Field description:
143 * A user-friendly name for the field
144 *
145 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
146 * @throws AccessPoemException
147 * if the current <code>AccessToken</code>
148 * does not confer write access rights
149 * @return the value of the field <code>Displayname</code> for this
150 * <code>ValueInfo</code> <code>Persistent</code>
151 */
152
153 public String getDisplayname()
154 throws AccessPoemException {
155 readLock();
156 return getDisplayname_unsafe();
157 }
158
159
160 /**
161 * Sets the <code>Displayname</code> value, with checking, for this
162 * <code>ValueInfo</code> <code>Persistent</code>.
163 * Field description:
164 * A user-friendly name for the field
165 *
166 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
167 * @param cooked a validated <code>int</code>
168 * @throws AccessPoemException
169 * if the current <code>AccessToken</code>
170 * does not confer write access rights
171 * @throws ValidationPoemException
172 * if the value is not valid
173 */
174 public void setDisplayname(String cooked)
175 throws AccessPoemException, ValidationPoemException {
176 _getValueInfoTable().getDisplaynameColumn().
177 getType().assertValidCooked(cooked);
178 writeLock();
179 setDisplayname_unsafe(cooked);
180 }
181
182
183 /**
184 * Retrieves the <code>Displayname</code> value as a <code>Field</code>
185 * from this <code>ValueInfo</code> <code>Persistent</code>.
186 *
187 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
188 * @throws AccessPoemException
189 * if the current <code>AccessToken</code>
190 * does not confer write access rights
191 * @return the String displayname
192 */
193 public Field<String> getDisplaynameField() throws AccessPoemException {
194 Column<String> c = _getValueInfoTable().getDisplaynameColumn();
195 return new Field<String>((String)c.getRaw(this), c);
196 }
197
198
199 /**
200 * Retrieves the <code>Description</code> value, without locking,
201 * for this <code>ValueInfo</code> <code>Persistent</code>.
202 *
203 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
204 * @return the String description
205 */
206 public String getDescription_unsafe() {
207 return description;
208 }
209
210
211 /**
212 * Sets the <code>Description</code> value directly, without checking,
213 * for this ValueInfo <code>Persistent</code>.
214 *
215 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
216 * @param cooked the pre-validated value to set
217 */
218 public void setDescription_unsafe(String cooked) {
219 description = cooked;
220 }
221
222 /**
223 * Retrieves the Description value, with locking, for this
224 * <code>ValueInfo</code> <code>Persistent</code>.
225 * Field description:
226 * A brief description of the field's function
227 *
228 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
229 * @throws AccessPoemException
230 * if the current <code>AccessToken</code>
231 * does not confer write access rights
232 * @return the value of the field <code>Description</code> for this
233 * <code>ValueInfo</code> <code>Persistent</code>
234 */
235
236 public String getDescription()
237 throws AccessPoemException {
238 readLock();
239 return getDescription_unsafe();
240 }
241
242
243 /**
244 * Sets the <code>Description</code> value, with checking, for this
245 * <code>ValueInfo</code> <code>Persistent</code>.
246 * Field description:
247 * A brief description of the field's function
248 *
249 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
250 * @param cooked a validated <code>int</code>
251 * @throws AccessPoemException
252 * if the current <code>AccessToken</code>
253 * does not confer write access rights
254 * @throws ValidationPoemException
255 * if the value is not valid
256 */
257 public void setDescription(String cooked)
258 throws AccessPoemException, ValidationPoemException {
259 _getValueInfoTable().getDescriptionColumn().
260 getType().assertValidCooked(cooked);
261 writeLock();
262 setDescription_unsafe(cooked);
263 }
264
265
266 /**
267 * Retrieves the <code>Description</code> value as a <code>Field</code>
268 * from this <code>ValueInfo</code> <code>Persistent</code>.
269 *
270 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
271 * @throws AccessPoemException
272 * if the current <code>AccessToken</code>
273 * does not confer write access rights
274 * @return the String description
275 */
276 public Field<String> getDescriptionField() throws AccessPoemException {
277 Column<String> c = _getValueInfoTable().getDescriptionColumn();
278 return new Field<String>((String)c.getRaw(this), c);
279 }
280
281
282 /**
283 * Retrieves the <code>Usereditable</code> value, without locking,
284 * for this <code>ValueInfo</code> <code>Persistent</code>.
285 *
286 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
287 * @return the Boolean usereditable
288 */
289 public Boolean getUsereditable_unsafe() {
290 return usereditable;
291 }
292
293
294 /**
295 * Sets the <code>Usereditable</code> value directly, without checking,
296 * for this ValueInfo <code>Persistent</code>.
297 *
298 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
299 * @param cooked the pre-validated value to set
300 */
301 public void setUsereditable_unsafe(Boolean cooked) {
302 usereditable = cooked;
303 }
304
305 /**
306 * Retrieves the Usereditable value, with locking, for this
307 * <code>ValueInfo</code> <code>Persistent</code>.
308 * Field description:
309 * Whether it makes sense for the user to update the field's value
310 *
311 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
312 * @throws AccessPoemException
313 * if the current <code>AccessToken</code>
314 * does not confer write access rights
315 * @return the value of the field <code>Usereditable</code> for this
316 * <code>ValueInfo</code> <code>Persistent</code>
317 */
318
319 public Boolean getUsereditable()
320 throws AccessPoemException {
321 readLock();
322 return getUsereditable_unsafe();
323 }
324
325
326 /**
327 * Sets the <code>Usereditable</code> value, with checking, for this
328 * <code>ValueInfo</code> <code>Persistent</code>.
329 * Field description:
330 * Whether it makes sense for the user to update the field's value
331 *
332 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
333 * @param cooked a validated <code>int</code>
334 * @throws AccessPoemException
335 * if the current <code>AccessToken</code>
336 * does not confer write access rights
337 * @throws ValidationPoemException
338 * if the value is not valid
339 */
340 public void setUsereditable(Boolean cooked)
341 throws AccessPoemException, ValidationPoemException {
342 _getValueInfoTable().getUsereditableColumn().
343 getType().assertValidCooked(cooked);
344 writeLock();
345 setUsereditable_unsafe(cooked);
346 }
347
348 /**
349 * Sets the <code>Usereditable</code> value, with checking,
350 * from a <code>boolean</code>, for this
351 * <code>ValueInfo</code> <code>Persistent</code>.
352 * Field description:
353 * Whether it makes sense for the user to update the field's value
354 *
355 *
356 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
357 * @param cooked a <code>boolean</code>
358 * @throws AccessPoemException
359 * if the current <code>AccessToken</code>
360 * does not confer write access rights
361 * @throws ValidationPoemException
362 * if the value is not valid
363 */
364
365 public final void setUsereditable(boolean cooked)
366 throws AccessPoemException, ValidationPoemException {
367 setUsereditable(cooked ? Boolean.TRUE : Boolean.FALSE);
368 }
369
370
371 /**
372 * Retrieves the <code>Usereditable</code> value as a <code>Field</code>
373 * from this <code>ValueInfo</code> <code>Persistent</code>.
374 *
375 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
376 * @throws AccessPoemException
377 * if the current <code>AccessToken</code>
378 * does not confer write access rights
379 * @return the Boolean usereditable
380 */
381 public Field<Boolean> getUsereditableField() throws AccessPoemException {
382 Column<Boolean> c = _getValueInfoTable().getUsereditableColumn();
383 return new Field<Boolean>((Boolean)c.getRaw(this), c);
384 }
385
386
387 /**
388 * Retrieves the <code>Typefactory</code> value, without locking,
389 * for this <code>ValueInfo</code> <code>Persistent</code>.
390 *
391 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
392 * @return the Integer typefactory
393 */
394 public Integer getTypefactory_unsafe() {
395 return typefactory;
396 }
397
398
399 /**
400 * Sets the <code>Typefactory</code> value directly, without checking,
401 * for this ValueInfo <code>Persistent</code>.
402 *
403 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
404 * @param cooked the pre-validated value to set
405 */
406 public void setTypefactory_unsafe(Integer cooked) {
407 typefactory = cooked;
408 }
409
410 /**
411 * Retrieves the <code>Typefactory</code> value as an <code>Integer</code> for this <code>Column</code> of the <code>ValueInfo</code> <code>Table</code>.
412 * Field description:
413 * The field's POEM type
414 *
415 *
416 * Generated by org.melati.poem.prepro.ColumnTypeFieldDef#generateBaseMethods
417 * @throws AccessPoemException
418 * if the current <code>AccessToken</code>
419 * does not confer read access rights
420 * @return the <code>Typefactory</code> value of this <code>Column</code>
421 */
422
423 public Integer getTypefactoryCode()
424 throws AccessPoemException {
425 readLock();
426 return getTypefactory_unsafe();
427 }
428
429 /**
430 * Sets the <code>Integer</code> <code>Typefactory</code> value for this <code>ValueInfo</code> <code>Column</code> of the <code>ValueInfo</code> <code>Table</code>.
431 * Field description:
432 * The field's POEM type
433 *
434 *
435 * Generated by org.melati.poem.prepro.ColumnTypeFieldDef#generateBaseMethods
436 * @param raw the value to set
437 * @throws AccessPoemException
438 * if the current <code>AccessToken</code>
439 * does not confer write access rights
440 */
441
442 public void setTypefactoryCode(Integer raw)
443 throws AccessPoemException {
444 getValueInfoTable().getTypefactoryColumn().getType().assertValidRaw(raw);
445 writeLock();
446 setTypefactory_unsafe(raw);
447 }
448
449
450 /**
451 * Retrieves the <code>Typefactory</code> value as an <code>PoemTypeFactory</code> for this <code>Column</code> of the <code>ValueInfo</code> <code>Table</code>.
452 * Field description:
453 * The field's POEM type
454 *
455 *
456 * Generated by org.melati.poem.prepro.ColumnTypeFieldDef#generateBaseMethods
457 * @throws AccessPoemException
458 * if the current <code>AccessToken</code>
459 * does not confer read access rights
460 * @return the <code>Typefactory</code> value of this <code>Column</code>
461 */
462 public PoemTypeFactory getTypefactory()
463 throws AccessPoemException {
464 Integer code = getTypefactoryCode();
465 return code == null ? null :
466 PoemTypeFactory.forCode(getDatabase(), code.intValue());
467 }
468
469
470 /**
471 * Sets the <code>PoemTypeFactory</code> <code>Typefactory</code> value for this <code>ValueInfo</code> <code>Column</code> of the <code>ValueInfo</code> <code>Table</code>.
472 * Field description:
473 * The field's POEM type
474 *
475 *
476 * Generated by org.melati.poem.prepro.ColumnTypeFieldDef#generateBaseMethods
477 * @param cooked the value to set
478 * @throws AccessPoemException
479 * if the current <code>AccessToken</code>
480 * does not confer write access rights
481 */
482 public void setTypefactory(PoemTypeFactory cooked)
483 throws AccessPoemException {
484 setTypefactoryCode(cooked == null ? null : cooked.getCode());
485 }
486
487
488 /**
489 * Retrieves the <code>Typefactory</code> value as a <code>Field</code>
490 * from this <code>ValueInfo</code> <code>Persistent</code>.
491 *
492 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
493 * @throws AccessPoemException
494 * if the current <code>AccessToken</code>
495 * does not confer write access rights
496 * @return the Integer typefactory
497 */
498 public Field<Integer> getTypefactoryField() throws AccessPoemException {
499 Column<Integer> c = _getValueInfoTable().getTypefactoryColumn();
500 return new Field<Integer>((Integer)c.getRaw(this), c);
501 }
502
503
504 /**
505 * Retrieves the <code>Nullable</code> value, without locking,
506 * for this <code>ValueInfo</code> <code>Persistent</code>.
507 *
508 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
509 * @return the Boolean nullable
510 */
511 public Boolean getNullable_unsafe() {
512 return nullable;
513 }
514
515
516 /**
517 * Sets the <code>Nullable</code> value directly, without checking,
518 * for this ValueInfo <code>Persistent</code>.
519 *
520 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
521 * @param cooked the pre-validated value to set
522 */
523 public void setNullable_unsafe(Boolean cooked) {
524 nullable = cooked;
525 }
526
527 /**
528 * Retrieves the Nullable value, with locking, for this
529 * <code>ValueInfo</code> <code>Persistent</code>.
530 * Field description:
531 * Whether the field can be empty
532 *
533 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
534 * @throws AccessPoemException
535 * if the current <code>AccessToken</code>
536 * does not confer write access rights
537 * @return the value of the field <code>Nullable</code> for this
538 * <code>ValueInfo</code> <code>Persistent</code>
539 */
540
541 public Boolean getNullable()
542 throws AccessPoemException {
543 readLock();
544 return getNullable_unsafe();
545 }
546
547
548 /**
549 * Sets the <code>Nullable</code> value, with checking, for this
550 * <code>ValueInfo</code> <code>Persistent</code>.
551 * Field description:
552 * Whether the field can be empty
553 *
554 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
555 * @param cooked a validated <code>int</code>
556 * @throws AccessPoemException
557 * if the current <code>AccessToken</code>
558 * does not confer write access rights
559 * @throws ValidationPoemException
560 * if the value is not valid
561 */
562 public void setNullable(Boolean cooked)
563 throws AccessPoemException, ValidationPoemException {
564 _getValueInfoTable().getNullableColumn().
565 getType().assertValidCooked(cooked);
566 writeLock();
567 setNullable_unsafe(cooked);
568 }
569
570 /**
571 * Sets the <code>Nullable</code> value, with checking,
572 * from a <code>boolean</code>, for this
573 * <code>ValueInfo</code> <code>Persistent</code>.
574 * Field description:
575 * Whether the field can be empty
576 *
577 *
578 * Generated by org.melati.poem.prepro.BooleanFieldDef#generateBaseMethods
579 * @param cooked a <code>boolean</code>
580 * @throws AccessPoemException
581 * if the current <code>AccessToken</code>
582 * does not confer write access rights
583 * @throws ValidationPoemException
584 * if the value is not valid
585 */
586
587 public final void setNullable(boolean cooked)
588 throws AccessPoemException, ValidationPoemException {
589 setNullable(cooked ? Boolean.TRUE : Boolean.FALSE);
590 }
591
592
593 /**
594 * Retrieves the <code>Nullable</code> value as a <code>Field</code>
595 * from this <code>ValueInfo</code> <code>Persistent</code>.
596 *
597 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
598 * @throws AccessPoemException
599 * if the current <code>AccessToken</code>
600 * does not confer write access rights
601 * @return the Boolean nullable
602 */
603 public Field<Boolean> getNullableField() throws AccessPoemException {
604 Column<Boolean> c = _getValueInfoTable().getNullableColumn();
605 return new Field<Boolean>((Boolean)c.getRaw(this), c);
606 }
607
608
609 /**
610 * Retrieves the <code>Size</code> value, without locking,
611 * for this <code>ValueInfo</code> <code>Persistent</code>.
612 *
613 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
614 * @return the Integer size
615 */
616 public Integer getSize_unsafe() {
617 return size;
618 }
619
620
621 /**
622 * Sets the <code>Size</code> value directly, without checking,
623 * for this ValueInfo <code>Persistent</code>.
624 *
625 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
626 * @param cooked the pre-validated value to set
627 */
628 public void setSize_unsafe(Integer cooked) {
629 size = cooked;
630 }
631
632 /**
633 * Retrieves the Size value, with locking, for this
634 * <code>ValueInfo</code> <code>Persistent</code>.
635 * Field description:
636 * For character fields, the maximum number of characters that can be
637 * stored, (-1 for unlimited)
638 *
639 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
640 * @throws AccessPoemException
641 * if the current <code>AccessToken</code>
642 * does not confer write access rights
643 * @return the value of the field <code>Size</code> for this
644 * <code>ValueInfo</code> <code>Persistent</code>
645 */
646
647 public Integer getSize()
648 throws AccessPoemException {
649 readLock();
650 return getSize_unsafe();
651 }
652
653
654 /**
655 * Sets the <code>Size</code> value, with checking, for this
656 * <code>ValueInfo</code> <code>Persistent</code>.
657 * Field description:
658 * For character fields, the maximum number of characters that can be
659 * stored, (-1 for unlimited)
660 *
661 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
662 * @param cooked a validated <code>int</code>
663 * @throws AccessPoemException
664 * if the current <code>AccessToken</code>
665 * does not confer write access rights
666 * @throws ValidationPoemException
667 * if the value is not valid
668 */
669 public void setSize(Integer cooked)
670 throws AccessPoemException, ValidationPoemException {
671 _getValueInfoTable().getSizeColumn().
672 getType().assertValidCooked(cooked);
673 writeLock();
674 setSize_unsafe(cooked);
675 }
676
677 /**
678 * Sets the <code>Size</code> value, with checking, for this
679 * <code>ValueInfo</code> <code>Persistent</code>.
680 * Field description:
681 * For character fields, the maximum number of characters that can be
682 * stored, (-1 for unlimited)
683 *
684 *
685 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
686 * @param cooked a validated <code>int</code>
687 * @throws AccessPoemException
688 * if the current <code>AccessToken</code>
689 * does not confer write access rights
690 * @throws ValidationPoemException
691 * if the value is not valid
692 */
693
694 public final void setSize(int cooked)
695 throws AccessPoemException, ValidationPoemException {
696 setSize(new Integer(cooked));
697 }
698
699
700 /**
701 * Retrieves the <code>Size</code> value as a <code>Field</code>
702 * from this <code>ValueInfo</code> <code>Persistent</code>.
703 *
704 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
705 * @throws AccessPoemException
706 * if the current <code>AccessToken</code>
707 * does not confer write access rights
708 * @return the Integer size
709 */
710 public Field<Integer> getSizeField() throws AccessPoemException {
711 Column<Integer> c = _getValueInfoTable().getSizeColumn();
712 return new Field<Integer>((Integer)c.getRaw(this), c);
713 }
714
715
716 /**
717 * Retrieves the <code>Width</code> value, without locking,
718 * for this <code>ValueInfo</code> <code>Persistent</code>.
719 *
720 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
721 * @return the Integer width
722 */
723 public Integer getWidth_unsafe() {
724 return width;
725 }
726
727
728 /**
729 * Sets the <code>Width</code> value directly, without checking,
730 * for this ValueInfo <code>Persistent</code>.
731 *
732 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
733 * @param cooked the pre-validated value to set
734 */
735 public void setWidth_unsafe(Integer cooked) {
736 width = cooked;
737 }
738
739 /**
740 * Retrieves the Width value, with locking, for this
741 * <code>ValueInfo</code> <code>Persistent</code>.
742 * Field description:
743 * A sensible width for text boxes used for entering the field, where
744 * appropriate
745 *
746 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
747 * @throws AccessPoemException
748 * if the current <code>AccessToken</code>
749 * does not confer write access rights
750 * @return the value of the field <code>Width</code> for this
751 * <code>ValueInfo</code> <code>Persistent</code>
752 */
753
754 public Integer getWidth()
755 throws AccessPoemException {
756 readLock();
757 return getWidth_unsafe();
758 }
759
760
761 /**
762 * Sets the <code>Width</code> value, with checking, for this
763 * <code>ValueInfo</code> <code>Persistent</code>.
764 * Field description:
765 * A sensible width for text boxes used for entering the field, where
766 * appropriate
767 *
768 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
769 * @param cooked a validated <code>int</code>
770 * @throws AccessPoemException
771 * if the current <code>AccessToken</code>
772 * does not confer write access rights
773 * @throws ValidationPoemException
774 * if the value is not valid
775 */
776 public void setWidth(Integer cooked)
777 throws AccessPoemException, ValidationPoemException {
778 _getValueInfoTable().getWidthColumn().
779 getType().assertValidCooked(cooked);
780 writeLock();
781 setWidth_unsafe(cooked);
782 }
783
784 /**
785 * Sets the <code>Width</code> value, with checking, for this
786 * <code>ValueInfo</code> <code>Persistent</code>.
787 * Field description:
788 * A sensible width for text boxes used for entering the field, where
789 * appropriate
790 *
791 *
792 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
793 * @param cooked a validated <code>int</code>
794 * @throws AccessPoemException
795 * if the current <code>AccessToken</code>
796 * does not confer write access rights
797 * @throws ValidationPoemException
798 * if the value is not valid
799 */
800
801 public final void setWidth(int cooked)
802 throws AccessPoemException, ValidationPoemException {
803 setWidth(new Integer(cooked));
804 }
805
806
807 /**
808 * Retrieves the <code>Width</code> value as a <code>Field</code>
809 * from this <code>ValueInfo</code> <code>Persistent</code>.
810 *
811 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
812 * @throws AccessPoemException
813 * if the current <code>AccessToken</code>
814 * does not confer write access rights
815 * @return the Integer width
816 */
817 public Field<Integer> getWidthField() throws AccessPoemException {
818 Column<Integer> c = _getValueInfoTable().getWidthColumn();
819 return new Field<Integer>((Integer)c.getRaw(this), c);
820 }
821
822
823 /**
824 * Retrieves the <code>Height</code> value, without locking,
825 * for this <code>ValueInfo</code> <code>Persistent</code>.
826 *
827 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
828 * @return the Integer height
829 */
830 public Integer getHeight_unsafe() {
831 return height;
832 }
833
834
835 /**
836 * Sets the <code>Height</code> value directly, without checking,
837 * for this ValueInfo <code>Persistent</code>.
838 *
839 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
840 * @param cooked the pre-validated value to set
841 */
842 public void setHeight_unsafe(Integer cooked) {
843 height = cooked;
844 }
845
846 /**
847 * Retrieves the Height value, with locking, for this
848 * <code>ValueInfo</code> <code>Persistent</code>.
849 * Field description:
850 * A sensible height for text boxes used for entering the field, where
851 * appropriate
852 *
853 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
854 * @throws AccessPoemException
855 * if the current <code>AccessToken</code>
856 * does not confer write access rights
857 * @return the value of the field <code>Height</code> for this
858 * <code>ValueInfo</code> <code>Persistent</code>
859 */
860
861 public Integer getHeight()
862 throws AccessPoemException {
863 readLock();
864 return getHeight_unsafe();
865 }
866
867
868 /**
869 * Sets the <code>Height</code> value, with checking, for this
870 * <code>ValueInfo</code> <code>Persistent</code>.
871 * Field description:
872 * A sensible height for text boxes used for entering the field, where
873 * appropriate
874 *
875 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
876 * @param cooked a validated <code>int</code>
877 * @throws AccessPoemException
878 * if the current <code>AccessToken</code>
879 * does not confer write access rights
880 * @throws ValidationPoemException
881 * if the value is not valid
882 */
883 public void setHeight(Integer cooked)
884 throws AccessPoemException, ValidationPoemException {
885 _getValueInfoTable().getHeightColumn().
886 getType().assertValidCooked(cooked);
887 writeLock();
888 setHeight_unsafe(cooked);
889 }
890
891 /**
892 * Sets the <code>Height</code> value, with checking, for this
893 * <code>ValueInfo</code> <code>Persistent</code>.
894 * Field description:
895 * A sensible height for text boxes used for entering the field, where
896 * appropriate
897 *
898 *
899 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
900 * @param cooked a validated <code>int</code>
901 * @throws AccessPoemException
902 * if the current <code>AccessToken</code>
903 * does not confer write access rights
904 * @throws ValidationPoemException
905 * if the value is not valid
906 */
907
908 public final void setHeight(int cooked)
909 throws AccessPoemException, ValidationPoemException {
910 setHeight(new Integer(cooked));
911 }
912
913
914 /**
915 * Retrieves the <code>Height</code> value as a <code>Field</code>
916 * from this <code>ValueInfo</code> <code>Persistent</code>.
917 *
918 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
919 * @throws AccessPoemException
920 * if the current <code>AccessToken</code>
921 * does not confer write access rights
922 * @return the Integer height
923 */
924 public Field<Integer> getHeightField() throws AccessPoemException {
925 Column<Integer> c = _getValueInfoTable().getHeightColumn();
926 return new Field<Integer>((Integer)c.getRaw(this), c);
927 }
928
929
930 /**
931 * Retrieves the <code>Precision</code> value, without locking,
932 * for this <code>ValueInfo</code> <code>Persistent</code>.
933 *
934 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
935 * @return the Integer precision
936 */
937 public Integer getPrecision_unsafe() {
938 return precision;
939 }
940
941
942 /**
943 * Sets the <code>Precision</code> value directly, without checking,
944 * for this ValueInfo <code>Persistent</code>.
945 *
946 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
947 * @param cooked the pre-validated value to set
948 */
949 public void setPrecision_unsafe(Integer cooked) {
950 precision = cooked;
951 }
952
953 /**
954 * Retrieves the Precision value, with locking, for this
955 * <code>ValueInfo</code> <code>Persistent</code>.
956 * Field description:
957 * Precision (total number of digits) for fixed-point numbers
958 *
959 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
960 * @throws AccessPoemException
961 * if the current <code>AccessToken</code>
962 * does not confer write access rights
963 * @return the value of the field <code>Precision</code> for this
964 * <code>ValueInfo</code> <code>Persistent</code>
965 */
966
967 public Integer getPrecision()
968 throws AccessPoemException {
969 readLock();
970 return getPrecision_unsafe();
971 }
972
973
974 /**
975 * Sets the <code>Precision</code> value, with checking, for this
976 * <code>ValueInfo</code> <code>Persistent</code>.
977 * Field description:
978 * Precision (total number of digits) for fixed-point numbers
979 *
980 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
981 * @param cooked a validated <code>int</code>
982 * @throws AccessPoemException
983 * if the current <code>AccessToken</code>
984 * does not confer write access rights
985 * @throws ValidationPoemException
986 * if the value is not valid
987 */
988 public void setPrecision(Integer cooked)
989 throws AccessPoemException, ValidationPoemException {
990 _getValueInfoTable().getPrecisionColumn().
991 getType().assertValidCooked(cooked);
992 writeLock();
993 setPrecision_unsafe(cooked);
994 }
995
996 /**
997 * Sets the <code>Precision</code> value, with checking, for this
998 * <code>ValueInfo</code> <code>Persistent</code>.
999 * Field description:
1000 * Precision (total number of digits) for fixed-point numbers
1001 *
1002 *
1003 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
1004 * @param cooked a validated <code>int</code>
1005 * @throws AccessPoemException
1006 * if the current <code>AccessToken</code>
1007 * does not confer write access rights
1008 * @throws ValidationPoemException
1009 * if the value is not valid
1010 */
1011
1012 public final void setPrecision(int cooked)
1013 throws AccessPoemException, ValidationPoemException {
1014 setPrecision(new Integer(cooked));
1015 }
1016
1017
1018 /**
1019 * Retrieves the <code>Precision</code> value as a <code>Field</code>
1020 * from this <code>ValueInfo</code> <code>Persistent</code>.
1021 *
1022 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1023 * @throws AccessPoemException
1024 * if the current <code>AccessToken</code>
1025 * does not confer write access rights
1026 * @return the Integer precision
1027 */
1028 public Field<Integer> getPrecisionField() throws AccessPoemException {
1029 Column<Integer> c = _getValueInfoTable().getPrecisionColumn();
1030 return new Field<Integer>((Integer)c.getRaw(this), c);
1031 }
1032
1033
1034 /**
1035 * Retrieves the <code>Scale</code> value, without locking,
1036 * for this <code>ValueInfo</code> <code>Persistent</code>.
1037 *
1038 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1039 * @return the Integer scale
1040 */
1041 public Integer getScale_unsafe() {
1042 return scale;
1043 }
1044
1045
1046 /**
1047 * Sets the <code>Scale</code> value directly, without checking,
1048 * for this ValueInfo <code>Persistent</code>.
1049 *
1050 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1051 * @param cooked the pre-validated value to set
1052 */
1053 public void setScale_unsafe(Integer cooked) {
1054 scale = cooked;
1055 }
1056
1057 /**
1058 * Retrieves the Scale value, with locking, for this
1059 * <code>ValueInfo</code> <code>Persistent</code>.
1060 * Field description:
1061 * Scale (number of digits after the decimal) for fixed-point numbers
1062 *
1063 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1064 * @throws AccessPoemException
1065 * if the current <code>AccessToken</code>
1066 * does not confer write access rights
1067 * @return the value of the field <code>Scale</code> for this
1068 * <code>ValueInfo</code> <code>Persistent</code>
1069 */
1070
1071 public Integer getScale()
1072 throws AccessPoemException {
1073 readLock();
1074 return getScale_unsafe();
1075 }
1076
1077
1078 /**
1079 * Sets the <code>Scale</code> value, with checking, for this
1080 * <code>ValueInfo</code> <code>Persistent</code>.
1081 * Field description:
1082 * Scale (number of digits after the decimal) for fixed-point numbers
1083 *
1084 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1085 * @param cooked a validated <code>int</code>
1086 * @throws AccessPoemException
1087 * if the current <code>AccessToken</code>
1088 * does not confer write access rights
1089 * @throws ValidationPoemException
1090 * if the value is not valid
1091 */
1092 public void setScale(Integer cooked)
1093 throws AccessPoemException, ValidationPoemException {
1094 _getValueInfoTable().getScaleColumn().
1095 getType().assertValidCooked(cooked);
1096 writeLock();
1097 setScale_unsafe(cooked);
1098 }
1099
1100 /**
1101 * Sets the <code>Scale</code> value, with checking, for this
1102 * <code>ValueInfo</code> <code>Persistent</code>.
1103 * Field description:
1104 * Scale (number of digits after the decimal) for fixed-point numbers
1105 *
1106 *
1107 * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods
1108 * @param cooked a validated <code>int</code>
1109 * @throws AccessPoemException
1110 * if the current <code>AccessToken</code>
1111 * does not confer write access rights
1112 * @throws ValidationPoemException
1113 * if the value is not valid
1114 */
1115
1116 public final void setScale(int cooked)
1117 throws AccessPoemException, ValidationPoemException {
1118 setScale(new Integer(cooked));
1119 }
1120
1121
1122 /**
1123 * Retrieves the <code>Scale</code> value as a <code>Field</code>
1124 * from this <code>ValueInfo</code> <code>Persistent</code>.
1125 *
1126 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1127 * @throws AccessPoemException
1128 * if the current <code>AccessToken</code>
1129 * does not confer write access rights
1130 * @return the Integer scale
1131 */
1132 public Field<Integer> getScaleField() throws AccessPoemException {
1133 Column<Integer> c = _getValueInfoTable().getScaleColumn();
1134 return new Field<Integer>((Integer)c.getRaw(this), c);
1135 }
1136
1137
1138 /**
1139 * Retrieves the <code>Renderinfo</code> value, without locking,
1140 * for this <code>ValueInfo</code> <code>Persistent</code>.
1141 *
1142 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1143 * @return the String renderinfo
1144 */
1145 public String getRenderinfo_unsafe() {
1146 return renderinfo;
1147 }
1148
1149
1150 /**
1151 * Sets the <code>Renderinfo</code> value directly, without checking,
1152 * for this ValueInfo <code>Persistent</code>.
1153 *
1154 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1155 * @param cooked the pre-validated value to set
1156 */
1157 public void setRenderinfo_unsafe(String cooked) {
1158 renderinfo = cooked;
1159 }
1160
1161 /**
1162 * Retrieves the Renderinfo value, with locking, for this
1163 * <code>ValueInfo</code> <code>Persistent</code>.
1164 * Field description:
1165 * The name of the Melati templet (if not the default) to use for input
1166 * controls for the field
1167 *
1168 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1169 * @throws AccessPoemException
1170 * if the current <code>AccessToken</code>
1171 * does not confer write access rights
1172 * @return the value of the field <code>Renderinfo</code> for this
1173 * <code>ValueInfo</code> <code>Persistent</code>
1174 */
1175
1176 public String getRenderinfo()
1177 throws AccessPoemException {
1178 readLock();
1179 return getRenderinfo_unsafe();
1180 }
1181
1182
1183 /**
1184 * Sets the <code>Renderinfo</code> value, with checking, for this
1185 * <code>ValueInfo</code> <code>Persistent</code>.
1186 * Field description:
1187 * The name of the Melati templet (if not the default) to use for input
1188 * controls for the field
1189 *
1190 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1191 * @param cooked a validated <code>int</code>
1192 * @throws AccessPoemException
1193 * if the current <code>AccessToken</code>
1194 * does not confer write access rights
1195 * @throws ValidationPoemException
1196 * if the value is not valid
1197 */
1198 public void setRenderinfo(String cooked)
1199 throws AccessPoemException, ValidationPoemException {
1200 _getValueInfoTable().getRenderinfoColumn().
1201 getType().assertValidCooked(cooked);
1202 writeLock();
1203 setRenderinfo_unsafe(cooked);
1204 }
1205
1206
1207 /**
1208 * Retrieves the <code>Renderinfo</code> value as a <code>Field</code>
1209 * from this <code>ValueInfo</code> <code>Persistent</code>.
1210 *
1211 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1212 * @throws AccessPoemException
1213 * if the current <code>AccessToken</code>
1214 * does not confer write access rights
1215 * @return the String renderinfo
1216 */
1217 public Field<String> getRenderinfoField() throws AccessPoemException {
1218 Column<String> c = _getValueInfoTable().getRenderinfoColumn();
1219 return new Field<String>((String)c.getRaw(this), c);
1220 }
1221
1222
1223 /**
1224 * Retrieves the <code>Rangelow_string</code> value, without locking,
1225 * for this <code>ValueInfo</code> <code>Persistent</code>.
1226 *
1227 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1228 * @return the String rangelow_string
1229 */
1230 public String getRangelow_string_unsafe() {
1231 return rangelow_string;
1232 }
1233
1234
1235 /**
1236 * Sets the <code>Rangelow_string</code> value directly, without checking,
1237 * for this ValueInfo <code>Persistent</code>.
1238 *
1239 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1240 * @param cooked the pre-validated value to set
1241 */
1242 public void setRangelow_string_unsafe(String cooked) {
1243 rangelow_string = cooked;
1244 }
1245
1246 /**
1247 * Retrieves the Rangelow_string value, with locking, for this
1248 * <code>ValueInfo</code> <code>Persistent</code>.
1249 * Field description:
1250 * The low end of the range of permissible values for the field
1251 *
1252 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1253 * @throws AccessPoemException
1254 * if the current <code>AccessToken</code>
1255 * does not confer write access rights
1256 * @return the value of the field <code>Rangelow_string</code> for this
1257 * <code>ValueInfo</code> <code>Persistent</code>
1258 */
1259
1260 public String getRangelow_string()
1261 throws AccessPoemException {
1262 readLock();
1263 return getRangelow_string_unsafe();
1264 }
1265
1266
1267 /**
1268 * Sets the <code>Rangelow_string</code> value, with checking, for this
1269 * <code>ValueInfo</code> <code>Persistent</code>.
1270 * Field description:
1271 * The low end of the range of permissible values for the field
1272 *
1273 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1274 * @param cooked a validated <code>int</code>
1275 * @throws AccessPoemException
1276 * if the current <code>AccessToken</code>
1277 * does not confer write access rights
1278 * @throws ValidationPoemException
1279 * if the value is not valid
1280 */
1281 public void setRangelow_string(String cooked)
1282 throws AccessPoemException, ValidationPoemException {
1283 _getValueInfoTable().getRangelow_stringColumn().
1284 getType().assertValidCooked(cooked);
1285 writeLock();
1286 setRangelow_string_unsafe(cooked);
1287 }
1288
1289
1290 /**
1291 * Retrieves the <code>Rangelow_string</code> value as a <code>Field</code>
1292 * from this <code>ValueInfo</code> <code>Persistent</code>.
1293 *
1294 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1295 * @throws AccessPoemException
1296 * if the current <code>AccessToken</code>
1297 * does not confer write access rights
1298 * @return the String rangelow_string
1299 */
1300 public Field<String> getRangelow_stringField() throws AccessPoemException {
1301 Column<String> c = _getValueInfoTable().getRangelow_stringColumn();
1302 return new Field<String>((String)c.getRaw(this), c);
1303 }
1304
1305
1306 /**
1307 * Retrieves the <code>Rangelimit_string</code> value, without locking,
1308 * for this <code>ValueInfo</code> <code>Persistent</code>.
1309 *
1310 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1311 * @return the String rangelimit_string
1312 */
1313 public String getRangelimit_string_unsafe() {
1314 return rangelimit_string;
1315 }
1316
1317
1318 /**
1319 * Sets the <code>Rangelimit_string</code> value directly, without checking,
1320 * for this ValueInfo <code>Persistent</code>.
1321 *
1322 * see org.melati.poem.prepro.FieldDef#generateBaseMethods
1323 * @param cooked the pre-validated value to set
1324 */
1325 public void setRangelimit_string_unsafe(String cooked) {
1326 rangelimit_string = cooked;
1327 }
1328
1329 /**
1330 * Retrieves the Rangelimit_string value, with locking, for this
1331 * <code>ValueInfo</code> <code>Persistent</code>.
1332 * Field description:
1333 * The (exclusive) limit of the range of permissible values for the field
1334 *
1335 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1336 * @throws AccessPoemException
1337 * if the current <code>AccessToken</code>
1338 * does not confer write access rights
1339 * @return the value of the field <code>Rangelimit_string</code> for this
1340 * <code>ValueInfo</code> <code>Persistent</code>
1341 */
1342
1343 public String getRangelimit_string()
1344 throws AccessPoemException {
1345 readLock();
1346 return getRangelimit_string_unsafe();
1347 }
1348
1349
1350 /**
1351 * Sets the <code>Rangelimit_string</code> value, with checking, for this
1352 * <code>ValueInfo</code> <code>Persistent</code>.
1353 * Field description:
1354 * The (exclusive) limit of the range of permissible values for the field
1355 *
1356 * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods
1357 * @param cooked a validated <code>int</code>
1358 * @throws AccessPoemException
1359 * if the current <code>AccessToken</code>
1360 * does not confer write access rights
1361 * @throws ValidationPoemException
1362 * if the value is not valid
1363 */
1364 public void setRangelimit_string(String cooked)
1365 throws AccessPoemException, ValidationPoemException {
1366 _getValueInfoTable().getRangelimit_stringColumn().
1367 getType().assertValidCooked(cooked);
1368 writeLock();
1369 setRangelimit_string_unsafe(cooked);
1370 }
1371
1372
1373 /**
1374 * Retrieves the <code>Rangelimit_string</code> value as a <code>Field</code>
1375 * from this <code>ValueInfo</code> <code>Persistent</code>.
1376 *
1377 * see org.melati.poem.prepro.FieldDef#generateFieldCreator
1378 * @throws AccessPoemException
1379 * if the current <code>AccessToken</code>
1380 * does not confer write access rights
1381 * @return the String rangelimit_string
1382 */
1383 public Field<String> getRangelimit_stringField() throws AccessPoemException {
1384 Column<String> c = _getValueInfoTable().getRangelimit_stringColumn();
1385 return new Field<String>((String)c.getRaw(this), c);
1386 }
1387
1388 }
1389