org.biojavax.SimpleDocRef Maven / Gradle / Ivy
/*
* BioJava development code
*
* This code may be freely distributed and modified under the
* terms of the GNU Lesser General Public Licence. This should
* be distributed with the code. If you do not have a copy,
* see:
*
* http://www.gnu.org/copyleft/lesser.html
*
* Copyright for this code is held jointly by the individual
* authors. These should be listed in @author doc comments.
*
* For more information on the BioJava project and its aims,
* or to join the biojava-l mailing list, visit the home page
* at:
*
* http://www.biojava.org/
*
*/
package org.biojavax;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.Checksum;
import org.biojava.utils.AbstractChangeable;
import org.biojava.utils.ChangeEvent;
import org.biojava.utils.ChangeSupport;
import org.biojava.utils.ChangeVetoException;
import org.biojavax.utils.CRC64Checksum;
/**
* A basic DocRef implementation.
* @author Richard Holland
* @author Mark Schreiber
* @author George Waldon
* @since 1.5
*/
public class SimpleDocRef extends AbstractChangeable implements DocRef {
private CrossRef crossref;
private List authors;
private String title;
private String location;
private String remark;
/**
* Creates a new document reference from the given immutable authors and
* location and title. Will throw exceptions if either authors or
* location are null, but a null title is allowable.
* @param authors The authors of the referenced document, as a set of DocRefAuthor instances.
* @param location The location of the document, e.g. the journal name and page range.
*/
public SimpleDocRef(List authors, String location) {
this(authors, location, null);
}
/**
* Creates a new document reference from the given immutable authors and
* location and title. Will throw exceptions if either authors or
* location are null, but a null title is allowable.
* @param authors The authors of the referenced document, as a string to be parsed
* with {@link DocRefAuthor.Tools#parseAuthorString(String)}.
* @param location The location of the document, eg. the journal name and page range.
*/
public SimpleDocRef(String authors, String location) {
this(DocRefAuthor.Tools.parseAuthorString(authors), location, null);
}
/**
* Creates a new document reference from the given immutable authors and
* location and title. Will throw exceptions if either authors or
* location are null, but a null title is allowable.
* @param authors The authors of the referenced document, as a string to be parsed
* with {@link DocRefAuthor.Tools#parseAuthorString(String)}.
* @param location The location of the document, e.g. the journal name and page range.
* @param title The title of the document.
*/
public SimpleDocRef(String authors, String location, String title) {
this(DocRefAuthor.Tools.parseAuthorString(authors), location, title);
}
/**
* Creates a new document reference from the given immutable authors and
* location and title. Will throw exceptions if either authors or
* location are null, but a null title is allowable.
* @param authors The authors of the referenced document, as a set of DocRefAuthor instances.
* @param location The location of the document, e.g. the journal name and page range.
* @param title The title of the document.
*/
public SimpleDocRef(List authors, String location, String title) {
if (authors==null) throw new IllegalArgumentException("Authors cannot be null");
if (location==null) throw new IllegalArgumentException("Location cannot be null");
this.crossref = null;
this.authors = new ArrayList();
this.authors.addAll(authors);
this.title = title;
this.location = location;
this.remark = null;
}
/**
* Construct a doc ref with populated cross ref.
* @param authors
* @param location
* @param title
* @param crossRefKey
* @param crossRefValue
* @param crossRefVersion
*/
public SimpleDocRef(String authors, String location, String title, String crossRefKey, String crossRefValue, Integer crossRefVersion) {
this(DocRefAuthor.Tools.parseAuthorString(authors), location, title, crossRefKey, crossRefValue, crossRefVersion);
}
/**
* Construct a doc ref with populated cross ref.
* @param authors
* @param location
* @param title
* @param crossRefKey
* @param crossRefValue
* @param crossRefVersion
*/
public SimpleDocRef(List authors, String location, String title, String crossRefKey, String crossRefValue, Integer crossRefVersion) {
this(authors, location, title);
this.setCrossref((CrossRef) RichObjectFactory.getObject(SimpleCrossRef.class, new Object[]{crossRefKey, crossRefValue, crossRefVersion}));
}
// Hibernate requirement - not for public use.
protected SimpleDocRef() {}
/**
* {@inheritDoc}
*/
public void setRemark(String remark) throws ChangeVetoException {
if(this.remark!=null && this.remark.equals(remark)) return;
else if(this.remark==null && remark==null) return;
if(!this.hasListeners(DocRef.REMARK)) {
this.remark = remark;
} else {
ChangeEvent ce = new ChangeEvent(
this,
DocRef.REMARK,
remark,
this.remark
);
ChangeSupport cs = this.getChangeSupport(DocRef.REMARK);
synchronized(cs) {
cs.firePreChangeEvent(ce);
this.remark = remark;
cs.firePostChangeEvent(ce);
}
}
}
// Hibernate requirement - not for public use.
void setCRC(String CRC) {} // ignore as field is a calculated value
/**
* {@inheritDoc}
*/
public void setCrossref(CrossRef crossref) throws ChangeVetoException {
if(this.crossref!=null && this.crossref.equals(crossref)) return;
else if(this.crossref==null && crossref==null) return;
if(!this.hasListeners(DocRef.CROSSREF)) {
this.crossref = crossref;
} else {
ChangeEvent ce = new ChangeEvent(
this,
DocRef.CROSSREF,
crossref,
this.crossref
);
ChangeSupport cs = this.getChangeSupport(DocRef.CROSSREF);
synchronized(cs) {
cs.firePreChangeEvent(ce);
this.crossref = crossref;
cs.firePostChangeEvent(ce);
}
}
}
// Hibernate requirement - not for public use.
void setAuthors(String authors) { this.authors = DocRefAuthor.Tools.parseAuthorString(authors); }
// Hibernate requirement - not for public use.
void setLocation(String location) { this.location = location; }
// Hibernate requirement - not for public use.
void setTitle(String title) { this.title = title; }
/**
* {@inheritDoc}
*/
public String getAuthors() { return DocRefAuthor.Tools.generateAuthorString(this.authors, true); }
/**
* {@inheritDoc}
*/
public List getAuthorList() { return new ArrayList(this.authors); }
/**
* {@inheritDoc}
* The string to be checksummed is constructed by concatenating the authors,
* title, and location in that order, with no space between. If any values are
* null they are substituted with the text "<undef>".
* @see CRC64Checksum
*/
public String getCRC() {
StringBuffer sb = new StringBuffer();
sb.append(this.getAuthors());
sb.append((this.title==null || this.title.equals(""))?"":this.title);
sb.append((this.location==null || this.location.equals(""))?"":this.location);
Checksum cs = new CRC64Checksum();
cs.update(sb.toString().getBytes(), 0, sb.length());
return cs.toString();
}
/**
* {@inheritDoc}
*/
public String getRemark() { return this.remark; }
/**
* {@inheritDoc}
*/
public CrossRef getCrossref() { return this.crossref; }
/**
* {@inheritDoc}
*/
public String getLocation() { return this.location; }
/**
* {@inheritDoc}
*/
public String getTitle() { return this.title; }
/**
* {@inheritDoc}
* Document references are compared first by author, then by location, then
* by title. If Author and location are equal and this title is null,
* and theirs isn't, then this will return -1.
* For symmetry if our title is not null and theirs is then we return 1. If
* both are null then we return 0.
*/
public int compareTo(Object o) {
if(o == this) return 0;
// Hibernate comparison - we haven't been populated yet
if (this.authors==null) return -1;
// Normal comparison
DocRef them = (DocRef)o;
if (!this.getAuthors().equals(them.getAuthors())) return this.getAuthors().compareTo(them.getAuthors());
else if (!this.getLocation().equals(them.getLocation())) return this.getLocation().compareTo(them.getLocation());
else if (this.getTitle()==null) {
if (them.getTitle()==null) return 0;
else return -1;
}
else if (this.getTitle() != null && them.getTitle() == null) return 1; //other cases are handled above.
else return this.getTitle().compareTo(them.getTitle());
}
/**
* {@inheritDoc}
* Document references are equal if they have the same author and location and title.
*/
public boolean equals(Object obj) {
if(this == obj) return true;
if (obj==null || !(obj instanceof DocRef)) return false;
// Hibernate comparison - we haven't been populated yet
if (this.authors==null) return false;
// Normal comparison
DocRef them = (DocRef)obj;
return (this.getAuthors().equals(them.getAuthors()) &&
this.getLocation().equals(them.getLocation()) &&
(
(this.getTitle()==them.getTitle()) ||
(this.getTitle()!=null && this.getTitle().equals(them.getTitle()))
)
);
}
/**
* {@inheritDoc}
*/
public int hashCode() {
int code = 17;
// Hibernate comparison - we haven't been populated yet
if (this.authors==null) return code;
// Normal comparison
code = 37*code + this.getAuthors().hashCode();
code = 37*code + this.location.hashCode();
if (this.title!=null) code = 37*code + this.title.hashCode();
return code;
}
/**
* {@inheritDoc}
* Form: "authors; location"
*/
public String toString() {
return this.getAuthors()+"; "+this.getLocation();
}
// Hibernate requirement - not for public use.
private Integer id;
/**
* Gets the Hibernate ID. Should be used with caution.
* @return the Hibernate ID, if using Hibernate.
*/
public Integer getId() { return this.id; }
/**
* Sets the Hibernate ID. Should be used with caution.
* @param id the Hibernate ID, if using Hibernate.
*/
public void setId(Integer id) { this.id = id;}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy