Package org.biojavax

Interface DocRef

All Superinterfaces:
Changeable, Comparable
All Known Implementing Classes:
SimpleDocRef

public interface DocRef extends Comparable, Changeable
Represents a documentary reference. Relates to the reference table in BioSQL.
Since:
1.5
Author:
Mark Schreiber, Richard Holland
See Also:
  • Field Details

  • Method Details

    • getCrossref

      The document reference may refer to an object in another database. If so, this method will return that reference.
      Returns:
      Value of property crossref.
    • setCrossref

      void setCrossref(CrossRef crossref) throws ChangeVetoException
      The document reference may refer to an object in another database. Use this method to set that reference. Null will unset it.
      Parameters:
      crossref - New value of property crossref.
      Throws:
      ChangeVetoException - in case of objections.
    • getLocation

      Returns a textual description of the document reference. This field is immutable so should be set using the constructor of the implementing class.
      Returns:
      Value of property location.
    • getTitle

      Returns the title of the document reference.
      Returns:
      Value of property title.
    • getAuthors

      Returns the authors of the document reference. It will usually be in the form "Jones H., Bloggs J et al" or similar - a human-readable text value. Editors will have (ed.) appended, consortiums will have (consortium) appended.
      Returns:
      Value of property authors.
    • getAuthorList

      Returns the authors of the document reference as a set of DocRefAuthor implementation instances. This field is immutable so should be set using the constructor of the implementing class.
      Returns:
      The set of authors.
    • getCRC

      Returns a CRC64 checksum of this document reference, allowing for easy comparisons with other document references.
      Returns:
      Value of property CRC.
    • getRemark

      If remarks have been made about this document reference, this method will return them.
      Returns:
      Value of property Remark.
    • setRemark

      void setRemark(String Remark) throws ChangeVetoException
      Set the remarks for this document reference using this method. Remarks can be anything, it is derived from the equivalent field in the GenBank format.
      Parameters:
      Remark - New value of property Remark.
      Throws:
      ChangeVetoException - in case of objections.