mySobek Home   |   Help
Skip Navigation Links.
MISSING BANNER
Code Details >> Builder_Library Namespace

SobekCM.Builder_Library Namespace



Main library holds all the classes that are used only by the builder. This includes all the standard builder module classes, some conversion classes, the statistics accumulating and records classes, and the settings. Currently, this library is shared between the command line (scheduled task builder) and the windows service builder version.

Sub-Namespaces

NamespaceDescription
Modules
Contains all of the standard builder module sub-namespaces, as well as some basic classes used by the modules. These modules are the chunks of code that perform the actual work of the builder, checking incoming folders, processing new items, reprocessing recently submitted items, and performing a number of other tasks.
Modules.Folders
Contains all the standard builder modules that are used by the builder when checking incoming builder folders. These help determine which items will be selected for processing in the next steps of the builder and can also do some preparation work of incoming material that is non-standard formats.
Modules.Items
Contains all the item-specific modules used by the builder for processing both newly incoming materials via the builder folders and also reprocessing materials that were recently submitted. Some modules also specifically perform functions necessary for deleting existing digital resources.
Modules.PostProcess
Contains all the standard modules run the builder AFTER each turn of processing incoming packages and reprocessing recently packages for a single instance of SobekCM
Modules.PreProcess
Contains all the standard modules run the builder BEFORE each turn of processing incoming packages and reprocessing recently packages for a single instance of SobekCM
Modules.Schedulable
Contains all the standard modules that are run by the SobekCM builder on a schedule. This can include things that run once a night, or things that run once a week. These tasks help to maintain the general health to the system and perform some basic maintenance tasks.
Settings
Settings specific to the builder, or specific to the condition of running across multiple instance of SobekCM, as the builder can be configure to do. This includes the setting information for the modules to run and the order to run them.
Statistics
Classes specific to the collection, aggregation, and recording of usage statistics for digital resources within this instance of SobekCM.
Tools
Tools used by the builder to perform resource manipulation, such as extraction of text from PDFs, conversion of Office files to PDF, creation of the MARC feed, etc..

Classes

  ClassDescription
Public classAbort_Database_Mechanism
Class is used to check for a builder abort request via a database flag
Public classActionable_Builder_Source_Folder
Builder source folder that adds the ability to perform some basic processing to the base Builder_Source_Folder class
Public classIncoming_Digital_Resource
Class is a wrapper around a SobekCM_Item digital object, which allows for commonly executed processes to assist with the SobekCM Builder
Public classWorker_BulkLoader
Class is the worker thread for the main bulk loader processor
Public classWorker_Controller
Class controls the execution of all tasks, whether being immediately executed or running continuously in a background thread

Enumerations

  EnumerationDescription
Public enumerationBuilder_Operation_Flag_Enum
Enumeration which reflects a possible state for the builder operation flag
Public enumerationIncoming_Digital_Resource..::..Incoming_Digital_Resource_Type
Enumerational value indicates the type of incoming digital resource


Version 4.10.0 ( last generated Monday, March 7, 2016 )