LuceneSearchDocument Class

Represents Lucene search document

Inheritance Hierarchy

System.Object
  CMS.Search.Lucene3.LuceneSearchDocument

Namespace: CMS.Search.Lucene3
Assembly: CMS.Search.Lucene3 (in CMS.Search.Lucene3.dll) Version: 8.2.23

Syntax

public class LuceneSearchDocument : ISearchDocument

The LuceneSearchDocument type exposes the following members.

Constructors

	Name	Description
Public method	LuceneSearchDocument()	Constructor
Public method	LuceneSearchDocument(Document)	Constructor

Methods

	Name	Description
Public method	Add	Adds the given field to the document
Public method	AddGeneralField	Add field do the Lucene document.
Public method	Get	Gets the value of specified field
Public method	Init	Creates search document.
Public method	PrepareContentValue	Prepares value to add to content field.
Public method	RemoveField	Removes field with the given name

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	Document	Underlying document

Remarks

This class is strongly tied with the current Lucene.Net library (version 3.0.3). We do not recommend using the class except for special cases.