Changeset 3172

Timestamp:

07/13/07 00:37:25 (3 years ago)

Author:

amit

Message:

There are a few related changes here:

• Added new predicate to DublinCore? for general use and for citation
• Modified the Citation class to use the bibtex model
• Added License class to setup base for using different licenses
• Modified Article to correspond to new Dublin Core and Citation.

Reference is not needed. This has been tested on black.topazproject.org with
both new data (on black itself) and old data (merlin).

Location:

head/plosone/libs/otm-models/src

Files:

• main/java/org/plos/models/Article.java (modified) (2 diffs)
• main/java/org/plos/models/Citation.java (modified) (2 diffs)
• main/java/org/plos/models/DublinCore.java (modified) (4 diffs)
• main/java/org/plos/models/License.java (added)
• main/java/org/plos/models/PLoS.java (modified) (1 diff)
• main/java/org/plos/models/Reference.java (deleted)
• test/java/org/plos/models/ModelsTest.java (modified) (1 diff)

head/plosone/libs/otm-models/src/main/java/org/plos/models/Article.java

@@ -66 +66 @@
   @Predicate(uri = Rdf.topaz + "body")
   private String body;
-  @Predicate(uri = Rdf.topaz + "references", storeAs = Predicate.StoreAs.rdfList)
-  private List<Reference> references = new ArrayList<Reference>();
 
   /**
@@ -246 +244 @@
     this.body = body;
   }
-
-  /**
-   * @return list of references for the article
-   */
-  public List<Reference> getReferences() {
-    return references;
-  }
-
-  /**
-   * @param set references for article
-   */
-  public void setReferences(List<Reference> references) {
-    this.references = references;
-  }
 }

head/plosone/libs/otm-models/src/main/java/org/plos/models/Citation.java

@@ -10 +10 @@
 package org.plos.models;
 
+import java.net.URI;
+
 import java.util.List;
 import java.util.ArrayList;
 
+import org.topazproject.otm.annotations.Embeddable;
+import org.topazproject.otm.annotations.Entity;
+import org.topazproject.otm.annotations.Id;
 import org.topazproject.otm.annotations.Predicate;
 import org.topazproject.otm.annotations.Rdf;
-import org.topazproject.otm.annotations.Embeddable;
 import org.topazproject.otm.annotations.UriPrefix;
 
-@Embeddable
+/**
+ * Citation information
+ *
+ * @author Eric Brown
+ * @author Amit Kapoor
+ */
+@Entity(type = PLoS.bibtex + "Entry", model = "ri")
 @UriPrefix(Rdf.topaz)
-public class Citation {
-  private String citationType;
-  private Integer year;
-  private String source;
-  private String comment;
-  private Integer volume;
+public abstract class Citation {
+  @Id
+  private URI   id;
+
+  /**
+   * The year of publication or, for an unpublished work, the year it was
+   * written. Generally it should consist of four numerals, such as 1984,
+   * although the standard styles can handle any year whose last four
+   * nonpunctuation characters are numerals, such as '(about 1984)'
+   */
+  @Predicate(uri = PLoS.bibtex + "hasYear", dataType = Rdf.xsd + "nonNegativeInteger")
+  private int year;
+
+  @Predicate(uri = PLoS.bibtex + "hasMonth", dataType = Rdf.xsd + "string")
+  private String month;
+
+  /**
+   * The volume of a journal or multivolume book.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasVolume", dataType = Rdf.xsd + "nonNegativeInteger")
+  private int volume;
+
+  /**
+   * Typically, a Title will be a name by which the resource is formally known.
+   */
+  @Predicate(uri = Rdf.dc + "title", dataType = Rdf.rdf + "XMLLiteral")
+  private String title;
+
+  /**
+   * Usually the address of the publisher or other type of institution. For
+   * major publishing houses, van Leunen recommends omitting the information
+   * entirely. For small publishers, on the other hand, you can help the reader
+   * by giving the complete address.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasAddress", dataType = Rdf.xsd + "String")
   private String publisherLocation;
+
+  /**
+   * The publisher's name.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasPublisher", dataType = Rdf.xsd + "String")
   private String publisherName;
 
-  @Predicate(uri = Rdf.dc + "title", dataType = Rdf.rdf + "XMLLiteral")
-  private String articleTitle;
-  @Predicate(uri = Rdf.topaz + "firstPage")
-  private Integer firstPage;
-  @Predicate(uri = Rdf.topaz + "lastPage")
-  private Integer lastPage;
-  @Predicate(uri = Rdf.topaz + "authors", storeAs = Predicate.StoreAs.rdfList)
+  /**
+   * One or more page numbers or range of numbers, such as 42-111 or 7,41,73-97
+   * or 43+ (the `+' in this last example indicates pages following that don't
+   * form a simple range). To make it easier to maintain Scribe-compatible
+   * databases, the standard styles convert a single dash (as in 7-33) to the
+   * double dash used in TeX to denote number ranges (as in 7-33).
+   */
+  @Predicate(uri = PLoS.bibtex + "hasPages", dataType = Rdf.xsd + "String")
+  private String pages;
+
+  /**
+   * A journal name. Abbreviations are provided for many journals; see the
+   * Local Guide
+   */
+  @Predicate(uri = PLoS.bibtex + "hasJournal", dataType = Rdf.xsd + "String")
+  private String journal;
+
+  /**
+   * Any additional information that can help the reader. The first word should
+   * be capitalized.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasNote", dataType = Rdf.xsd + "String")
+  private String note;
+
+  /**
+   * Name(s) of editor(s), typed as indicated in the LaTeX book. If there is
+   * also an author field, then the editor field gives the editor of the book
+   * or collection in which the reference appears.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasEditorList", dataType = Rdf.xsd + "String",
+      storeAs = Predicate.StoreAs.rdfSeq)
+  private List<String> editors = new ArrayList<String>();
+
+  /**
+   * The name(s) of the author(s), in the format described in the LaTeX book.
+   */
+  @Predicate(uri = PLoS.bibtex + "hasAuthorList", dataType = Rdf.xsd + "String",
+      storeAs = Predicate.StoreAs.rdfSeq)
   private List<String> authors = new ArrayList<String>();
-  @Predicate(uri = Rdf.topaz + "editors", storeAs = Predicate.StoreAs.rdfList)
-  private List<String> editors = new ArrayList<String>();
-
-  /**
-   * @return the citation type
-   */
-  public String getCitationType() {
-    return citationType;
-  }
-
-  /**
-   * @param citationType the type of this citation
-   */
-  public void setCitationType(String citationType) {
-    this.citationType = citationType;
+
+  /**
+   * Get id.
+   *
+   * @return id as URI.
+   */
+  public URI getId() {
+    return id;
+  }
+
+  /**
+   * Set id.
+   *
+   * @param id the value to set.
+   */
+  public void setId(URI id) {
+    this.id = id;
+  }
+
+  /**
+   * @returns the year of the citation (if available)
+   */
+  public int getYear() {
+    return year;
+  }
+
+  /**
+   * @param year the year of the citation
+   */
+  public void setYear(int year) {
+    this.year = year;
+  }
+
+  /**
+   * @returns the month of the citation (if available)
+   */
+  public String getMonth() {
+    return month;
+  }
+
+  /**
+   * @param month the month of the citation
+   */
+  public void setMonth(String month) {
+    this.month = month;
+  }
+
+  /**
+   * @return the volume this citation is in
+   */
+  public int getVolume() {
+    return volume;
+  }
+
+  /**
+   * @param volume the volume of this citation
+   */
+  public void setVolume(int volume) {
+    this.volume = volume;
+  }
+
+  /**
+   * @return the title of the citation's article
+   */
+  public String getTitle() {
+    return title;
+  }
+
+  /**
+   * @param title the title of the citation's article
+   */
+  public void setTitle(String title) {
+    this.title = title;
+  }
+
+  /**
+   * @return the publisher's location
+   */
+  public String getPublisherLocation() {
+    return publisherLocation;
+  }
+
+  /**
+   * @param publisherLocation the location of the publisher
+   */
+  public void setPublisherLocation(String publisherLocation) {
+    this.publisherLocation = publisherLocation;
+  }
+
+  /**
+   * @return the publisher's name
+   */
+  public String getPublisherName() {
+    return publisherName;
+  }
+
+  /**
+   * @param publisherName the name of the publisher
+   */
+  public void setPublisherName(String publisherName) {
+    this.publisherName = publisherName;
+  }
+
+  /**
+   * @return the pages the citation is on
+   */
+  public String getPages() {
+    return pages;
+  }
+
+  /**
+   * @param pages the pages the citation is from
+   */
+  public void setPages(String pages) {
+    this.pages = pages;
+  }
+
+  /**
+   * @return journal the source of the citation
+   */
+  public String getJournal() {
+    return journal;
+  }
+
+  /**
+   * @param journal the journal of the citation
+   */
+  public void setJournal(String journal) {
+    this.journal = journal;
+  }
+
+  /**
+   * @return the note associated with this citation
+   */
+  public String getNote() {
+    return note;
+  }
+
+  /**
+   * @param note the note for this citation
+   */
+  public void setNote(String note) {
+    this.note = note;
+  }
+
+  /**
+   * @return the editors of this citation
+   */
+  public List<String> getEditors() {
+    return editors;
+  }
+
+  /**
+   * @param editors the editors of this citation
+   */
+  public void setEditors(List<String> editors) {
+    this.editors = editors;
   }
 
@@ -67 +284 @@
     this.authors = authors;
   }
-
-  /**
-   * @return the editors of this citation
-   */
-  public List<String> getEditors() {
-    return editors;
-  }
-
-  /**
-   * @param editors the editors of this citation
-   */
-  public void setEditors(List<String> editors) {
-    this.editors = editors;
-  }
-
-  /**
-   * @returns the year of the citation (if available)
-   */
-  public Integer getYear() {
-    return year;
-  }
-
-  /**
-   * @param year the year of the citation
-   */
-  public void setYear(Integer year) {
-    this.year = year;
-  }
-
-  /**
-   * @return the title of the citation's article
-   */
-  public String getArticleTitle() {
-    return articleTitle;
-  }
-
-  /**
-   * @param articleTitle the title of the citation's article
-   */
-  public void setArticleTitle(String articleTitle) {
-    this.articleTitle = articleTitle;
-  }
-
-  /**
-   * @return source the source of the citation
-   */
-  public String getSource() {
-    return source;
-  }
-
-  /**
-   * @param source the source of the citation
-   */
-  public void setSource(String source) {
-    this.source = source;
-  }
-
-  /**
-   * @return the comment associated with this citation
-   */
-  public String getComment() {
-    return comment;
-  }
-
-  /**
-   * @param comment the comment for this citation
-   */
-  public void setComment(String comment) {
-    this.comment = comment;
-  }
-
-  /**
-   * @return the volume this citation is in
-   */
-  public Integer getVolume() {
-    return volume;
-  }
-
-  /**
-   * @param volume the volume of this citation
-   */
-  public void setVolume(Integer volume) {
-    this.volume = volume;
-  }
-
-  /**
-   * @return the first page the citaiton is on
-   */
-  public Integer getFirstPage() {
-    return firstPage;
-  }
-
-  /**
-   * @param firstPage the page the citation is from
-   */
-  public void setFirstPage(Integer firstPage) {
-    this.firstPage = firstPage;
-  }
-
-  /**
-   * @return the last page the citation is on
-   */
-  public Integer getLastPage() {
-    return lastPage;
-  }
-
-  /**
-   * @param lastPage the last page the citaiton is found on
-   */
-  public void setLastPage(Integer lastPage) {
-    this.lastPage = lastPage;
-  }
-
-  /**
-   * @return the publisher's location
-   */
-  public String getPublisherLocation() {
-    return publisherLocation;
-  }
-
-  /**
-   * @param publisherLocation the location of the publisher
-   */
-  public void setPublisherLocation(String publisherLocation) {
-    this.publisherLocation = publisherLocation;
-  }
-
-  /**
-   * @return the publisher's name
-   */
-  public String getPublisherName() {
-    return publisherName;
-  }
-
-  /**
-   * @param publisherName the name of the publisher
-   */
-  public void setPublisherName(String publisherName) {
-    this.publisherName = publisherName;
-  }
 }

head/plosone/libs/otm-models/src/main/java/org/plos/models/DublinCore.java

@@ -125 +125 @@
 
   /**
+   * The described resource may be derived from the related resource in whole
+   * or in part. Recommended best practice is to identify the related resource
+   * by means of a string conforming to a formal identification system.
+   */
+  @Predicate(uri = Rdf.dc + "source")
+  private T source;
+
+  /**
    * Date (often a range) that the resource will become or did become
    * available.
@@ -134 +142 @@
    * The described resource includes the referenced resource either physically
    * or logically.
+   *
+   * TODO: This will need to be made Set<T> when OTM can handle this.
    */
   @Predicate(uri = Rdf.dc_terms + "hasPart")
@@ -169 +179 @@
   @Predicate(uri = Rdf.dc_terms + "isPartOf")
   private T isPartOf;
+
+  /**
+   * A summary of the content of the resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "abstract")
+  private Set<String> summary;
+
+  /**
+   * A bibliographic reference for the resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "bibliographicCitation")
+  private Citation bibliographicCitation;
+
+  /**
+   * Date of creation of the object
+   */
+  @Predicate(uri = Rdf.dc_terms + "created", dataType = Rdf.xsd + "date")
+  Date created;
+
+  /**
+   * The described resource is supplanted, displaced, or superseded by the
+   * referenced resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "isReplacedBy")
+  private T replacedBy;
+
+  /**
+   * A legal document giving official permission to do something with the
+   * resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "license")
+  private Set<License> license;
+
+  /**
+   * Date of modification of the object
+   */
+  @Predicate(uri = Rdf.dc_terms + "modified", dataType = Rdf.xsd + "date")
+  Date modified;
+
+  /**
+   * The described resource references, cites, or otherwise points to the
+   * referenced resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "references")
+  private Set<Citation> references;
+
+  /**
+   * The described resource supplants, displaces, or supersedes the referenced
+   * resource.
+   */
+  @Predicate(uri = Rdf.dc_terms + "replaces")
+  private T replaces;
 
   /**
@@ -514 +576 @@
     this.copyrightYear = copyrightYear;
   }
+
+  /**
+   * Return the source of the object
+   *
+   * @return the source of the object
+   */
+  public T getSource() {
+    return source;
+  }
+
+  /**
+   * Set the source of the object
+   *
+   * @param source the source of the object
+   */
+  public void setSource(T source) {
+    this.source = source;
+  }
+
+  /**
+   * Return the abstract/summary on the object
+   *
+   * @return the abstract/summary of the object
+   */
+  public Set<String> getSummary() {
+    return summary;
+  }
+
+  /**
+   * Set the abstract/summary of the object
+   *
+   * @param summary the summary/abstract of the object
+   */
+  public void setSummary(Set<String> summary) {
+    this.summary = summary;
+  }
+
+  /**
+   * Return the bibliographic citation for the object
+   *
+   * @return bibliographic citation for the object
+   */
+  public Citation getBibliographicCitation() {
+    return bibliographicCitation;
+  }
+
+  /**
+   * bibliographic citation for the object
+   *
+   * @param bibliographicCitation bibliographic citation for the object
+   */
+  public void setBibliographicCitation(Citation bibliographicCitation) {
+    this.bibliographicCitation = bibliographicCitation;
+  }
+
+  /**
+   * Return the creation date
+   *
+   * @return the creation date
+   */
+  public Date getCreated() {
+    return created;
+  }
+
+  /**
+   * Set the creation date
+   *
+   * @param created the date the object was created
+   */
+  public void setCreated(Date created) {
+    this.created = created;
+  }
+
+  /**
+   * Return the object replacing this
+   *
+   * @return the object replacing this
+   */
+  public T getReplacedBy() {
+    return replacedBy;
+  }
+
+  /**
+   * Set the object replacing this
+   *
+   * @param replacedBy the object replacing this
+   */
+  public void setReplacedBy(T replacedBy) {
+    this.replacedBy = replacedBy;
+  }
+
+  /**
+   * Return the set of licenses for this object
+   *
+   * @return the set of licenses for this object
+   */
+  public Set<License> getLicense() {
+    return license;
+  }
+
+  /**
+   * Set the set of licenses for this object
+   *
+   * @param license the set of licenses governing this object
+   */
+  public void setLicense(Set<License> license) {
+    this.license = license;
+  }
+
+  /**
+   * Return the modified date
+   *
+   * @return the modified date
+   */
+  public Date getModified() {
+    return modified;
+  }
+
+  /**
+   * Set the modified date
+   *
+   * @param modified the date the object was modified
+   */
+  public void setModified(Date modified) {
+    this.modified = modified;
+  }
+
+  /**
+   * Return the set of objects referred to by this object
+   *
+   * @return the set of objects referred to by this object
+   */
+  public Set<Citation> getReferences() {
+    return references;
+  }
+
+  /**
+   * Set the set of objects referred to by this object
+   *
+   * @param references the set of objects referred to by this object
+   */
+  public void setReferences(Set<Citation> references) {
+    this.references = references;
+  }
+
+  /**
+   * Return the object this replaces
+   *
+   * @return the object this replaces
+   */
+  public T getReplaces() {
+    return replaces;
+  }
+
+  /**
+   * Set the object replacing this
+   *
+   * @param replaces the object this replaces
+   */
+  public void setReplaces(T replaces) {
+    this.replaces = replaces;
+  }
 }

head/plosone/libs/otm-models/src/main/java/org/plos/models/PLoS.java

@@ -17 +17 @@
 public interface PLoS {
   /** PLoS namespace */
-  public static final String plos    = "http://rdf.plos.org/RDF/";
+  public static final String plos               = "http://rdf.plos.org/RDF/";
+  /** Creative Commons namespace */
+  public static final String creativeCommons    = "http://web.resource.org/cc/";
+  /** Bibtex namespace */
+  public static final String bibtex             = "http://purl.org/net/nknouf/ns/bibtex#";
 }

head/plosone/libs/otm-models/src/test/java/org/plos/models/ModelsTest.java

@@ -29 +29 @@
                   Category.class, Citation.class, Comment.class, DublinCore.class, FoafPerson.class,
                   ObjectInfo.class, PLoS.class, Rating.class, RatingContent.class,
-                  RatingSummary.class, RatingSummaryContent.class, Reference.class, Reply.class,
+                  RatingSummary.class, RatingSummaryContent.class, License.class, Reply.class,
                   ReplyThread.class, UserAccount.class, UserPreference.class, UserPreferences.class,
                   UserProfile.class, UserRole.class