anas/divan
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: #306 GanjoorPoemSection model

Browse Source
This commit is contained in:
Hamid Reza Mohammadi 2022-04-01 11:43:51 +04:30
parent 0e4b2f5d96
commit 23b5851e09
3 changed files with 136 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
RMuseum/Models/Ganjoor/GanjoorPoem.cs
View File

@ -59,7 +59,7 @@ namespace RMuseum.Models.Ganjoor
/// </summary>
/// <remarks>
/// in fact this should be a many-to-many relationship, but our current dataset lacks such a relationship instance and
/// because in fact it is actuallay this relationship should exists between a non-existant entity called block of poem
/// because in fact it is actually this relationship should exists between a non-existant entity called block of poem <see cref="RMuseum.Models.Ganjoor.GanjoorPoemSection"/>
/// I ignored this relationship to take care of it whenever the block entity would be added to the data structure
/// </remarks>
public int? GanjoorMetreId { get; set; }

66
RMuseum/Models/Ganjoor/GanjoorPoemSection.cs Normal file
View File

@ -0,0 +1,66 @@
namespace RMuseum.Models.Ganjoor
{
/// <summary>
/// poem section type
/// </summary>
public enum PoemSectionTypes
{
/// <summary>
/// sections like paragraphs or poems within paragraphs of text
/// </summary>
Default = 0,
/// <summary>
/// bands of a multi-band poem
/// </summary>
Band = 1,
/// <summary>
/// some are virtual because they contain verse from different parts of poems (like verses from all band couplets)
/// </summary>
Virtual = 2,
}
/// <summary>
/// Ganjoor Poem Section
/// </summary>
public class GanjoorPoemSection
{
/// <summary>
/// record id
/// </summary>
public int Id { get; set; }
/// <summary>
/// use this field instead of Id for referencing to ease record deletion for verses, Index starts at 0, each poem should have at least one non-virtual part ordered by Index without break
/// </summary>
public int Index { get; set; }
/// <summary>
/// for lots of poems Number equals to Index + 1, but for rare ones such as a paragraph containing multi-band poem this could be different, 0 means no visible numbers
/// </summary>
public int Number { get; set; }
/// <summary>
/// section type
/// </summary>
public PoemSectionTypes SectionType { get; set; }
/// <summary>
/// prosody information
/// </summary>
/// <remarks>
/// in fact this should be a many-to-many relationship, but our current dataset lacks such a relationship instance
/// </remarks>
public int? GanjoorMetreId { get; set; }
/// <summary>
/// metre
/// </summary>
public virtual GanjoorMetre GanjoorMetre { get; set; }
/// <summary>
/// rhyme letters
/// </summary>
public string RhymeLetters { get; set; }
}
}

70
RMuseum/RMuseum.xml
View File

@ -6550,7 +6550,7 @@
</summary>
<remarks>
in fact this should be a many-to-many relationship, but our current dataset lacks such a relationship instance and
because in fact it is actuallay this relationship should exists between a non-existant entity called block of poem
because in fact it is actually this relationship should exists between a non-existant entity called block of poem <see cref="T:RMuseum.Models.Ganjoor.GanjoorPoemSection"/>
I ignored this relationship to take care of it whenever the block entity would be added to the data structure
</remarks>
</member>
@ -6734,6 +6734,69 @@
metre
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.PoemSectionTypes">
<summary>
poem section type
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.PoemSectionTypes.Default">
<summary>
sections like paragraphs or poems within paragraphs of text
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.PoemSectionTypes.Band">
<summary>
bands of a multi-band poem
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.PoemSectionTypes.Virtual">
<summary>
some are virtual because they contain verse from different parts of poems (like verses from all band couplets)
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorPoemSection">
<summary>
Ganjoor Poem Section
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.Id">
<summary>
record id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.Index">
<summary>
use this field instead of Id for referencing to ease record deletion for verses, Index starts at 0, each poem should have at least one non-virtual part ordered by Index without break
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.Number">
<summary>
for lots of poems Number = Index + 1, but for rare ones such as a paragraph containing multi-band poem this could be different, 0 means no visible numbers
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.SectionType">
<summary>
section type
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.GanjoorMetreId">
<summary>
prosody information
</summary>
<remarks>
in fact this should be a many-to-many relationship, but our current dataset lacks such a relationship instance
</remarks>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.GanjoorMetre">
<summary>
metre
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoemSection.RhymeLetters">
<summary>
rhyme letters
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorPoemTranslation">
<summary>
poem translation
@ -8969,6 +9032,11 @@
alternate text
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.ViewModels.PoemRelatedImage.IsTextOriginalSource">
<summary>
is text original source
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.ViewModels.PoemVerseOrder">
<summary>
poem + verse order