mySobek Home   |   Help
Skip Navigation Links.
Expand <a href='https://sobekrepository.org/sobekcm' title='Sobek home page'>Project Home</a>Project Home
Expand <a href='https://sobekrepository.org/help' title='Online user help'>User Help</a>User Help
Expand <a href='https://sobekrepository.org/sobekcm/technical' title='Sobek home page'>Technical Help</a>Technical Help
Expand <a href='https://sobekrepository.org/software' title='Center for downloading all SobekCM-related software'>Download Center</a>Download Center
Training Videos
Collapse <a href='https://sobekrepository.org/codehelp' title='Details on each of the different classes, interfaces, properties, etc..'>Code Details</a>Code Details
MISSING BANNER
Code Details >> Engine_Library >> Solr >> Solr_Document_Result

Solr_Document_Result Class



Stores the information relating to a single result from ansearch within a Solr index


Namespace: SobekCM.Engine_Library.Solr
Assembly: SobekCM_Engine_Library (in SobekCM_Engine_Library.dll) Version: 4.10.0.0 (4.10.0.0)

Syntax

C#
[SerializableAttribute]
public class Solr_Document_Result : iSearch_Title_Result, 
	iSearch_Item_Result

Remarks

This is populated by the Solr query through SolrNet, using the SolrNet property attributes as guides. The highlighted snippet containing the search term(s) for this page is also loaded into this object

This class implements both the iSearch_Title_Result and iSearch_Item_Result interfaces because Solr/Lucene search results are a flattened, non-hierarchical structure. Each result contains all the title and item information within a single result object.

Inheritance Hierarchy

System..::..Object
  SobekCM.Engine_Library.Solr..::..Solr_Document_Result

Constructors

  NameDescription
Public methodSolr_Document_Result
Constructor for a new instance of the Solr_Document_Result class

Methods

  NameDescription
Public methodBuild_Item_Tree
Builds the tree of items under this title, for multiple item titles
Public methodGet_Item
Gets the item indicated by the provided index

Properties

  NameDescription
Public propertyAuthor
Author (display version) associated with this single result from a search within this library
Public propertyBibID
Bibliographic identifier (BibID) associated with this single result from a search within this library
Public propertyCOinS_OpenURL
COinS OpenURL format of citation for citation sharing
Public propertyDID
Unique identifier for the digital object for this single result from a search within this library
Public propertyDonor
Donor's name associated with this single result from a search within this library
Public propertyEdition
Edition associated with this single result from a search within this library
Public propertyFormat
Format/Physical Description associated with this single result from a search within this library
Public propertyGroupThumbnail
Group-wide thumbnail for this title result
Public propertyGroupTitle
Group title for this title result
Public propertyHoldingLocation
Holding location associated with this single result from a search within this library
Public propertyInstitution
Institution associated with this single result from a search within this library
Public propertyIP_Restriction_Mask
IP restriction mask for this item within a title within a collection of results
Public propertyItem_Count
Gets the number of items contained within this title result
Public propertyItem_Tree
Gets the item tree view used for showing all the items under this title in a tree type html display
Public propertyLevel1_Index
Index of the first serial hierarchy level for this item within a title within a collection of results
Public propertyLevel1_Text
Text of the first serial hierarchy level for this item within a title within a collection of results
Public propertyLevel2_Index
Index of the second serial hierarchy level for this item within a title within a collection of results
Public propertyLevel2_Text
Text of the second serial hierarchy level for this item within a title within a collection of results
Public propertyLevel3_Index
Index of the third serial hierarchy level for this item within a title within a collection of results
Public propertyLevel3_Text
Text of the third serial hierarchy level for this item within a title within a collection of results
Public propertyLink
External URL for this item within a title within a collection of results
Public propertyMainThumbnail
Main thumbnail associated with this single result from a search within this library
Public propertyMaterial
Materials used in creation of a search result from a search within this library
Public propertyMaterialType
Material type associated with this single result from a search within this library
Public propertyMeasurement
Measurements for this single result from a search within this library
Public propertyMetadata_Display_Values
Metadata values to display for this item title result
Public propertyOCLC_Number
OCLC associated with this single result from a search within this library
Public propertyOPAC_Number
Local OPAC number associated with this single result from a search within this library
Public propertyPageCount
Number of pages within this item within a title within a collection of results
Public propertyPrimary_Identifier
Primary alternate identifier for this resource
Public propertyPrimary_Identifier_Type
Type of the primary alternate identifier for this resource ( i.e. 'Accession Number', etc.. )
Public propertyPubDate
Publication date associated with this single result from a search within this library
Public propertyPublisher
Publisher (display version) associated with this single result from a search within this library
Public propertySnippet
Highlighted snippet of text from this document
Public propertySourceInstitution
Source institution associated with this single result from a search within this library
Public propertySpatial_Coordinates
Spatial coverage for this title result in terms of coordinates for map display
Public propertySpatial_Coverage
Spatial coverage associated with this single result from a search within this library
Public propertySpatial_KML
Spatial coverage as KML for this item within a title result for map display
Public propertyStyle_Period
Style/period associated with this single result from a search within this library
Public propertySubjects
Subjects associated with this title result
Public propertyTechnique
Technique associated with this single result from a search within this library
Public propertyTitle
Main title associated with this single result from a search within this library
Public propertyURL
URL associated with this single result from a search within this library
Public propertyUserNotes
User notes for this title result, if it is in a bookshelf
Public propertyVID
Volume identifier (VID) associated with this single result from a search within this library

See Also



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