edu.sdsc.mbt
Class StructureInfo

java.lang.Object
  extended byedu.sdsc.mbt.StructureComponent
      extended byedu.sdsc.mbt.StructureInfo
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class StructureInfo
extends StructureComponent
implements java.lang.Cloneable, java.io.Serializable

Implements a StructureComponent container for Structure information data. This information includes data such as authors, dates, and data sources.

See the "PROGRAMMING NOTE" section of the StructureComponent class.

Author:
John L. Moreland
See Also:
StructureComponent,

, Serialized Form


Field Summary
 
Fields inherited from class edu.sdsc.mbt.StructureComponent
structure
 
Constructor Summary
StructureInfo()
          Creates a new StructureInfo object and initializes the StructureComponent "structure" field.
 
Method Summary
 java.lang.Object clone()
          Clone this object.
 void copy(StructureComponent structureComponent)
          Copy all of the field values from the parameter object into "this".
 java.lang.String getAuthors()
          Get the authors of this entry.
static java.lang.String getClassName()
          This method returns the fully qualified name of this class.
 java.lang.String getCompoundName()
          Get the name of this macromolecular structure.
 java.lang.String getDeterminationMethod()
          Get the exerimental method used to determine this compound.
 java.lang.String getIdCode()
          Get the PDB-ID code by which this entry is registered.
 java.lang.String getPrimaryReference()
          Get the primary citation reference for this entry.
 void getReleaseDate(int[] date)
          Get the date on which this entry was released.
 java.lang.String getSourceSpecies()
          Get the source species of this compound.
 java.lang.String getStructureComponentType()
          This method returns the fully qualified name of this class.
 boolean isVisible()
           
 void setAuthors(java.lang.String names)
          Set the authors of this entry.
 void setCompoundName(java.lang.String name)
          Set the name of this macromolecular structure.
 void setDeterminationMethod(java.lang.String method)
          Set the exerimental method used to determine this compound.
 void setIdCode(java.lang.String code)
          Set the PDB-ID code by which this entry is registered.
 void setPrimaryReference(java.lang.String reference)
          Set the primary citation reference for this entry.
 void setReleaseDate(int[] date)
          Set the date on which this entry was released.
 void setSourceSpecies(java.lang.String species)
          Set the source species of this compound.
 
Methods inherited from class edu.sdsc.mbt.StructureComponent
getStructure, setStructure
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StructureInfo

public StructureInfo()
Creates a new StructureInfo object and initializes the StructureComponent "structure" field.

Method Detail

copy

public void copy(StructureComponent structureComponent)
Copy all of the field values from the parameter object into "this".

Specified by:
copy in class StructureComponent

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone this object.

Overrides:
clone in class StructureComponent
Throws:
java.lang.CloneNotSupportedException

getClassName

public static java.lang.String getClassName()
Description copied from class: StructureComponent
This method returns the fully qualified name of this class. Sub-classes must override this method (This method should really be declared abstract, but unfortunately Java does not allow a method to be both static AND abstract). Instead, this base class implementation will through an UnsupportedOperationException.

This name is used by the StructureComponentRegistry class to enable dynamic registration and discovery of new StructureComponent sub-classes/types. The name is also used to create instances of any sublcass dynamically from this name.


getStructureComponentType

public java.lang.String getStructureComponentType()
This method returns the fully qualified name of this class.

Specified by:
getStructureComponentType in class StructureComponent

setIdCode

public void setIdCode(java.lang.String code)
Set the PDB-ID code by which this entry is registered. For example, "2CPK", "4HHB", "10MH", etc.


getIdCode

public java.lang.String getIdCode()
Get the PDB-ID code by which this entry is registered. For example, "2CPK", "4HHB", "10MH", etc.


setCompoundName

public void setCompoundName(java.lang.String name)
Set the name of this macromolecular structure. For example, "c-AMP-Dependent Protein Kinase (E.C. 2.7.1.37) (cAPK) (Catalytic Subunit)".


getCompoundName

public java.lang.String getCompoundName()
Get the name of this macromolecular structure. For example, "c-AMP-Dependent Protein Kinase (E.C. 2.7.1.37) (cAPK) (Catalytic Subunit)".


setReleaseDate

public void setReleaseDate(int[] date)
Set the date on which this entry was released. date[0] = year. date[1] = month. date[2] = day. For example, "1993-1-15".


getReleaseDate

public void getReleaseDate(int[] date)
Get the date on which this entry was released. date[0] = year. date[1] = month. date[2] = day. For example, "1993-1-15".


setAuthors

public void setAuthors(java.lang.String names)
Set the authors of this entry. For example, "D. R. Knighton, J. Zheng, L. F. Ten Eyck, V. A. Ashford, N.-H. Xuong, S. S. Taylor, J. M. Sowadski".


getAuthors

public java.lang.String getAuthors()
Get the authors of this entry. For example, "D. R. Knighton, J. Zheng, L. F. Ten Eyck, V. A. Ashford, N.-H. Xuong, S. S. Taylor, J. M. Sowadski".


setPrimaryReference

public void setPrimaryReference(java.lang.String reference)
Set the primary citation reference for this entry. For example, "Knighton, D. R., Zheng, J. H., Ten Eyck, L. F., Ashford, V. A., Xuong, N. H., Taylor, S. S., Sowadski, J. M.: Crystal structure of the catalytic subunit of cyclic adenosine monophosphate-dependent protein kinase. Science 253 pp. 407 (1991)".


getPrimaryReference

public java.lang.String getPrimaryReference()
Get the primary citation reference for this entry. For example, "Knighton, D. R., Zheng, J. H., Ten Eyck, L. F., Ashford, V. A., Xuong, N. H., Taylor, S. S., Sowadski, J. M.: Crystal structure of the catalytic subunit of cyclic adenosine monophosphate-dependent protein kinase. Science 253 pp. 407 (1991)".


setSourceSpecies

public void setSourceSpecies(java.lang.String species)
Set the source species of this compound. For example, "Mus musculus".


getSourceSpecies

public java.lang.String getSourceSpecies()
Get the source species of this compound. For example, "Mus musculus".


setDeterminationMethod

public void setDeterminationMethod(java.lang.String method)
Set the exerimental method used to determine this compound. For example, "X-ray Diffraction".


getDeterminationMethod

public java.lang.String getDeterminationMethod()
Get the exerimental method used to determine this compound. For example, "X-ray Diffraction".


isVisible

public boolean isVisible()
Specified by:
isVisible in class StructureComponent