Sequence Model - DDMAL/CantusDB GitHub Wiki

The Sequence model is a model in the main_app app. It is defined in /main_app/models/sequence.py (view file).

Sequence inherits from the abstract BaseChant model: both the Chant model and the Sequence model must have the same fields, or else errors will occur when a user searches for chants/sequences in the database. Thus, all fields, properties and attributes for both Chants and Sequences are declared in BaseChant in order to keep the two models' fields harmonized, even when only one of the two models uses a particular field.

Note that CantusDB uses "sequence" in two distinct senses:

  • First, to refer to this Sequence model and to Sequence objects - i.e. representing a piece of text written in a manuscript. The current page pertains to this usage.
  • Second, to refer to where a chant or sequence is located on a page (e.g. the first complete chant on a folio side is given a "sequence" of 1, the next of 2, and so on.) When used in this sense, c_sequence and s_sequence are used internally to refer to the locations of chants and sequences respectively. These property/field names should only ever be used internally - in all views, including our APIs, "Sequence" should be used in place of "C sequence" or "S sequence". For more information, see BaseChant Model > Fields.

Views

Sequence has Detail, List and Edit views.

Fields

  • inherited from BaseChant:
    • visible_status
    • title
    • incipit
    • siglum
    • folio
    • sequence
    • sequence_number
    • genre
    • rubrics
    • analecta_hymnica
    • indexing_notes
    • date
    • col1
    • col2
    • col3
    • ah_volume
    • source
    • cantus_id
    • image_link
    • json_info
    • marginalia
    • office
    • position
    • feast
    • mode
    • differentia
    • differentia_id
    • finalis
    • extra
    • chant_range
    • addendum
    • manuscript_full_text_std_spelling
    • manuscript_full_text_std_proofread
    • manuscript_full_text
    • manuscript_full_text_proofread
    • manuscript_syllabized_full_text
    • volpiano
    • volpiano_proofread
    • volpiano_notes
    • volpiano_intervals
    • cao_concordances
    • proofread_by
    • melody_id
    • search_vector
    • content_structure
    • next_chant
    • is_last_chant_in_feast
    • date_created
    • date_updated
    • created_by
    • last_updated_by

Methods

  • inherited from BaseChant:
    • save()
    • display_name (property)
    • get_absolute_url()
    • get_verbose_name()
    • get_verbose_name_plural()
    • get_fields_and_properties()