File: Glyph.java

package info (click to toggle)
libvamsas-client-java 0.2~git2011.10.17+1b42648-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 4,108 kB
  • ctags: 5,456
  • sloc: java: 32,555; xml: 417; sh: 47; makefile: 6
file content (300 lines) | stat: -rw-r--r-- 9,934 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
/*
 * 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;

/**
 * Discrete symbol - possibly graphically represented
 * 
 * 
 * @version $Revision$ $Date$
 */
public class Glyph extends uk.ac.vamsas.client.Vobject implements
    java.io.Serializable {

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

  /**
   * internal content storage
   */
  private java.lang.String _content = "";

  /**
   * specifies the symbol dictionary for this glyph - eg utf8 (the default),
   * aasecstr_3 or kd_hydrophobicity - the content is not validated so
   * applications must ensure they gracefully deal with invalid entries here
   */
  private java.lang.String _dict = "utf8";

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

  public Glyph() {
    super();
    setContent("");
    setDict("utf8");
  }

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

  /**
   * 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 Glyph) {

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

  /**
   * Returns the value of field 'content'. The field 'content' has the following
   * description: internal content storage
   * 
   * @return the value of field 'Content'.
   */
  public java.lang.String getContent() {
    return this._content;
  }

  /**
   * Returns the value of field 'dict'. The field 'dict' has the following
   * description: specifies the symbol dictionary for this glyph - eg utf8 (the
   * default), aasecstr_3 or kd_hydrophobicity - the content is not validated so
   * applications must ensure they gracefully deal with invalid entries here
   * 
   * @return the value of field 'Dict'.
   */
  public java.lang.String getDict() {
    return this._dict;
  }

  /**
   * 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 (_content != null
        && !org.castor.core.util.CycleBreaker.startingToCycle(_content)) {
      result = 37 * result + _content.hashCode();
      org.castor.core.util.CycleBreaker.releaseCycleHandle(_content);
    }
    if (_dict != null && !org.castor.core.util.CycleBreaker.startingToCycle(_dict)) {
      result = 37 * result + _dict.hashCode();
      org.castor.core.util.CycleBreaker.releaseCycleHandle(_dict);
    }

    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);
  }

  /**
   * Sets the value of field 'content'. The field 'content' has the following
   * description: internal content storage
   * 
   * @param content
   *          the value of field 'content'.
   */
  public void setContent(final java.lang.String content) {
    this._content = content;
  }

  /**
   * Sets the value of field 'dict'. The field 'dict' has the following
   * description: specifies the symbol dictionary for this glyph - eg utf8 (the
   * default), aasecstr_3 or kd_hydrophobicity - the content is not validated so
   * applications must ensure they gracefully deal with invalid entries here
   * 
   * @param dict
   *          the value of field 'dict'.
   */
  public void setDict(final java.lang.String dict) {
    this._dict = dict;
  }

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

}