Package org.biojava.bio.structure

Class PDBHeader

  • All Implemented Interfaces:
    PDBRecord
    public class PDBHeader
extends java.lang.Object
implements PDBRecord
    A class that contains PDB Header information.
    Since:
    1.6
    Author:
    Andreas Prlic

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static float DEFAULT_RESOLUTION  
      static java.lang.String newline  

    • Constructor Summary

      Constructors 
      Constructor Description
      PDBHeader()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(PDBHeader other)
      Compare two PDBHeader objects
      java.lang.String getClassification()  
      java.util.Date getDepDate()  
      java.lang.String getDescription()  
      java.lang.Long getId()
      Get the ID used by Hibernate.
      java.lang.String getIdCode()
      The PDB code for this protein structure.
      java.lang.String getMethod()  
      java.util.Date getModDate()  
      float getResolution()  
      java.lang.String getTechnique()  
      java.lang.String getTitle()  
      void setClassification​(java.lang.String classification)  
      void setDepDate​(java.util.Date depDate)  
      void setDescription​(java.lang.String description)  
      void setIdCode​(java.lang.String idCode)
      The PDB code for this protein structure.
      void setMethod​(java.lang.String method)  
      void setModDate​(java.util.Date modDate)  
      void setResolution​(float resolution)  
      void setTechnique​(java.lang.String technique)  
      void setTitle​(java.lang.String title)  
      java.lang.String toPDB()
      Return a PDB representation of the PDB Header
      void toPDB​(java.lang.StringBuffer buf)
      Appends a PDB representation of the PDB header to the provided StringBuffer
      java.lang.String toString()
      String representation

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • newline

        public static final java.lang.String newline

    • Constructor Detail

      • PDBHeader

        public PDBHeader()

    • Method Detail

      • toString

        public java.lang.String toString()
        String representation
        Overrides:
        toString in class java.lang.Object

      • toPDB

        public java.lang.String toPDB()
        Return a PDB representation of the PDB Header
        Specified by:
        toPDB in interface PDBRecord
        Returns:
        a PDB file style display

      • toPDB

        public void toPDB​(java.lang.StringBuffer buf)
        Appends a PDB representation of the PDB header to the provided StringBuffer
        Specified by:
        toPDB in interface PDBRecord
        Parameters:
        buf -

      • getId

        public java.lang.Long getId()
        Get the ID used by Hibernate.
        Returns:
        the ID used by Hibernate
        See Also:
        setId(Long)

      • equals

        public boolean equals​(PDBHeader other)
        Compare two PDBHeader objects
        Parameters:
        other - a PDBHeader object to compare this one to.
        Returns:
        true if they are equal or false if they are not.

      • getIdCode

        public java.lang.String getIdCode()
        The PDB code for this protein structure.
        Returns:
        the PDB identifier
        See Also:
        setIdCode(String)

      • setIdCode

        public void setIdCode​(java.lang.String idCode)
        The PDB code for this protein structure.
        Parameters:
        idCode - the PDB identifier
        See Also:
        getIdCode()

      • getClassification

        public java.lang.String getClassification()

      • setClassification

        public void setClassification​(java.lang.String classification)

      • getDepDate

        public java.util.Date getDepDate()

      • setDepDate

        public void setDepDate​(java.util.Date depDate)

      • getTechnique

        public java.lang.String getTechnique()

      • setTechnique

        public void setTechnique​(java.lang.String technique)

      • getResolution

        public float getResolution()

      • setResolution

        public void setResolution​(float resolution)

      • getModDate

        public java.util.Date getModDate()

      • setModDate

        public void setModDate​(java.util.Date modDate)

      • getMethod

        public java.lang.String getMethod()

      • setMethod

        public void setMethod​(java.lang.String method)

      • getTitle

        public java.lang.String getTitle()

      • setTitle

        public void setTitle​(java.lang.String title)

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)