Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.bdgp.apps.dagedit.datamodel
Class Dbxref  view Dbxref download Dbxref.java

java.lang.Object
  extended byorg.bdgp.apps.dagedit.datamodel.Dbxref
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, java.io.Serializable, javax.swing.undo.StateEditable

public class Dbxref
extends java.lang.Object
implements java.lang.Cloneable, javax.swing.undo.StateEditable, java.io.Serializable, java.lang.Comparable


Field Summary
static int ANALOG
           
static int ANATOMICAL
           
protected  java.lang.String database
           
static int DEFINITION
           
protected  java.lang.String desc
           
protected  java.lang.String id
           
private static int idgen
           
protected  int privateid
           
static int SYNONYM
           
protected  Synonym targetSynonym
           
protected  int type
           
static int UNKNOWN
           
 
Fields inherited from interface javax.swing.undo.StateEditable
RCSID
 
Constructor Summary
Dbxref(java.lang.String database, java.lang.String id)
           
Dbxref(java.lang.String database, java.lang.String id, int type)
           
Dbxref(java.lang.String database, java.lang.String id, java.lang.String desc, int type)
           
Dbxref(java.lang.String database, java.lang.String id, java.lang.String desc, int type, Synonym targetSynonym)
           
 
Method Summary
 java.lang.Object clone()
          This method may be called to create a new copy of the Object.
 int compareTo(java.lang.Object o)
          Compares this object with another, and returns a numerical result based on the comparison.
 boolean equals(java.lang.Object in)
          Determine whether this Object is semantically equal to another Object.
 java.lang.String getDatabase()
           
 java.lang.String getDesc()
           
 java.lang.String getID()
           
 int getType()
           
static java.lang.String getTypeStringFromInt(int type)
           
 void restoreState(java.util.Hashtable in)
          Performs an edit action, taking any editable state information from the specified hash table.
 void setDatabase(java.lang.String database)
           
 void setDesc(java.lang.String desc)
           
 void setID(java.lang.String id)
           
 void setSynonym(Synonym syn)
           
 void setType(int type)
           
 void storeState(java.util.Hashtable in)
          Stores any editable state information into the specified hash table.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNKNOWN

public static final int UNKNOWN
See Also:
Constant Field Values

ANATOMICAL

public static final int ANATOMICAL
See Also:
Constant Field Values

SYNONYM

public static final int SYNONYM
See Also:
Constant Field Values

DEFINITION

public static final int DEFINITION
See Also:
Constant Field Values

ANALOG

public static final int ANALOG
See Also:
Constant Field Values

id

protected java.lang.String id

database

protected java.lang.String database

desc

protected java.lang.String desc

type

protected int type

targetSynonym

protected Synonym targetSynonym

idgen

private static int idgen

privateid

protected int privateid
Constructor Detail

Dbxref

public Dbxref(java.lang.String database,
              java.lang.String id)

Dbxref

public Dbxref(java.lang.String database,
              java.lang.String id,
              int type)

Dbxref

public Dbxref(java.lang.String database,
              java.lang.String id,
              java.lang.String desc,
              int type)

Dbxref

public Dbxref(java.lang.String database,
              java.lang.String id,
              java.lang.String desc,
              int type,
              Synonym targetSynonym)
Method Detail

getTypeStringFromInt

public static java.lang.String getTypeStringFromInt(int type)

setDesc

public void setDesc(java.lang.String desc)

getDesc

public java.lang.String getDesc()

setType

public void setType(int type)

getType

public int getType()

setSynonym

public void setSynonym(Synonym syn)

getID

public java.lang.String getID()

getDatabase

public java.lang.String getDatabase()

setID

public void setID(java.lang.String id)

setDatabase

public void setDatabase(java.lang.String database)

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).


compareTo

public int compareTo(java.lang.Object o)
Description copied from interface: java.lang.Comparable
Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

Specified by:
compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object in)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


clone

public java.lang.Object clone()
Description copied from class: java.lang.Object
This method may be called to create a new copy of the Object. The typical behavior is as follows:
  • o == o.clone() is false
  • o.getClass() == o.clone().getClass() is true
  • o.equals(o) is true

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object)>Object.equals(Object) 55 .

If the Object you call clone() on does not implement java.lang.Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 


storeState

public void storeState(java.util.Hashtable in)
Description copied from interface: javax.swing.undo.StateEditable
Stores any editable state information into the specified hash table.

Specified by:
storeState in interface javax.swing.undo.StateEditable

restoreState

public void restoreState(java.util.Hashtable in)
Description copied from interface: javax.swing.undo.StateEditable
Performs an edit action, taking any editable state information from the specified hash table.

Note to implementors of this interface: To increase efficiency, the StateEdit class StateEdit.removeRedundantState()>StateEdit.removeRedundantState() 55 removes redundant state information. Therefore, implementations of this interface must be prepared for the case where certain keys were stored into the table by StateEditable.storeState(java.util.Hashtable)>StateEditable.storeState(java.util.Hashtable) 55 , but are not present anymore when the restoreState method gets called.

Specified by:
restoreState in interface javax.swing.undo.StateEditable