C# Class SobekCM.Library.ResultsViewer.abstract_ResultsViewer

Abstract class which implements the iResultsViewer interface and which all subsequent results viewer classes must extend

Inheritance: iResultsViewer

Datei anzeigen Open project: MarkVSullivan/SobekCM-Web-Application

Protected Properties

Property	Type	Description
CurrentUserMask	int
PagedResults	List
RequestSpecificValues	RequestCache
ResultsStats	SobekCM.Core.Results.Search_Results_Statistics
Results_Per_Page	int

Public Methods

Method	Description
Add_HTML ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void	Adds the controls for this result viewer to the place holder on the main form
StartRow ( int CalculatedLastRow ) : int	Returns the index for the first row to be displayed on the current page, and performs validation against the calculated last row to ensure correctness

Protected Methods

Method	Description
Add_Issue_Tree ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, iSearch_Title_Result TitleRow, int CurrentResultRow, string CalculatedTextRedirectStem, string BaseURL ) : void	Builds the tree view control for all the issues related to a single result title and adds the tree view to the provided place holder This only adds the root node for the tree. Any further computations and tree-creation are left for the tree node populate event when the user requests any issue information.
abstract_ResultsViewer ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System	Constructor for a new instance of the abstract_ResultsViewer class

Private Methods

Method	Description
compute_image_redirect_stem ( ) : string
compute_text_redirect_stem ( ) : string
treeView1_TreeNodePopulate ( object Sender, System.Web.UI.WebControls.TreeNodeEventArgs E ) : void	Event handler loads the nodes on request to the serial hierarchy trees when the user requests them by expanding a node

Method Details

Add_HTML() public abstract method

Adds the controls for this result viewer to the place holder on the main form

public abstract Add_HTML ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, Custom_Tracer Tracer ) : void
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Main place holder ( "mainPlaceHolder" ) in the itemNavForm form into which the the bulk of the result viewer's output is displayed
Tracer	SobekCM.Tools.Custom_Tracer	Trace object keeps a list of each method executed and important milestones in rendering
return	void

Add_Issue_Tree() protected method

Builds the tree view control for all the issues related to a single result title and adds the tree view to the provided place holder

This only adds the root node for the tree. Any further computations and tree-creation are left for the tree node populate event when the user requests any issue information.

protected Add_Issue_Tree ( System.Web.UI.WebControls.PlaceHolder MainPlaceHolder, iSearch_Title_Result TitleRow, int CurrentResultRow, string CalculatedTextRedirectStem, string BaseURL ) : void
MainPlaceHolder	System.Web.UI.WebControls.PlaceHolder	Main place holder ( "mainPlaceHolder" ) in the itemNavForm form into which the results are being built for display
TitleRow	iSearch_Title_Result	Title row for this title to be displayed, from the dataset of results
CurrentResultRow	int	Counter indicates which result number this is within the current page of results
CalculatedTextRedirectStem	string	Redirect string specifically for textual items, which includes the search terms to pass to the final item viewer
BaseURL	string	Writer-adjusted base_url ( i.e., may include /l at the end if logged in currently )
return	void

StartRow() public method

Returns the index for the first row to be displayed on the current page, and performs validation against the calculated last row to ensure correctness

public StartRow ( int CalculatedLastRow ) : int
CalculatedLastRow	int	Calculated last row to be displayed, to be used for validation purposes
return	int

abstract_ResultsViewer() protected method

Constructor for a new instance of the abstract_ResultsViewer class

protected abstract_ResultsViewer ( RequestCache RequestSpecificValues, SobekCM.Core.Results.Search_Results_Statistics ResultsStats, List PagedResults ) : System
RequestSpecificValues	RequestCache	All the necessary, non-global data specific to the current request
ResultsStats	SobekCM.Core.Results.Search_Results_Statistics	Statistics about the results to display including the facets
PagedResults	List	Actual pages of results
return	System

Property Details

CurrentUserMask protected_oe property

Protected field contains the current user IP restriction mask, used to determine if this use has access to IP restricted items

protected int CurrentUserMask
return	int

PagedResults protected_oe property

protected List PagedResults
return	List

RequestSpecificValues protected_oe property

Values specific to the current HTML request

protected RequestCache RequestSpecificValues
return	RequestCache

ResultsStats protected_oe property

protected Search_Results_Statistics,SobekCM.Core.Results ResultsStats
return	SobekCM.Core.Results.Search_Results_Statistics

Results_Per_Page protected_oe property

Number of results included in each page of results

protected int Results_Per_Page
return	int