Versions Compared

Old Version 12

changes.mady.by.user James English

Saved on

compared with

New Version 13

changes.mady.by.user James English

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Looking at the whole data model at once can be overwhelming, so we'll consider it as a few smaller simpler systems:

These systems overlap around a few key classes, mainly DataSource, Identifier, LicensePool, and Work.

Image Added

The code for the data model is in the model package of the server_core project.

...

Bibliographic information is information about books as opposed to the books themselves. A book's title, its cover image, and its ISBN are all bibliographic information--the text of the book is not. Bibliographic information flows into the circulation manager and metadata wrangler from a variety of sources, mainly OPDS feeds and proprietary APIs. We keep track of all this information and where it came from, and when necessary we weigh it, sort it, and boil it down into a small amount of information that can be used by other parts of the system.

DataSource

A DataSource is some external entity that puts data into the system. This data generally falls into two categories:

  • Bibliographic information about a book, such as its title or cover image. This goes into the bibliographic metadata subsystem.
  • Licensing information which can be used to serve actual copies of the book to library patrons. This goes into the licensing subsystem.

Some examples of DataSources:

  • Overdrive, Bibliotheca, and Axis 360 license commercially published ebooks to libraries for delivery to patrons. They also provide bibliographic information about the books they license.
  • Standard Ebooks provides bibliographic information about books, as well as free copies of the books themselves.
  • OCLC and Content Cafe provide bibliographic information about books, but have no way of giving access to the actual books.
  • VIAF provides information about the people who write books, but very little about the books themselves.
  • The New York Times knows the ISBNs of the books on its best-seller lists, but not much more.

A DataSource may also:

  • Provide many Editions
  • Provide many Equivalencys
  • Provide many Hyperlinks
  • Provide many Resources
  • Provide many Classifications
  • Provide many CustomLists
  • Grant access to many LicensePools
  • Provide many LicensePoolDeliveryMechanisms
  • Generate many CoverageRecords
  • Have many associated Credentials
  • Have one IntegrationClient

Image Added



Identifier

An Identifier provides a way to uniquely refer to a particular book. Common types of Identifier include ISBNs and proprietary IDs such as Overdrive or Bibliotheca IDs.

An Identifier may:

  • Have many Classifications representing how the book would be shelved in a bookstore or library. (See the classification subsystem.)
  • Have many Measurements of quantities like quality and popularity. (See the measurement subsystem.)
  • Have many HyperLinks to associated files such as cover images or descriptions. (See the linked resources subsystem.)
  • Participate in many Equivalencys.
  • Serve as the primary_identifier for multiple Editions.
  • Serve as the identifier for many LicensePools, through Collection.
  • Be associated with one Work, through Edition

Image Added



Equivalency

An Equivalency is an assertion made by a DataSource that two different Identifiers refer to the same book.

  • The strength of the Equivalency is a number from -1 to 1 indicating how much we trust the assertion. When Overdrive says that an Overdrive ID is equivalent to an ISBN, we give that Equivalency a strength of 1, because Overdrive got the ISBN from the publisher and assigned the Overdrive ID itself. When OCLC says that two ISBNs represent the same book, we give it a lower strength, because OCLC is frequently wrong about this. A negative strength means that the DataSource is pretty sure two Identifiers represent differentbooks.

Image Added


Edition

An Edition is a collection of information about a book from a particular data source. Like most items in the "bibliographic metadata" section, it represents an opinion. If different data sources give conflicting information about a book, that's fine -- everyone has their opinion. When this happens, we create multiple Editions and we sort it out later, when it's time to make the presentation edition.


An Edition:

  • Has one DataSource. This is the data source whose opinions are recorded in the Edition.
  • Has one Identifier, the primary_identifier. This identifies the book the data source is talking about.
  • Contains basic metadata -- title, series, language, publisher, medium -- for that book.
  • May have one or more Contributors, through Contribution.
  • May be the presentation edition for a specific Work. The presentation edition is a synthetic Edition created by the system. We look over a bunch of Editions which are all (supposedly) talking about the same book, and consolidate it into a new Edition containing the best or most trusted metadata.

Image Added


The contributor subsystem

This system basically tracks who wrote which book. There are two classes in this subsystem: Contributor and Contribution.

Image Added

Contributor

A Contributor A Contributor is a human being or a corporate entity who is credited with work on some Editionsome Edition. The credit itself is kept in a a Contribution, which ties a Contributor to an a Contributor to an Edition.

A Contributor:

Contains basic biographical information about a person or corporation. Most notably, it has both a display_name such as "Octavia Butler", the name that would go on the front of a book, and a sort_name such as "Butler, Octavia", the name that would go in a card catalog.

Image Added


ContributionA Contribution:

A Contribution is piece of information contributed

  • Links a Contributor to an Edition.
  • Contains a role describing the work the Contributor did on the Edition. Common roles include author, editor, translator, illustrator, and narrator.

Image Added


The classification subsystem

This system tracks how a book might be classified in a card catalog or shelved in a bookstore. There are two classes in this subsystem: Subject and Classification.


Image Added

Subject

A A Subject represents  represents a classification that someone might give a book. Subject handles  Subject handles a variety of classification schemes: Dewey Decimal, LLC, LCSH, BISAC, proprietary systems like Overdrive's, and free-form tags, among others.

Four pieces of information might be derived from the Subject, and will be stored with the Subject if possible:

  • Genre ("Billionare Romance" is a type of romance)
  • Fiction/nonfiction status ("Science Fiction" is always fiction)
  • Target audience ("Young Adult Fantasy" is always YA)
  • Target age ("Picture books" are generally for very young children, not 12-year-olds.)

Image Added



Classification


A Classification is someone's opinion that a book should be filed under a certain Subject.

A Classification:

  • Links a Subject to an Identifier.
  • Has an associated DataSource -- this tracks whose opinion it is.
  • Has an associated weight representing how certain we are that the book should be filed under this subject. The higher the number, the more certain we are. If OCLC says that a single library has filed a certain book under "Whales", we'll record that information but give it a low weight. If OCLC says that ten thousand libraries have filed this book under "Whales", then it's probably about whales.


Image Added


Genre

There are many different data sources which use many different classification schemes for the same books. Rather than expose this chaos to patrons, we have defined about 150 Genres, corresponding to the sections of a large bookstore or branch library: "Romance", "Biography", and so on.

Each Subject may be associated with a Genre. When LicensePools are turned into Works, all the related Classifications are gathered together. We then assign the Work to the Genre that showed up the most.

A Genre may also be associated with one or more Lanes -- this is the primary technique we use when choosing how to show books to patrons.

Image Added


Measurement

A Measurement is a numeric value associated with an Identifier. It represents some quality that distinguishes one book from others. The most useful measurements are popularity (a popular book is read/accessed/purchased/accessioned more often) and rating (a highly rated book is considered to be of high quality).

The linked resources subsystem

This system keeps track of external resources associated with a book. An "external resource" can be pretty much anything, but these are the most common types of resources we track:

  • A cover image
  • A thumbnailed version of a preexisting cover image
  • A textual description
  • An EPUB copy of a free book
  • A review

Hyperlink

A Hyperlink represents a connection between an Identifier and a Resource. It contains two extra pieces of information about the link:

  • A DataSource -- who provided this link?
  • rel -- what is the relationship between the Identifier and the Resource? "There's a link" is very vague; this is more specific. Different rel values are defined for a cover image, a thumbnail image, review, a description, a copy of the actual book, and so on.

Resource

A Resource represents a document found somewhere on the Internet -- probably either a cover image or a free book. It has a url, and that's basically it -- everything about the document itself is kept in Representation.

  • A Resource that's an image may be chosen by an Edition as the best available cover image for a given book.
  • A Resource that's a textual description may be chosen by a Work as the best description for a given book.
  • A LicensePoolDeliveryMechanism for an open-access book will point to a Resource that represents the book itself.

Representation

A Representation is a local cache of a Resource. It represents our attempt to actually download a Resource and records what happened when we tried. If everything went well, the Representation will contain a file--binary, text, HTML, or image. Otherwise, the Representation will contain information about what went wrong -- maybe the server was down or something.

...

Anchor
Licensing
Licensing
Licensing

Collection

A Collection represents a set of books that are made available through one set of credentials.

...

The books themselves are stored as LicensePools, and the credentials are stored in an ExternalIntegration.

LicensePool

A LicensePool represents an agreement on the part of a book vendor to actually deliver a book to a patron.

...

A Work represents a book in general, as opposed to one specific edition of a book, or a specific licensing agreement to deliver copies of a book.A Work:

Image Added


About WorksDB Schema

May have copies scattered across many LicensePools

Image Added

May have many Editions, but derives its presentation metadata from one particular Edition, which is known as its “presentation edition.” This special Edition represents the best available bibliographic metadata for the book.

Image Added

Stores information that has been aggregated from multiple sources and summarized:

  • Subject matter classification (aggregated from Classifications)
  • Intended audience (aggregated from Classifications)
  • Fiction/nonfiction status (aggregated from Classifications)
  • Popularity (aggregated from Measurements)
  • The best available summary (aggregated from Resources)

May be referenced by multiple CustomListEntries and/or CachedFeeds.

Image Added

May participate in many WorkGenre assignments. WorkGenre is a simple join table that tracks the assignment of Works to Genres.


Anchor
Custom lists
Custom lists
Custom lists

A CustomList is a list of books, typically grouped by a criterion such as genre, subject, bestseller status, etc., which a librarian has compiled in the admin interface. Each CustomList is associated with, and presented to patrons in the front-end as, one Lane. A CustomList has at least one CustomListEntry, each of which refers to a particular Work.

Image Added

Anchor
Libraries
Libraries
Libraries

...