C# Class Core.API.CoreDocument

Show file Open project: brunomlopes/ILoveLucene

Private Properties

Property	Type	Description
CoreDocument	System
FieldForLearning	Lucene.Net.Documents.Field
PopulateDocument	CoreDocument
RequireFields	void
SetField	CoreDocument

Public Methods

Method	Description
CoreDocument ( IItemSource itemSource, IConverter converter, string id, string name, string type ) : System	Populates the document from the converter
GetDocumentId ( ) : DocumentId
GetString ( string fieldName ) : string
GetStringList ( string fieldName ) : IEnumerable
Index ( string fieldName ) : CoreDocument
Rehydrate ( Document document ) : CoreDocument
SetItemIdForLearning ( string id ) : CoreDocument	Use this value in the learning hash instead of the item id. Used by process source to learn based on window title instead of process identifier
SetLearningId ( string id ) : CoreDocument
SetLearnings ( IEnumerable learnings ) : CoreDocument
Store ( string fieldName ) : CoreDocument
Tag ( string tag ) : CoreDocument

Private Methods

Method	Description
CoreDocument ( Lucene.Net.Documents.Document document ) : System
FieldForLearning ( string learning ) : Field
PopulateDocument ( string sourceId, string converterId, string id, string name, string type ) : CoreDocument
RequireFields ( ) : void
SetField ( string fieldName, IEnumerable content, Field analyzed, Field withTermVector ) : CoreDocument

Method Details

CoreDocument() public method

Populates the document from the converter

public CoreDocument ( IItemSource itemSource, IConverter converter, string id, string name, string type ) : System
itemSource	IItemSource	item from which this document was retrieved
converter	IConverter	converter identifier
id	string	item identifier
name	string	item name that is used to be indexed
type	string	Type name used in the indexer and later on in the searcher to allow the user to filter by type /// Search would be something like "process firefox"
return	System

GetDocumentId() public method

public GetDocumentId ( ) : DocumentId
return	DocumentId

GetString() public method

public GetString ( string fieldName ) : string
fieldName	string
return	string

GetStringList() public method

public GetStringList ( string fieldName ) : IEnumerable
fieldName	string
return	IEnumerable

Index() public method

public Index ( string fieldName ) : CoreDocument
fieldName	string
return	CoreDocument

Rehydrate() public static method

public static Rehydrate ( Document document ) : CoreDocument
document	Document
return	CoreDocument

SetItemIdForLearning() public method

Use this value in the learning hash instead of the item id. Used by process source to learn based on window title instead of process identifier

public SetItemIdForLearning ( string id ) : CoreDocument
id	string
return	CoreDocument

SetLearningId() public method

public SetLearningId ( string id ) : CoreDocument
id	string
return	CoreDocument

SetLearnings() public method

public SetLearnings ( IEnumerable learnings ) : CoreDocument
learnings	IEnumerable
return	CoreDocument

Store() public method

public Store ( string fieldName ) : CoreDocument
fieldName	string
return	CoreDocument

Tag() public method

public Tag ( string tag ) : CoreDocument
tag	string
return	CoreDocument