org.lockss.config.TdbAu Maven / Gradle / Ivy
Show all versions of lockss-core Show documentation
/*
Copyright (c) 2000-2017 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
n
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.
*/
package org.lockss.config;
import java.io.*;
import java.util.*;
import org.apache.commons.collections4.map.Flat3Map;
import org.lockss.config.Tdb.TdbException;
import org.lockss.exporter.biblio.BibliographicItem;
import org.lockss.exporter.biblio.BibliographicUtil;
import org.lockss.plugin.*;
import org.lockss.subscription.BibliographicPeriod;
import org.lockss.util.*;
/**
* This class represents a title database archival unit (AU).
*
* @author Philip Gust
*/
// TODO: Remove Comparable after testing.
public class TdbAu implements BibliographicItem, Comparable {
/**
* Set up logger
*/
protected final static Logger logger = Logger.getLogger();
/**
* The name of this instance
*/
private final String name;
/**
* The Title to which this AU belongs
*/
private TdbTitle title;
/**
* The Provider for this AU
*/
private TdbProvider provider;
/**
* The plugin ID of the instance
*/
private String pluginId;
/**
* The plugin params for this instance
*/
private Map params;
/**
* The plugin attrs for this AU
*/
private Map attrs;
/**
* Additional properties
*/
private Map props;
/**
* The key for identity testing
*/
private final Id tdbAuId = new Id();
private List publicationRanges;
/**
* This class encapsulates the key for a TdbAu. As with
* the Plugin, it uses the pluginId and params. Since the
* Plugin is not available, it uses all the params rather
* than just the definitional ones.
*
* @author phil
*/
public class Id {
private int hash = 0;
/**
* Return the TdbAu for this ID.
* @return the TdbAu for this ID
*/
public TdbAu getTdbAu() {
return TdbAu.this;
}
/**
* Determines this ID is equal to another object
* @param obj the other object
* @return true if this ID equals the other object
*/
public boolean equals(Object obj) {
if (!(obj instanceof Id)) {
return false;
}
if (obj == this) {
return true;
}
TdbAu.Id other = (TdbAu.Id)obj;
return ( TdbAu.this.getPluginId().equals(other.getTdbAu().getPluginId())
&& TdbAu.this.getParams().equals(other.getTdbAu().getParams()));
}
/**
* Force hashcode to be recomputed because of a TdbAu change.
*/
private void invalidateHashCode() {
hash = 0;
}
/**
* Returns the hashcode for this ID.
* @return the hashcode for this ID
*/
public int hashCode() {
if (hash == 0) {
hash = (31*TdbAu.this.getPluginId().hashCode())
+ TdbAu.this.getParams().hashCode();
}
return hash;
}
/**
* Returns the string value for this ID.
* @return the string value of this ID
*/
public String toString() {
Properties props = new Properties();
props.putAll(TdbAu.this.getParams());
return PluginManager.generateAuId(TdbAu.this.getPluginId(), props);
}
}
/**
* Create a new instance of an au.
*
* @param name the name of the au
* @param pluginId the id of the plugin.
* @param pluginId the plugin ID of this AU
*/
protected TdbAu(String name, String pluginId) {
if (name == null) {
throw new IllegalArgumentException("au name cannot be null");
}
if (pluginId == null) {
throw new IllegalArgumentException("au pluginId cannot be null");
}
this.name = name;
this.pluginId = StringPool.PLUGIN_IDS.intern(pluginId);
// params = new HashMap();
params = new Flat3Map();
}
/**
* Determines two TdbsAus are equal. Equality is based on
* equality of their Ids, plus name, attributes
* and properties. The parent hierarchy is not checked.
*
* @param o the other object
* @return true iff they are equal TdbAus
*/
public boolean equals(Object o) {
// check for identity
if (this == o) {
return true;
}
if (o instanceof TdbAu) {
TdbAu other = (TdbAu)o;
return tdbAuId.equals(other.getId()) &&
getName().equals(other.getName()) &&
getAttrs().equals(other.getAttrs()) &&
getProperties().equals(other.getProperties());
}
return false;
}
/**
* Return the hashcode. The hashcode of this instance
* is the hashcode of its Id, plus name, attributes
* and properties.
*
* @returns hashcode of this instance
*/
public int hashCode() {
int result = getId().hashCode();
result = 31 * result + getAttrs().hashCode();
result = 31 * result + getProperties().hashCode();
return result;
}
/**
* Get the name of the AU. The name normally consists of the the TdbTitle
* plus a volume or date specifier.
*
* @return the name of this AU
*/
public String getName() {
return name;
}
/** Return the Plugin, iff it is loaded.
* @return the Plugin, or null if no plugin of that name */
public Plugin getPlugin(PluginManager pluginMgr) {
return pluginMgr.getPluginFromId(pluginId);
}
/**
* Get the AUID. Only possible if the necessary Plugin is loaded.
*
* @return the AUID
* @throws IllegalStateException if plugin isn't loaded
*/
public String getAuId(PluginManager pluginMgr) {
Plugin plug = getPlugin(pluginMgr);
if (plug == null) {
throw new IllegalStateException("No Plugin, can't get AUID: " + pluginId);
}
return PluginManager.generateAuId(plug.getPluginId(),
PluginManager.defPropsFromProps(plug,
params));
}
/**
* Array of props/attrs that can be used as a publisher-specified
* journal id.
*/
private static final String[] journal_ids = {
"journal_id",
"journal_code",
"journal_abbr"
};
/**
* Array of props/attrs that can be used as a publisher-specified
* book id.
*/
private static final String[] book_ids = {
"book_id",
"book_code",
"book_abbr"
};
/**
* Get an the attribute or parameter value associated with
* one of the ID names in the input array.
*
* @param ids an array of ids
* @return the first value found for one of the ids
*/
private String getId(String[] ids) {
// give priority to attributes over params for overriding
for (String id : ids) {
String propId = getAttr(id);
if (!StringUtil.isNullString(propId)) return propId;
}
for (String id : ids) {
String propId = getParam(id);
if (!StringUtil.isNullString(propId)) return propId;
}
return null;
}
/**
* Get the proprietary identifiers. For journals, this is a value of the title
* found in the 'journal_id' attribute or parameter. For books and book
* series, this is a value for a book represented by an AU in the "book_id"
* attribute or parameter. Use getProprietarySeriesIds() for the proprietary
* identifier of a series.
*
* @return a String[] with the single proprietary identifier of this AU.
*/
@Override
public String[] getProprietaryIds() {
String pubType = getPublicationType();
String[] ids = journal_ids;
if ( pubType.equalsIgnoreCase("book")
|| pubType.equals("bookSeries")) {
ids = book_ids;
}
String[] proprietaryIds = {getId(ids)};
return proprietaryIds;
}
/**
* Get the series proprietary identifiers. This is a value found in the
* 'journal_id' attribute or parameter of a book series.
*
* @return a String[] with the single series proprietary identifier of this
* AU.
*/
@Override
public String[] getProprietarySeriesIds() {
String[] proprietaryIds = {null};
String pubType = getPublicationType();
if (pubType.equals("bookSeries")) {
proprietaryIds[0] = getId(journal_ids);
}
return proprietaryIds;
}
/**
* Get the key for this instance. Two instances represent
* the same TdbAu if their keys are equal.
*
* @return the key for this instance
*/
public TdbAu.Id getId() {
return tdbAuId;
}
/**
* Get the TdbPublisher for this AU.
*
* @return the TdbPublisher for this AU
*/
public TdbProvider getTdbProvider()
{
return provider;
}
/**
* Get the TdbPublisher for this AU.
*
* @return the TdbPublisher for this AU
*/
public TdbPublisher getTdbPublisher()
{
return (title == null) ? null : title.getTdbPublisher();
}
/**
* Return the TdbTitle for this AU.
*
* @return the title for this AU.
*/
public TdbTitle getTdbTitle() {
return title;
}
/**
* Set the title for this AU.
*
* @param title the title for this AU
* @throws TdbException if the title is already set
*/
protected void setTdbTitle(TdbTitle title) throws TdbException{
if (title == null) {
throw new IllegalArgumentException("au title cannot be null");
}
if (this.title != null) {
throw new TdbException("cannot reset title for au \"" + name + "\"");
}
this.title = title;
}
/**
* Set the title for this AU.
*
* @param title the title for this AU
* @throws TdbException if the title is already set
*/
protected void setTdbProvider(TdbProvider provider) throws TdbException {
if (provider == null) {
throw new IllegalArgumentException("au provider cannot be null");
}
if (this.provider != null) {
throw new TdbException("cannot reset provider for au \"" + name + "\"");
}
this.provider = provider;
}
/**
* Determines whether this AU is marked "down".
*
* @return true if this AU is marked "down"
*/
public boolean isDown() {
return "true".equals(getParam("pub_down"));
}
/**
* Return the ID of the plugin for this AU. If the AU plugin ID
* is not set, returns the title default plugin ID.
*
* @return the ID of the plugin for this AU
*/
public String getPluginId() {
return pluginId;
}
/**
* Get the properties for this instance.
*
* Note: The returned map should be treated as read-only
*
* @param name the property name
* @return the property value or null if undefined
*/
public Map getProperties()
{
return (props != null) ? props : Collections.emptyMap();
}
/**
* Get a property by name.
*
* @param name the property name
* @return the property value or null if undefined
*/
public String getPropertyByName(String name)
{
if (name == null) {
throw new IllegalArgumentException("property name cannot be null");
}
if (name.equals("pluginId")) {
return getPluginId();
} else if (name.equals("name")) {
return getName();
} else if (props != null) {
return props.get(name);
}
return null;
}
/**
* Set AU properties by name.
*
* @param name the property name
* @param value the property value
* @throws TdbException if cannot set property
*/
protected void setPropertyByName(String name, String value) throws TdbException {
if (name == null) {
throw new IllegalArgumentException("property name cannot be null");
}
if (name.equals("pluginId")) {
throw new TdbException("cannot reset pluginId property \"" + pluginId + "\" for au \"" + this.name + "\"");
} else if (name.equals("name")) {
throw new TdbException("cannot reset name property \"" + name + "\" for au \"" + this.name + "\"");
} else {
if (value == null) {
throw new TdbException("value cannot be null for property \"" + name + "\" for au \"" + this.name + "\"");
}
if (props == null) {
// props = new HashMap();
props = new Flat3Map();
}
props.put(StringPool.TDBAU_PROPS.intern(name),
StringPool.TDBAU_PROPS.internMapValue(name, value));
}
}
/**
* Get the params for this instance.
*
* Note: this map should be treated as unmodifiable
*
* @return the params for this instance
*/
public Map getParams() {
return params;
}
/**
* Return the param value for this instance for the specified name.
*
* @param name the param name
* @return the param value, or null if not defined
*/
public String getParam(String name) {
return params.get(name);
}
/**
* Set the value of a param. All params must be set before adding this TdbAu
* to its TdbTitle because changing params could change the Id of this TdbAu.
*
* @param name the param name
* @param value the non-null param value
* @throws TdbException if param is already set, or
* au has been added to its title (could change its Id);
*/
protected void setParam(String name, String value) throws TdbException {
if (name == null) {
throw new IllegalArgumentException("au param name cannot be null");
}
if (value == null) {
throw new IllegalArgumentException("au param value cannot be null");
}
if (title != null) {
throw new TdbException("cannot add param once au has been added to its title");
}
if (params.containsKey(name)) {
throw new TdbException("cannot replace value of au param \"" + name + "\" for au \"" + this.name + "\"");
}
params.put(StringPool.AU_CONFIG_PROPS.intern(name),
StringPool.AU_CONFIG_PROPS.internMapValue(name, value));
getId().invalidateHashCode(); // setting params modifies ID hashcode
}
/**
* Get the attrs for this instance.
*
* Note: the returned map should be treated as unmodifiable.
*
* @return the attrs for this instance
*/
public Map getAttrs() {
return (attrs != null) ? attrs : Collections.emptyMap();
}
/**
* Return the attr value for this AU for the specified name.
*
* @param name the attr name
* @return the attr value or null if not defined
*/
public String getAttr(String name) {
return (attrs != null) ? attrs.get(name) : null;
}
/**
* Set the value of an attribute.
*
* @param name the attr name
* @param value the non-null attr value
* @throws TdbException if attr already set
*/
protected void setAttr(String name, String value) throws TdbException {
if (name == null) {
throw new IllegalArgumentException("attr name cannot be null for au \"" + this.name + "\"");
}
if (value == null) {
throw new IllegalArgumentException("value of attr \"" + name + "\" cannot be null for au \"" + this.name + "\"");
}
if (attrs == null) {
// attrs = new HashMap();
attrs = new Flat3Map();
}
if (attrs.containsKey(name)) {
throw new TdbException("cannot replace value of au attr \"" + name + "\" for au \"" + this.name + "\"");
}
attrs.put(StringPool.TDBAU_ATTRS.intern(name),
StringPool.TDBAU_ATTRS.internMapValue(name, value));
}
/**
* Convenience method returns the minimum plugin version from
* the "pluginVersion" property.
*
* @return pluginVersion the plugin version
*/
public String getPluginVersion() {
return getPropertyByName("pluginVersion");
}
/**
* Convenience method sets the minimum plugin version from
* the "pluginVersion" property.
*
* @return pluginVersion the pluginVersion
* @throws TdbException if plugin version already set
*/
public void setPluginVersion(String pluginVersion) throws TdbException {
setPropertyByName("pluginVersion", pluginVersion);
}
/**
* Convenience method sets the "estSize" property to the estimated size.
*
* @param size estimated size in bytes
* @throws TdbException if size already set
*/
public void setEstimatedSize(long size) throws TdbException {
if (size < 0) {
throw new IllegalArgumentException("estimated size cannot be negative");
}
setPropertyByName("estSize", Long.toString(size));
}
/**
* Convenience method gets the "estSize" property as an estimated size.
* If the current value represents fraction. it is truncated to the
* nearest whole number. The "estSize" property can be a number, or
* a number followed by a "MB" (megabytes) or "KB" (kilobytes) suffix.
*
* @return the estimated size in bytes
* @throws NumberFormatException if the "estSize" attribute is not an valid long
*/
public long getEstimatedSize() {
String size = getPropertyByName("estSize");
if (size == null) {
return 0;
} else {
if (size.toUpperCase().endsWith("MB")) {
return (long)(Float.parseFloat(size.substring(0, size.length()-2))*1000000);
} else if (size.toUpperCase().endsWith("KB")) {
return (long)(Float.parseFloat(size.substring(0, size.length()-2))*1000);
}
return (long)Float.parseFloat(size);
}
}
/**
* Returns the series title. For book series, the series title
* is the TdbTitle name; otherwise it is null.
*
* @return the name of this series, or null
*/
public String getSeriesTitle() {
String pubType = getPublicationType();
return pubType.equalsIgnoreCase("bookSeries") ? title.getName() : null;
}
/**
* Returns the publication title. For books and book series, the
* publication title is the TdbAu name, otherwise, it is the TdbTitle name.
*
* @return the name of this publication, or null
* @deprecated use {@link getPublicationTitle()} instead
*/
@Deprecated
public String getJournalTitle() {
return getPublicationTitle();
}
/**
* Returns the publication title. For books and book series, the
* publication title is the TdbAu name, otherwise, it is the TdbTitle name.
*
* @return the name of this publication, or null
*/
public String getPublicationTitle() {
String pubType = getPublicationType();
if ( pubType.equalsIgnoreCase("book")
|| pubType.equalsIgnoreCase("bookSeries")) {
return name;
}
return (title != null) ? title.getName() : null;
}
/**
* Convenience method returns the AU's TdbPublisher's name.
*
* @return the name of this AU's TdbPublisher, or null
*/
public String getPublisherName() {
try {
return title.getTdbPublisher().getName();
} catch (NullPointerException e) {
return null;
}
}
/**
* Convenience method returns the AU's TdbProvider's name.
*
* @return the name of this AU's TdbProvider, or null
*/
@Override
public String getProviderName() {
try {
return provider.getName();
} catch (NullPointerException e) {
return null;
}
}
/**
* Get the start issue for this AU. Allows for the issue string to represent
* a delimited list of ranges.
* @return the start issue or null if not specified
*/
@Override
public String getStartIssue() {
return BibliographicUtil.getRangeSetStart(getIssue());
}
/**
* Get the end issue for this AU. Allows for the issue string to represent
* a delimited list of ranges.
* @return the end issue or null if not specified
*/
@Override
public String getEndIssue() {
return BibliographicUtil.getRangeSetEnd(getIssue());
}
/**
* Determine whether the issue string for this AU include a given issue.
* Uses {@link BibliographicUtil.coverageIncludes} to check each range
* specified in the string.
*
* @param anIssue an issue
* @return true if this AU includes the issue
*/
public boolean includesIssue(String anIssue) {
return BibliographicUtil.coverageIncludes(getIssue(), anIssue);
}
/**
* Convenience method returns issue for this AU. Uses the issue attribute
* as preferred bibliographic value because parameter values are sometimes
* not used correctly. Otherwise tries one of the several parameter formats,
* in order from most to least likely.
*
* @return issue for for this AU or null if not specified
*/
@Override
public String getIssue() {
String issue = getAttr("issue");
if (issue == null) {
for (String key : new String[] {
"issue",
"num_issue_range",
"issue_set",
"issue_no",
"issues",
"issue_no.",
"issue_dir"
}) {
issue = getParam(key);
if (issue != null) {
break;
}
}
}
return issue;
}
/**
* Return publication type this AU. Values include "journal" for a journal,
* "book" if each AU is an individual book that is not part of a series, and
* "bookSeries" if each AU is an individual book that is part of a series.
* For a "bookSeries" the journalTitle() is returns the name of the series.
* For a "book" the journalTitle() is simply descriptive of the collection
* of books (e.g. "Springer Books") and can be ignored for bibliographic
* purposes.
*
* Note: the value is computed from the issn and isbn values if not given.
* If both are given, returns "bookSeries." If isbn only is given, returns
* "books." If only issn is given or neither are given, returns "journal."
*
* @return publication type this title or "journal" if not specified
*/
@Override
public String getPublicationType() {
String pubType = "journal";
if (props != null) {
pubType = props.get("type");
if (pubType == null) {
String isbn = getIsbn();
String issn = getIssn();
if (isbn != null) {
pubType = (issn != null) ? "bookSeries" : "book";
} else {
pubType = "journal";
}
}
}
return pubType;
}
/**
* Return coverage depth of the content in this AU. Values include "fulltext"
* for full-text coverage, "abstracts" for abstracts-only coverage, and
* "tablesofcontents" for tables of contents-only coverage.
*
* @return coverage depth this AU or "fulltext" if not specified
*/
@Override
public String getCoverageDepth() {
String depth = "fulltext";
if (attrs != null) {
depth = attrs.get("au_coverage_depth");
if (depth == null) {
depth = "fulltext";
}
}
return depth;
}
/**
* Return print ISSN for this AU.
*
* @return the print ISSN for this title or null if not specified
*/
@Override
public String getPrintIssn() {
return (props == null) ? null : props.get("issn");
}
/**
* Return eISSN for this title. Checks that the ISSN is well-formed (but
* does not check checksum).
*
* @return the eISSN for this title or null if not specified
*/
@Override
public String getEissn() {
return (props == null) ? null : props.get("eissn");
}
/**
* Return ISSN-L for this title. Checks that the ISSN is well-formed (but
* does not check checksum).
*
* @return the ISSN-L for this title or null if not specified
*/
@Override
public String getIssnL() {
return (props == null) ? null : props.get("issnl");
}
/**
* Return representative ISSN for this title. Returns ISSN-L if available,
* then print ISSN, and finally eISSN. This approximates the way ISSN-Ls
* are assigned. The returned ISSN is checked for well-formedness, but is
* not checksummed.
*
* @return representative for this title or null if not
* specified or is ill-formed
*/
@Override
public String getIssn() {
String issn = getIssnL();
if (!MetadataUtil.isIssn(issn)) {
issn = getPrintIssn();
if (!MetadataUtil.isIssn(issn)) {
issn = getEissn();
if (!MetadataUtil.isIssn(issn)) {
issn = null;
}
}
}
return issn;
}
/**
* Return the print ISBN for this TdbAu.
*
* @return the print ISBN for this TdbAu or null if not specified
*/
@Override
public String getPrintIsbn() {
String printIsbn = (attrs == null) ? null : attrs.get("isbn");
if (logger.isDebug3() && printIsbn != null) {
logger.debug3("Found " + printIsbn + " for " + getName());
}
return printIsbn;
}
/**
* Return the eISBN for this TdbAu.
*
* @return the print ISBN for this TdbAu or null if not specified
*/
@Override
public String getEisbn() {
String eisbn = (attrs == null) ? null : attrs.get("eisbn");
if (logger.isDebug3() && eisbn != null) {
logger.debug3("Found " + eisbn + " for " + getName());
}
return eisbn;
}
/**
* Return a representative ISBN for this TdbAu; the eISBN if specified or the
* print ISBN. Each ISBN is check for well-formedness but is not checksummed.
* Also checks deprecated "isbn' title property if ISBN or eISBN attribute
* are not present.
*
* @return the ISBN for this title or null if not specified
* or is malformed
*/
@Override
public String getIsbn() {
String isbn = getEisbn();
if (!MetadataUtil.isIsbn(isbn)) {
isbn = getPrintIsbn();
if (!MetadataUtil.isIsbn(isbn)) {
isbn = (props == null) ? null : props.get("isbn");
if ((isbn != null) && !MetadataUtil.isIsbn(isbn)) {
isbn = null;
}
}
}
return isbn;
}
/**
* Get the start year for this AU. Allows for the year string to represent
* a delimited list of ranges.
* @return the start year or null if not specified
*/
@Override
public String getStartYear() {
return BibliographicUtil.getRangeSetStart(getYear());
}
/**
* Get the end year for this AU. Allows for the year string to represent
* a delimited list of ranges.
* @return the end year or null if not specified
*/
@Override
public String getEndYear() {
return BibliographicUtil.getRangeSetEnd(getYear());
}
/**
* Determine whether year(s) for this AU include a given date.
* Uses {@link BibliographicUtil.coverageIncludes} to check each range
* specified in the string.
* @param aYear a year
* @return true if this AU includes the date
*/
public boolean includesYear(String aYear) {
//return NumberUtil.rangeIncludes(getYear(), aYear);
return BibliographicUtil.coverageIncludes(getYear(), aYear);
}
/**
* Get year for this AU. Uses the year attribute as preferred bibliographic
* value because the parameter values are sometimes not used correctly.
*
* Note: The year field may be a range (e.g. 2003-2004) rather than a
* single year.
*
* @return the year for this AU or null if not specified
*/
public String getYear() {
String auYear = getAttr("year");
if (auYear == null) {
auYear = getParam("year");
}
return auYear;
}
/**
* Get the start volume for this AU. First the method checks whether the volume
* string looks like a genuine range. If it looks like a single identifier
* with a hyphen, the string is returned whole.
* @return the start volume or null if not specified
*/
@Override
public String getStartVolume() {
return BibliographicUtil.getRangeSetStart(getVolume());
}
/**
* Get the end volume for this AU. First the method checks whether the volume
* string looks like a genuine range. If it looks like a single identifier
* with a hyphen, the string is returned whole.
* @return the end volume or null if not specified
*/
@Override
public String getEndVolume() {
return BibliographicUtil.getRangeSetEnd(getVolume());
}
/**
* Determine whether the volume string for this AU include a given volume.
* Uses {@link BibliographicUtil.coverageIncludes} to check each range
* specified in the string.
* @param aVolume a volume
* @return true if this AU includes the volume
*/
public boolean includesVolume(String aVolume) {
//return NumberUtil.rangeIncludes(getVolume(), aVolume);
return BibliographicUtil.coverageIncludes(getVolume(), aVolume);
// TODO Use a volume-aware method instead, that allows for example
// s2ii to not include s2iii
// s2v-s2x to include s2ix but not s2w
}
/**
* Return the volume from a TdbAu. Uses the volume attribute as preferred
* bibliographic value because the parameter values are sometimes not used
* correctly within TDB files (e.g. they're really years)
*
* Note: The volume field may be a range (e.g. 85-87) rather than a
* single volume.
*
* @param tdbau the TdbAu
* @return the volume name or null if not specified.
*/
@Override
public String getVolume() {
String auVolume = getAttr("volume");
if (auVolume == null) {
auVolume = getParam("volume_name");
}
if (auVolume == null) {
auVolume = getParam("volume_str");
}
if (auVolume == null) {
auVolume = getParam("volume");
}
return auVolume;
}
/**
* Return the edition from a TdbAu.
*
* @param tdbau the TdbAu
* @return the edition name or null if not specified
*/
public String getEdition() {
String auEdition = getAttr("edition");
if (auEdition == null) {
auEdition = getParam("edition");
}
return auEdition;
}
/**
* Convenience method generates Properties that will result in this
* TdbAu when loaded by Tdb.
*
* @return Properties equivalent to this TdbAu
*/
public Properties toProperties() {
Properties p = new OrderedProperties();
// put fixed AU props
p.put("title", name);
p.put("plugin", pluginId);
// put additional AU props
if (props != null) {
for (Map.Entry entry : props.entrySet()) {
p.put(entry.getKey(), entry.getValue());
}
}
// put the journal title
if (title != null) {
// Put title properties on each AU
// This will go away when the external
// representation includes separate title records.
p.put("journal.title", title.getName()); // proposed replacement for journalTitle
p.put("journal.id", title.getId()); // proposed new property
if (title.getTdbPublisher() != null) {
// proposed new property to replace attribute.publisher
p.put("publisher.id", title.getTdbPublisher().getName());
}
// put link properties
// KLUDGE: put all title links on each AU.
// During processing, links are aggregated from AUs
// into the title. This will go away when the external
// representation includes separate title records.
int ix = 0;
for (Map.Entry> entry : title.getAllLinkedTitleIds().entrySet()) {
TdbTitle.LinkType key = entry.getKey();
for (String titleId : entry.getValue()) {
String ppre = "link." + (++ix) + ".";
p.put(ppre + "type", key.toString());
p.put(ppre + "journalId", titleId);
}
}
}
// put param properties
if (params != null) {
int ix = 0;
for (Map.Entry entry : params.entrySet()) {
String ppre = "param." + (++ix) + ".";
String key = entry.getKey();
p.put(ppre + "key", key);
p.put(ppre + "value", entry.getValue());
}
}
// put attr properties
if (attrs != null) {
for (Map.Entry entry : attrs.entrySet()) {
p.put("attributes."+entry.getKey(), entry.getValue());
}
}
return p;
}
/**
* Convenience method that generates a TdbAu from a Properties class.
*
* @param props
* A Properties to be used to populate the TdbAu.
* @return a TdbAu populated with the passed Properties.
* @throws Exception
* if there are errors.
*/
public static TdbAu fromProperties(Properties props) throws Exception {
final String DEBUG_HEADER = "fromProperties(): ";
if (logger.isDebug2()) logger.debug2(DEBUG_HEADER + "props = " + props);
// Create the basic result.
TdbAu tdbAu =
new TdbAu(props.getProperty("title"), props.getProperty("plugin"));
tdbAu.props = new HashMap();
tdbAu.params = new HashMap();
tdbAu.attrs = new HashMap();
// Loop through all the passed properties.
for (Object key : props.keySet()) {
// The name of the property.
String name = (String)key;
if (logger.isDebug3()) logger.debug3(DEBUG_HEADER + "name = " + name);
// Check whether it is a parameter.
if (name.startsWith("param.") && name.endsWith("key")) {
// Yes: Recover the original data.
String originalKey = props.getProperty(name);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "originalKey = " + originalKey);
String prefix = name.substring(0, name.length()-3);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "prefix = " + prefix);
String originalValue = props.getProperty(prefix + "value");
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "originalValue = " + originalValue);
// Save the parameter in the result.
tdbAu.setParam(originalKey, originalValue);
// No: Check whether it is an attribute.
} else if (name.startsWith("attributes.")) {
// Yes: Recover the original data.
String originalKey = name.substring("attributes.".length());
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "originalKey = " + originalKey);
String originalValue = props.getProperty(name);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "originalValue = " + originalValue);
// Save the attribute in the result.
tdbAu.setAttr(originalKey, originalValue);
// No: Check whether it is a property.
} else if (!name.startsWith("param.") && !name.startsWith("link.")
&& !"journal.id".equals(name) && !"journal.title".equals(name)
&& !"plugin".equals(name)&& !"publisher.id".equals(name)
&& !"title".equals(name)) {
// Yes: Recover the original data.
String originalValue = props.getProperty(name);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "originalValue = " + originalValue);
// Save the property in the result.
tdbAu.setPropertyByName(name, originalValue);
}
}
// Add the title, if necessary.
TdbTitle tdbTitle = null;
String titleName = props.getProperty("journal.title");
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "titleName = " + titleName);
String titleId = props.getProperty("journal.id");
if (logger.isDebug3()) logger.debug3(DEBUG_HEADER + "titleId = " + titleId);
if (titleName != null || titleId != null) {
tdbTitle = new TdbTitle(titleName, titleId);
String publisherId = props.getProperty("publisher.id");
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "publisherId = " + publisherId);
Tdb tdb = ConfigManager.getCurrentConfig().getTdb();
TdbPublisher tdbPublisher = tdb.getTdbPublisher(publisherId);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "tdbPublisher = " + tdbPublisher);
if (tdbPublisher == null) {
tdbPublisher = new TdbPublisher(publisherId);
if (logger.isDebug3())
logger.debug3(DEBUG_HEADER + "tdbPublisher = " + tdbPublisher);
}
tdbTitle.setTdbPublisher(tdbPublisher);
tdbAu.title = tdbTitle;
}
if (logger.isDebug2()) logger.debug2(DEBUG_HEADER + "tdbAu = " + tdbAu);
return tdbAu;
}
/**
* Create a copy of this TdbAu for the specified title
*
* This is method is used by Tdb to make a deep copy of a publisher.
*
* @param publisher the publisher
* @throws TdbException if trying to add a TdbAu to title with the
* same id as this one
*/
protected TdbAu copyForTdbTitle(TdbTitle title) throws TdbException {
TdbAu au = new TdbAu(name, pluginId);
// immutable -- no need to copy
au.attrs = attrs;
au.props = props;
au.params = params;
title.addTdbAu(au);
return au;
}
/** Print a full description of the AU */
public void prettyPrint(PrintStream ps, int indent) {
ps.println(StringUtil.tab(indent) + "AU: " + name);
indent += 2;
ps.println(StringUtil.tab(indent) + "Plugin: " + pluginId);
pprintSortedMap("Params:", params, ps, indent);
if (attrs != null && !attrs.isEmpty()) {
pprintSortedMap("Attrs:", attrs, ps, indent);
}
if (props != null && !props.isEmpty()) {
pprintSortedMap("Additional props:", props, ps, indent);
}
}
/**
* Logs a full description of this object in a nice format.
*
* @param indent
* An int with the number of columns of indentation to use in
* formatting.
*/
public void prettyLog(int indent) {
if (logger.isDebug()) {
logger.debug(StringUtil.tab(indent) + "AU: " + name);
indent += 2;
logger.debug(StringUtil.tab(indent) + "Plugin: " + pluginId);
logger.debug(StringUtil.tab(indent) + "Title: " + title);
indent += 2;
logger.debug(StringUtil.tab(indent) + "Name: " + title.getName());
logger.debug(StringUtil.tab(indent) + "Publisher: "
+ title.getPublisherName());
indent -= 2;
plogSortedMap("Params:", params, indent);
if (attrs != null && !attrs.isEmpty()) {
plogSortedMap("Attrs:", attrs, indent);
}
if (props != null && !props.isEmpty()) {
plogSortedMap("Additional props:", props, indent);
}
}
}
void pprintSortedMap(String title, Map map,
PrintStream ps, int indent) {
ps.println(StringUtil.tab(indent) + title);
indent += 2;
TreeMap sorted = new TreeMap(map);
for (Map.Entry ent : sorted.entrySet()) {
ps.println(StringUtil.tab(indent) +
ent.getKey() + " = " + ent.getValue());
}
}
/**
* Logs a full description of a map in a nice format.
*
* @param title
* A String with the title of the map.
* @param map
* A Map with the map.
* @param indent
* An int with the number of columns of indentation to use in
* formatting.
*/
private void plogSortedMap(String title, Map map, int indent)
{
if (logger.isDebug()) {
logger.debug(StringUtil.tab(indent) + title);
indent += 2;
TreeMap sorted = new TreeMap(map);
for (Map.Entry ent : sorted.entrySet()) {
logger.debug(StringUtil.tab(indent)
+ ent.getKey() + " = " + ent.getValue());
}
}
}
/**
* Return a String representation of the title.
*
* @return a String representation of the title
*/
public String toString() {
return "[TdbAu: " + name + "]";
}
/**
* TODO: Where do the publication ranges come from?
* Provides a list of the publication ranges covered by this Archival Unit.
*
* @return a List with the publication ranges.
*/
public List getPublicationRanges() {
// TODO: Provide a real implementation instead of this mock-up.
if (publicationRanges == null) {
publicationRanges = new ArrayList();
publicationRanges.add(new BibliographicPeriod(getStartYear(),
getStartVolume(), getStartIssue(), getEndYear(), getEndVolume(),
getEndIssue()));
}
return publicationRanges;
}
/**
* TODO: Where do the publication ranges come from?
*
* At the moment this is only used for setting up tests.
*/
public void setPublicationRanges(List ranges) {
publicationRanges = ranges;
}
// TODO: Remove after testing.
// Used to get the sorted TdbAus in TdbTitle for testing.
@Override
public int compareTo(TdbAu other) {
if (!StringUtil.isNullString(getStartYear()) && other != null) {
return getStartYear().compareTo(other.getStartYear());
} else if (!StringUtil.isNullString(getStartVolume()) && other != null) {
return getStartVolume().compareTo(other.getStartVolume());
} else if (!StringUtil.isNullString(getStartIssue()) && other != null) {
return getStartIssue().compareTo(other.getStartIssue());
}
return 0;
}
/**
* Provides an indication of whether this archival unit belongs to a serial
* publication.
*
* @return true if this archival unit belongs to a serial
* publication, false otherwise.
*/
public boolean isSerial() {
String publicationType = getPublicationType();
return "journal".equals(publicationType)
|| "bookSeries".equals(publicationType);
}
/**
* Provides an indication of whether there are no differences between this
* object and another one in anything other than proprietary identifiers.
*
* @param other
* A BibliographicItem with the other object.
* @return true if there are no differences in anything other
* than their proprietary identifiers, false otherwise.
*/
@Override
public boolean sameInNonProprietaryIdProperties(BibliographicItem other){
throw new UnsupportedOperationException();
}
}