File: Sql.java

package info (click to toggle)
castor 1.3.2-4
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 44,968 kB
  • sloc: java: 206,032; xml: 95,088; sql: 14,460; sh: 365; makefile: 43
file content (722 lines) | stat: -rw-r--r-- 19,323 bytes parent folder | download | duplicates (4)
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 1.3.1</a>, using an XML
 * Schema.
 * $Id$
 */

package org.exolab.castor.mapping.xml;

/**
 * The 'sql' element is used to store information about the
 * database 
 *  column to which a Java object is mapped to.
 *  
 * 
 * @version $Revision$ $Date$
 */
@SuppressWarnings("serial")
public class Sql implements java.io.Serializable {


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * An optional attribute used to store the name of the column
     * in 
     *  the database table.
     *  
     */
    private java.util.List<java.lang.String> _name;

    /**
     * An optional attibute used to specify the DB-specific type of
     * the column.
     *  
     */
    private java.lang.String _type;

    /**
     * An optional attribute to specify the name of the bridge
     * table 
     *  containing the primary keys of the object on each side of
     * the 
     *  many to many relationship.
     *  
     */
    private java.lang.String _manyTable;

    /**
     * An optional attribute to specidy name of the columns that
     * holds 
     *  the foreign key to this object. That column is in the
     * database 
     *  table that stores objects of the Java type of this field.
     *  
     */
    private java.util.List<java.lang.String> _manyKey;

    /**
     * An optional attribute to specify cascading support; possible
     * values are
     *  'none', 'all', 'create', 'delete' and 'update'; it is
     * possible to use more than one
     *  of those values (when not using 'all' or 'none'), using
     * whitespace as a 
     *  delimiter (as in 'create delete').
     *  
     */
    private java.lang.String _cascading;

    /**
     * Field _readOnly.
     */
    private boolean _readOnly = false;

    /**
     * keeps track of state for field: _readOnly
     */
    private boolean _has_readOnly;

    /**
     * Field _transient.
     */
    private boolean _transient;

    /**
     * keeps track of state for field: _transient
     */
    private boolean _has_transient;

    /**
     * Field _dirty.
     */
    private org.exolab.castor.mapping.xml.types.SqlDirtyType _dirty = org.exolab.castor.mapping.xml.types.SqlDirtyType.fromValue("check");


      //----------------/
     //- Constructors -/
    //----------------/

    public Sql() {
        super();
        this._name = new java.util.ArrayList<java.lang.String>();
        this._manyKey = new java.util.ArrayList<java.lang.String>();
        setDirty(org.exolab.castor.mapping.xml.types.SqlDirtyType.fromValue("check"));
    }


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * 
     * 
     * @param vManyKey
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void addManyKey(
            final java.lang.String vManyKey)
    throws java.lang.IndexOutOfBoundsException {
        this._manyKey.add(vManyKey);
    }

    /**
     * 
     * 
     * @param index
     * @param vManyKey
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void addManyKey(
            final int index,
            final java.lang.String vManyKey)
    throws java.lang.IndexOutOfBoundsException {
        this._manyKey.add(index, vManyKey);
    }

    /**
     * 
     * 
     * @param vName
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void addName(
            final java.lang.String vName)
    throws java.lang.IndexOutOfBoundsException {
        this._name.add(vName);
    }

    /**
     * 
     * 
     * @param index
     * @param vName
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void addName(
            final int index,
            final java.lang.String vName)
    throws java.lang.IndexOutOfBoundsException {
        this._name.add(index, vName);
    }

    /**
     */
    public void deleteReadOnly(
    ) {
        this._has_readOnly= false;
    }

    /**
     */
    public void deleteTransient(
    ) {
        this._has_transient= false;
    }

    /**
     * Method enumerateManyKey.
     * 
     * @return an Enumeration over all possible elements of this
     * collection
     */
    public java.util.Enumeration<? extends java.lang.String> enumerateManyKey(
    ) {
        return java.util.Collections.enumeration(this._manyKey);
    }

    /**
     * Method enumerateName.
     * 
     * @return an Enumeration over all possible elements of this
     * collection
     */
    public java.util.Enumeration<? extends java.lang.String> enumerateName(
    ) {
        return java.util.Collections.enumeration(this._name);
    }

    /**
     * Returns the value of field 'cascading'. The field
     * 'cascading' has the following description: An optional
     * attribute to specify cascading support; possible values are
     *  'none', 'all', 'create', 'delete' and 'update'; it is
     * possible to use more than one
     *  of those values (when not using 'all' or 'none'), using
     * whitespace as a 
     *  delimiter (as in 'create delete').
     *  
     * 
     * @return the value of field 'Cascading'.
     */
    public java.lang.String getCascading(
    ) {
        return this._cascading;
    }

    /**
     * Returns the value of field 'dirty'.
     * 
     * @return the value of field 'Dirty'.
     */
    public org.exolab.castor.mapping.xml.types.SqlDirtyType getDirty(
    ) {
        return this._dirty;
    }

    /**
     * Method getManyKey.
     * 
     * @param index
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     * @return the value of the java.lang.String at the given index
     */
    public java.lang.String getManyKey(
            final int index)
    throws java.lang.IndexOutOfBoundsException {
        // check bounds for index
        if (index < 0 || index >= this._manyKey.size()) {
            throw new IndexOutOfBoundsException("getManyKey: Index value '" + index + "' not in range [0.." + (this._manyKey.size() - 1) + "]");
        }

        return (java.lang.String) _manyKey.get(index);
    }

    /**
     * Method getManyKey.Returns the contents of the collection in
     * an Array.  <p>Note:  Just in case the collection contents
     * are changing in another thread, we pass a 0-length Array of
     * the correct type into the API call.  This way we <i>know</i>
     * that the Array returned is of exactly the correct length.
     * 
     * @return this collection as an Array
     */
    public java.lang.String[] getManyKey(
    ) {
        java.lang.String[] array = new java.lang.String[0];
        return (java.lang.String[]) this._manyKey.toArray(array);
    }

    /**
     * Method getManyKeyCount.
     * 
     * @return the size of this collection
     */
    public int getManyKeyCount(
    ) {
        return this._manyKey.size();
    }

    /**
     * Returns the value of field 'manyTable'. The field
     * 'manyTable' has the following description: An optional
     * attribute to specify the name of the bridge table 
     *  containing the primary keys of the object on each side of
     * the 
     *  many to many relationship.
     *  
     * 
     * @return the value of field 'ManyTable'.
     */
    public java.lang.String getManyTable(
    ) {
        return this._manyTable;
    }

    /**
     * Method getName.
     * 
     * @param index
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     * @return the value of the java.lang.String at the given index
     */
    public java.lang.String getName(
            final int index)
    throws java.lang.IndexOutOfBoundsException {
        // check bounds for index
        if (index < 0 || index >= this._name.size()) {
            throw new IndexOutOfBoundsException("getName: Index value '" + index + "' not in range [0.." + (this._name.size() - 1) + "]");
        }

        return (java.lang.String) _name.get(index);
    }

    /**
     * Method getName.Returns the contents of the collection in an
     * Array.  <p>Note:  Just in case the collection contents are
     * changing in another thread, we pass a 0-length Array of the
     * correct type into the API call.  This way we <i>know</i>
     * that the Array returned is of exactly the correct length.
     * 
     * @return this collection as an Array
     */
    public java.lang.String[] getName(
    ) {
        java.lang.String[] array = new java.lang.String[0];
        return (java.lang.String[]) this._name.toArray(array);
    }

    /**
     * Method getNameCount.
     * 
     * @return the size of this collection
     */
    public int getNameCount(
    ) {
        return this._name.size();
    }

    /**
     * Returns the value of field 'readOnly'.
     * 
     * @return the value of field 'ReadOnly'.
     */
    public boolean getReadOnly(
    ) {
        return this._readOnly;
    }

    /**
     * Returns the value of field 'transient'.
     * 
     * @return the value of field 'Transient'.
     */
    public boolean getTransient(
    ) {
        return this._transient;
    }

    /**
     * Returns the value of field 'type'. The field 'type' has the
     * following description: An optional attibute used to specify
     * the DB-specific type of the column.
     *  
     * 
     * @return the value of field 'Type'.
     */
    public java.lang.String getType(
    ) {
        return this._type;
    }

    /**
     * Method hasReadOnly.
     * 
     * @return true if at least one ReadOnly has been added
     */
    public boolean hasReadOnly(
    ) {
        return this._has_readOnly;
    }

    /**
     * Method hasTransient.
     * 
     * @return true if at least one Transient has been added
     */
    public boolean hasTransient(
    ) {
        return this._has_transient;
    }

    /**
     * Returns the value of field 'readOnly'.
     * 
     * @return the value of field 'ReadOnly'.
     */
    public boolean isReadOnly(
    ) {
        return this._readOnly;
    }

    /**
     * Returns the value of field 'transient'.
     * 
     * @return the value of field 'Transient'.
     */
    public boolean isTransient(
    ) {
        return this._transient;
    }

    /**
     * Method isValid.
     * 
     * @return true if this object is valid according to the schema
     */
    public boolean isValid(
    ) {
        try {
            validate();
        } catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    }

    /**
     * Method iterateManyKey.
     * 
     * @return an Iterator over all possible elements in this
     * collection
     */
    public java.util.Iterator<? extends java.lang.String> iterateManyKey(
    ) {
        return this._manyKey.iterator();
    }

    /**
     * Method iterateName.
     * 
     * @return an Iterator over all possible elements in this
     * collection
     */
    public java.util.Iterator<? extends java.lang.String> iterateName(
    ) {
        return this._name.iterator();
    }

    /**
     * 
     * 
     * @param out
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void marshal(
            final java.io.Writer out)
    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        org.exolab.castor.xml.Marshaller.marshal(this, out);
    }

    /**
     * 
     * 
     * @param handler
     * @throws java.io.IOException if an IOException occurs during
     * marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     */
    public void marshal(
            final org.xml.sax.ContentHandler handler)
    throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        org.exolab.castor.xml.Marshaller.marshal(this, handler);
    }

    /**
     */
    public void removeAllManyKey(
    ) {
        this._manyKey.clear();
    }

    /**
     */
    public void removeAllName(
    ) {
        this._name.clear();
    }

    /**
     * Method removeManyKey.
     * 
     * @param vManyKey
     * @return true if the object was removed from the collection.
     */
    public boolean removeManyKey(
            final java.lang.String vManyKey) {
        boolean removed = _manyKey.remove(vManyKey);
        return removed;
    }

    /**
     * Method removeManyKeyAt.
     * 
     * @param index
     * @return the element removed from the collection
     */
    public java.lang.String removeManyKeyAt(
            final int index) {
        java.lang.Object obj = this._manyKey.remove(index);
        return (java.lang.String) obj;
    }

    /**
     * Method removeName.
     * 
     * @param vName
     * @return true if the object was removed from the collection.
     */
    public boolean removeName(
            final java.lang.String vName) {
        boolean removed = _name.remove(vName);
        return removed;
    }

    /**
     * Method removeNameAt.
     * 
     * @param index
     * @return the element removed from the collection
     */
    public java.lang.String removeNameAt(
            final int index) {
        java.lang.Object obj = this._name.remove(index);
        return (java.lang.String) obj;
    }

    /**
     * Sets the value of field 'cascading'. The field 'cascading'
     * has the following description: An optional attribute to
     * specify cascading support; possible values are
     *  'none', 'all', 'create', 'delete' and 'update'; it is
     * possible to use more than one
     *  of those values (when not using 'all' or 'none'), using
     * whitespace as a 
     *  delimiter (as in 'create delete').
     *  
     * 
     * @param cascading the value of field 'cascading'.
     */
    public void setCascading(
            final java.lang.String cascading) {
        this._cascading = cascading;
    }

    /**
     * Sets the value of field 'dirty'.
     * 
     * @param dirty the value of field 'dirty'.
     */
    public void setDirty(
            final org.exolab.castor.mapping.xml.types.SqlDirtyType dirty) {
        this._dirty = dirty;
    }

    /**
     * 
     * 
     * @param index
     * @param vManyKey
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void setManyKey(
            final int index,
            final java.lang.String vManyKey)
    throws java.lang.IndexOutOfBoundsException {
        // check bounds for index
        if (index < 0 || index >= this._manyKey.size()) {
            throw new IndexOutOfBoundsException("setManyKey: Index value '" + index + "' not in range [0.." + (this._manyKey.size() - 1) + "]");
        }

        this._manyKey.set(index, vManyKey);
    }

    /**
     * 
     * 
     * @param vManyKeyArray
     */
    public void setManyKey(
            final java.lang.String[] vManyKeyArray) {
        //-- copy array
        _manyKey.clear();

        for (int i = 0; i < vManyKeyArray.length; i++) {
                this._manyKey.add(vManyKeyArray[i]);
        }
    }

    /**
     * Sets the value of field 'manyTable'. The field 'manyTable'
     * has the following description: An optional attribute to
     * specify the name of the bridge table 
     *  containing the primary keys of the object on each side of
     * the 
     *  many to many relationship.
     *  
     * 
     * @param manyTable the value of field 'manyTable'.
     */
    public void setManyTable(
            final java.lang.String manyTable) {
        this._manyTable = manyTable;
    }

    /**
     * 
     * 
     * @param index
     * @param vName
     * @throws java.lang.IndexOutOfBoundsException if the index
     * given is outside the bounds of the collection
     */
    public void setName(
            final int index,
            final java.lang.String vName)
    throws java.lang.IndexOutOfBoundsException {
        // check bounds for index
        if (index < 0 || index >= this._name.size()) {
            throw new IndexOutOfBoundsException("setName: Index value '" + index + "' not in range [0.." + (this._name.size() - 1) + "]");
        }

        this._name.set(index, vName);
    }

    /**
     * 
     * 
     * @param vNameArray
     */
    public void setName(
            final java.lang.String[] vNameArray) {
        //-- copy array
        _name.clear();

        for (int i = 0; i < vNameArray.length; i++) {
                this._name.add(vNameArray[i]);
        }
    }

    /**
     * Sets the value of field 'readOnly'.
     * 
     * @param readOnly the value of field 'readOnly'.
     */
    public void setReadOnly(
            final boolean readOnly) {
        this._readOnly = readOnly;
        this._has_readOnly = true;
    }

    /**
     * Sets the value of field 'transient'.
     * 
     * @param _transient
     * @param transient the value of field 'transient'.
     */
    public void setTransient(
            final boolean _transient) {
        this._transient = _transient;
        this._has_transient = true;
    }

    /**
     * Sets the value of field 'type'. The field 'type' has the
     * following description: An optional attibute used to specify
     * the DB-specific type of the column.
     *  
     * 
     * @param type the value of field 'type'.
     */
    public void setType(
            final java.lang.String type) {
        this._type = type;
    }

    /**
     * Method unmarshal.
     * 
     * @param reader
     * @throws org.exolab.castor.xml.MarshalException if object is
     * null or if any SAXException is thrown during marshaling
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     * @return the unmarshaled org.exolab.castor.mapping.xml.Sql
     */
    public static org.exolab.castor.mapping.xml.Sql unmarshal(
            final java.io.Reader reader)
    throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException {
        return (org.exolab.castor.mapping.xml.Sql) org.exolab.castor.xml.Unmarshaller.unmarshal(org.exolab.castor.mapping.xml.Sql.class, reader);
    }

    /**
     * 
     * 
     * @throws org.exolab.castor.xml.ValidationException if this
     * object is an invalid instance according to the schema
     */
    public void validate(
    )
    throws org.exolab.castor.xml.ValidationException {
        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
        validator.validate(this);
    }

}