File: DataSetAnnotations.java

package info (click to toggle)
libvamsas-client-java 0.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 4,112 kB
  • sloc: java: 32,555; xml: 415; makefile: 3
file content (448 lines) | stat: -rw-r--r-- 13,353 bytes parent folder | download | duplicates (3)
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
/*
 * This file is part of the Vamsas Client version 0.2. 
 * Copyright 2010 by Jim Procter, Iain Milne, Pierre Marguerite, 
 *  Andrew Waterhouse and Dominik Lindner.
 * 
 * Earlier versions have also been incorporated into Jalview version 2.4 
 * since 2008, and TOPALi version 2 since 2007.
 * 
 * The Vamsas Client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *  
 * The Vamsas Client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with the Vamsas Client.  If not, see <http://www.gnu.org/licenses/>.
 */
package uk.ac.vamsas.objects.core;

//---------------------------------/
//- Imported classes and packages -/
//---------------------------------/

import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;

/**
 * Class DataSetAnnotations.
 * 
 * @version $Revision$ $Date: 2007-06-28 14:51:44 +0100 (Thu, 28 Jun 2007)
 *          $
 */
public class DataSetAnnotations extends
    uk.ac.vamsas.objects.core.RangeAnnotation implements java.io.Serializable {

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

  /**
   * annotation is associated with a particular dataset sequence
   */
  private java.util.Vector _seqRef;

  /**
   * Field _provenance.
   */
  private uk.ac.vamsas.objects.core.Provenance _provenance;

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

  public DataSetAnnotations() {
    super();
    this._seqRef = new java.util.Vector();
  }

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

  /**
   * 
   * 
   * @param vSeqRef
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   */
  public void addSeqRef(final java.lang.Object vSeqRef)
      throws java.lang.IndexOutOfBoundsException {
    this._seqRef.addElement(vSeqRef);
  }

  /**
   * 
   * 
   * @param index
   * @param vSeqRef
   * @throws java.lang.IndexOutOfBoundsException
   *           if the index given is outside the bounds of the collection
   */
  public void addSeqRef(final int index, final java.lang.Object vSeqRef)
      throws java.lang.IndexOutOfBoundsException {
    this._seqRef.add(index, vSeqRef);
  }

  /**
   * Method enumerateSeqRef.
   * 
   * @return an Enumeration over all java.lang.Object elements
   */
  public java.util.Enumeration enumerateSeqRef() {
    return this._seqRef.elements();
  }

  /**
   * Overrides the java.lang.Object.equals method.
   * 
   * @param obj
   * @return true if the objects are equal.
   */
  public boolean equals(final java.lang.Object obj) {
    if (this == obj)
      return true;

    if (super.equals(obj) == false)
      return false;

    if (obj instanceof DataSetAnnotations) {

      DataSetAnnotations temp = (DataSetAnnotations) obj;
      boolean thcycle;
      boolean tmcycle;
      if (this._seqRef != null) {
        if (temp._seqRef == null)
          return false;
        if (this._seqRef != temp._seqRef) {
          thcycle = org.castor.core.util.CycleBreaker.startingToCycle(this._seqRef);
          tmcycle = org.castor.core.util.CycleBreaker.startingToCycle(temp._seqRef);
          if (thcycle != tmcycle) {
            if (!thcycle) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(this._seqRef);
            }
            ;
            if (!tmcycle) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._seqRef);
            }
            ;
            return false;
          }
          if (!thcycle) {
            if (!this._seqRef.equals(temp._seqRef)) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(this._seqRef);
              org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._seqRef);
              return false;
            }
            org.castor.core.util.CycleBreaker.releaseCycleHandle(this._seqRef);
            org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._seqRef);
          }
        }
      } else if (temp._seqRef != null)
        return false;
      if (this._provenance != null) {
        if (temp._provenance == null)
          return false;
        if (this._provenance != temp._provenance) {
          thcycle = org.castor.core.util.CycleBreaker
              .startingToCycle(this._provenance);
          tmcycle = org.castor.core.util.CycleBreaker
              .startingToCycle(temp._provenance);
          if (thcycle != tmcycle) {
            if (!thcycle) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(this._provenance);
            }
            ;
            if (!tmcycle) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._provenance);
            }
            ;
            return false;
          }
          if (!thcycle) {
            if (!this._provenance.equals(temp._provenance)) {
              org.castor.core.util.CycleBreaker.releaseCycleHandle(this._provenance);
              org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._provenance);
              return false;
            }
            org.castor.core.util.CycleBreaker.releaseCycleHandle(this._provenance);
            org.castor.core.util.CycleBreaker.releaseCycleHandle(temp._provenance);
          }
        }
      } else if (temp._provenance != null)
        return false;
      return true;
    }
    return false;
  }

  /**
   * Returns the value of field 'provenance'.
   * 
   * @return the value of field 'Provenance'.
   */
  public uk.ac.vamsas.objects.core.Provenance getProvenance() {
    return this._provenance;
  }

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

    return _seqRef.get(index);
  }

  /**
   * Method getSeqRef.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.Object[] getSeqRef() {
    java.lang.Object[] array = new java.lang.Object[0];
    return (java.lang.Object[]) this._seqRef.toArray(array);
  }

  /**
   * Method getSeqRefAsReference.Returns a reference to '_seqRef'. No type
   * checking is performed on any modifications to the Vector.
   * 
   * @return a reference to the Vector backing this class
   */
  public java.util.Vector getSeqRefAsReference() {
    return this._seqRef;
  }

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

  /**
   * Overrides the java.lang.Object.hashCode method.
   * <p>
   * The following steps came from <b>Effective Java Programming Language
   * Guide</b> by Joshua Bloch, Chapter 3
   * 
   * @return a hash code value for the object.
   */
  public int hashCode() {
    int result = super.hashCode();

    long tmp;
    if (_seqRef != null
        && !org.castor.core.util.CycleBreaker.startingToCycle(_seqRef)) {
      result = 37 * result + _seqRef.hashCode();
      org.castor.core.util.CycleBreaker.releaseCycleHandle(_seqRef);
    }
    if (_provenance != null
        && !org.castor.core.util.CycleBreaker.startingToCycle(_provenance)) {
      result = 37 * result + _provenance.hashCode();
      org.castor.core.util.CycleBreaker.releaseCycleHandle(_provenance);
    }

    return result;
  }

  /**
   * 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;
  }

  /**
   * 
   * 
   * @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 {
    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 {
    Marshaller.marshal(this, handler);
  }

  /**
     */
  public void removeAllSeqRef() {
    this._seqRef.clear();
  }

  /**
   * Method removeSeqRef.
   * 
   * @param vSeqRef
   * @return true if the object was removed from the collection.
   */
  public boolean removeSeqRef(final java.lang.Object vSeqRef) {
    boolean removed = _seqRef.remove(vSeqRef);
    return removed;
  }

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

  /**
   * Sets the value of field 'provenance'.
   * 
   * @param provenance
   *          the value of field 'provenance'.
   */
  public void setProvenance(
      final uk.ac.vamsas.objects.core.Provenance provenance) {
    this._provenance = provenance;
  }

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

    this._seqRef.set(index, vSeqRef);
  }

  /**
   * 
   * 
   * @param vSeqRefArray
   */
  public void setSeqRef(final java.lang.Object[] vSeqRefArray) {
    // -- copy array
    _seqRef.clear();

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

  /**
   * Sets the value of '_seqRef' by copying the given Vector. All elements will
   * be checked for type safety.
   * 
   * @param vSeqRefList
   *          the Vector to copy.
   */
  public void setSeqRef(final java.util.Vector vSeqRefList) {
    // copy vector
    this._seqRef.clear();

    this._seqRef.addAll(vSeqRefList);
  }

  /**
   * Sets the value of '_seqRef' by setting it to the given Vector. No type
   * checking is performed.
   * 
   * @deprecated
   * 
   * @param seqRefVector
   *          the Vector to set.
   */
  public void setSeqRefAsReference(final java.util.Vector seqRefVector) {
    this._seqRef = seqRefVector;
  }

  /**
   * 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 uk.ac.vamsas.objects.core.RangeType
   */
  public static uk.ac.vamsas.objects.core.RangeType unmarshal(
      final java.io.Reader reader)
      throws org.exolab.castor.xml.MarshalException,
      org.exolab.castor.xml.ValidationException {
    return (uk.ac.vamsas.objects.core.RangeType) Unmarshaller.unmarshal(
        uk.ac.vamsas.objects.core.DataSetAnnotations.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);
  }

}