C# Class SobekCM.Engine_Library.Items.SobekCM_Item_Factory

Static class is used to build item and page objects for display in SobekCM
This class relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.
Show file Open project: MarkVSullivan/SobekCM-Web-Application

Public Methods

Method Description
Get_Current_Page ( SobekCM_Item Current_Item, int Sequence, Custom_Tracer Tracer ) : SobekCM.Resource_Object.Divisions.Page_TreeNode

Gets a page from an existing digital resource, by page sequence

Get_Item ( string BibID, string VID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item

Builds a digital resource object for the given BibID and VID

This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.

Get_Item ( string METS_Location, string BibID, string VID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item

Builds a digital resource object for the given BibID and VID

This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.

Get_Item_Group ( string BibID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item

Builds a title-level digital resource object for the given BibID

This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.

Method Details

Get_Current_Page() public static method

Gets a page from an existing digital resource, by page sequence
public static Get_Current_Page ( SobekCM_Item Current_Item, int Sequence, Custom_Tracer Tracer ) : SobekCM.Resource_Object.Divisions.Page_TreeNode
Current_Item SobekCM.Resource_Object.SobekCM_Item Digital resource from which to pull the current page, by sequence
Sequence int Sequence for the page to retrieve from this item
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Resource_Object.Divisions.Page_TreeNode

Get_Item() public static method

Builds a digital resource object for the given BibID and VID
This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.
public static Get_Item ( string BibID, string VID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item
BibID string Bibliographic identifier for the digital resource to build
VID string Volume identifier for the digital resource to builder
Icon_Dictionary Wordmark_Icon>.Dictionary Dictionary of information about every wordmark/icon in this digital library, used to build the HTML for the icons linked to this digital resource
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Resource_Object.SobekCM_Item

Get_Item() public static method

Builds a digital resource object for the given BibID and VID
This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.
public static Get_Item ( string METS_Location, string BibID, string VID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item
METS_Location string Location and name of the METS file to read
BibID string Bibliographic identifier for the title
VID string Volume identifier for the title
Icon_Dictionary Wordmark_Icon>.Dictionary Dictionary of information about every wordmark/icon in this digital library, used to build the HTML for the icons linked to this digital resource
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Resource_Object.SobekCM_Item

Get_Item_Group() public static method

Builds a title-level digital resource object for the given BibID
This method relies heavily upon the SobekCM_METS_Based_ItemBuilder class to actually read the METS files and build the items.
public static Get_Item_Group ( string BibID, Wordmark_Icon>.Dictionary Icon_Dictionary, Custom_Tracer Tracer ) : SobekCM_Item
BibID string Bibliographic identifier for the digital resource to build
Icon_Dictionary Wordmark_Icon>.Dictionary Dictionary of information about every wordmark/icon in this digital library, used to build the HTML for the icons linked to this digital resource
Tracer SobekCM.Tools.Custom_Tracer Trace object keeps a list of each method executed and important milestones in rendering
return SobekCM.Resource_Object.SobekCM_Item