|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.biojava.utils.AbstractChangeable
org.biojavax.SimpleDocRef
public class SimpleDocRef
A basic DocRef implementation.
Field Summary |
---|
Fields inherited from interface org.biojavax.DocRef |
---|
CROSSREF, REMARK |
Constructor Summary | |
---|---|
protected |
SimpleDocRef()
|
|
SimpleDocRef(java.util.List authors,
java.lang.String location)
Creates a new document reference from the given immutable authors and location and title. |
|
SimpleDocRef(java.util.List authors,
java.lang.String location,
java.lang.String title)
Creates a new document reference from the given immutable authors and location and title. |
Method Summary | |
---|---|
int |
compareTo(java.lang.Object o)
Document references are compared first by author, then by location, then by title. |
boolean |
equals(java.lang.Object obj)
Document references are equal if they have the same author and location and title. |
java.util.List |
getAuthorList()
Returns the authors of the document reference as a set of DocRefAuthor implementation instances. |
java.lang.String |
getAuthors()
Returns the authors of the document reference. |
java.lang.String |
getCRC()
Returns a CRC64 checksum of this document reference, allowing for easy comparisons with other document references. The string to be checksummed is constructed by concatenating the authors, title, and location in that order, with no space between. |
CrossRef |
getCrossref()
The document reference may refer to an object in another database. |
java.lang.String |
getLocation()
Returns a textual description of the document reference. |
java.lang.String |
getRemark()
If remarks have been made about this document reference, this method will return them. |
java.lang.String |
getTitle()
Returns the title of the document reference. |
int |
hashCode()
|
void |
setCrossref(CrossRef crossref)
The document reference may refer to an object in another database. |
void |
setRemark(java.lang.String remark)
Set the remarks for this document reference using this method. |
java.lang.String |
toString()
Form: "authors; location" |
Methods inherited from class org.biojava.utils.AbstractChangeable |
---|
addChangeListener, addChangeListener, generateChangeSupport, getChangeSupport, hasListeners, hasListeners, isUnchanging, removeChangeListener, removeChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.biojava.utils.Changeable |
---|
addChangeListener, addChangeListener, isUnchanging, removeChangeListener, removeChangeListener |
Constructor Detail |
---|
public SimpleDocRef(java.util.List authors, java.lang.String location)
authors
- The authors of the referenced document, as a set of DocRefAuthor instances.location
- The location of the document, eg. the journal name and page range.public SimpleDocRef(java.util.List authors, java.lang.String location, java.lang.String title)
authors
- The authors of the referenced document, as a set of DocRefAuthor instances.location
- The location of the document, eg. the journal name and page range.title
- The title of the document.protected SimpleDocRef()
Method Detail |
---|
public void setRemark(java.lang.String remark) throws ChangeVetoException
setRemark
in interface DocRef
remark
- New value of property Remark.
ChangeVetoException
- in case of objections.public void setCrossref(CrossRef crossref) throws ChangeVetoException
setCrossref
in interface DocRef
crossref
- New value of property crossref.
ChangeVetoException
- in case of objections.public java.lang.String getAuthors()
getAuthors
in interface DocRef
public java.util.List getAuthorList()
getAuthorList
in interface DocRef
public java.lang.String getCRC()
getCRC
in interface DocRef
CRC64Checksum
public java.lang.String getRemark()
getRemark
in interface DocRef
public CrossRef getCrossref()
getCrossref
in interface DocRef
public java.lang.String getLocation()
getLocation
in interface DocRef
public java.lang.String getTitle()
getTitle
in interface DocRef
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |