Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder Class Referenceabstract

Inherits Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.

Inherited by Lucene.Net.Search.Vectorhighlight.ScoreOrderFragmentsBuilder, and Lucene.Net.Search.Vectorhighlight.SimpleFragmentsBuilder.

Public Member Functions

abstract List< WeightedFragInfoGetWeightedFragInfoList (List< WeightedFragInfo > src)
 
virtual String CreateFragment (IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList)
 create a fragment.
 
virtual String[] CreateFragments (IndexReader reader, int docId, String fieldName, FieldFragList fieldFragList, int maxNumFragments)
 create multiple fragments.
 

Static Public Attributes

static String[] COLORED_PRE_TAGS
 
static String[] COLORED_POST_TAGS = { "</b>" }
 

Protected Member Functions

 BaseFragmentsBuilder ()
 
 BaseFragmentsBuilder (String[] preTags, String[] postTags)
 
virtual String[] GetFieldValues (IndexReader reader, int docId, String fieldName)
 
virtual Field[] GetFields (IndexReader reader, int docId, String fieldName)
 
virtual String MakeFragment (StringBuilder buffer, int[] index, String[] values, WeightedFragInfo fragInfo)
 
virtual String MakeFragment (StringBuilder buffer, int[] index, Field[] values, WeightedFragInfo fragInfo)
 
virtual String GetFragmentSource (StringBuilder buffer, int[] index, String[] values, int startOffset, int endOffset)
 
virtual String GetFragmentSource (StringBuilder buffer, int[] index, Field[] values, int startOffset, int endOffset)
 
virtual String GetPreTag (int num)
 
virtual String GetPostTag (int num)
 

Protected Attributes

String[] preTags
 

Detailed Description

Definition at line 32 of file BaseFragmentsBuilder.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.BaseFragmentsBuilder ( )
protected

Definition at line 47 of file BaseFragmentsBuilder.cs.

Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.BaseFragmentsBuilder ( String[]  preTags,
String[]  postTags 
)
protected

Definition at line 53 of file BaseFragmentsBuilder.cs.

Member Function Documentation

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.CreateFragment ( IndexReader  reader,
int  docId,
String  fieldName,
FieldFragList  fieldFragList 
)
virtual

create a fragment.

Parameters
readerIndexReader of the index
docIddocument id to be highlighted
fieldNamefield of the document to be highlighted
fieldFragListFieldFragList object
Returns
a created fragment or null when no fragment created

Implements Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.

Definition at line 68 of file BaseFragmentsBuilder.cs.

virtual String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.CreateFragments ( IndexReader  reader,
int  docId,
String  fieldName,
FieldFragList  fieldFragList,
int  maxNumFragments 
)
virtual

create multiple fragments.

Parameters
readerIndexReader of the index
docIddocument id to be highlighted
fieldNamefield of the document to be highlighted
fieldFragListieldFragList object
maxNumFragmentsmaximum number of fragments
Returns
created fragments or null when no fragments created. Size of the array can be less than maxNumFragments

Implements Lucene.Net.Search.Vectorhighlight.FragmentsBuilder.

Definition at line 75 of file BaseFragmentsBuilder.cs.

virtual Field [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFields ( IndexReader  reader,
int  docId,
String  fieldName 
)
protectedvirtual

Definition at line 102 of file BaseFragmentsBuilder.cs.

virtual String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFieldValues ( IndexReader  reader,
int  docId,
String  fieldName 
)
protectedvirtual

Definition at line 96 of file BaseFragmentsBuilder.cs.

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFragmentSource ( StringBuilder  buffer,
int[]  index,
String[]  values,
int  startOffset,
int  endOffset 
)
protectedvirtual

Definition at line 163 of file BaseFragmentsBuilder.cs.

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetFragmentSource ( StringBuilder  buffer,
int[]  index,
Field[]  values,
int  startOffset,
int  endOffset 
)
protectedvirtual

Definition at line 176 of file BaseFragmentsBuilder.cs.

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetPostTag ( int  num)
protectedvirtual

Definition at line 195 of file BaseFragmentsBuilder.cs.

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetPreTag ( int  num)
protectedvirtual

Definition at line 189 of file BaseFragmentsBuilder.cs.

abstract List<WeightedFragInfo> Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.GetWeightedFragInfoList ( List< WeightedFragInfo src)
pure virtual
virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.MakeFragment ( StringBuilder  buffer,
int[]  index,
String[]  values,
WeightedFragInfo  fragInfo 
)
protectedvirtual

Definition at line 110 of file BaseFragmentsBuilder.cs.

virtual String Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.MakeFragment ( StringBuilder  buffer,
int[]  index,
Field[]  values,
WeightedFragInfo  fragInfo 
)
protectedvirtual

Definition at line 116 of file BaseFragmentsBuilder.cs.

Member Data Documentation

String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.COLORED_POST_TAGS = { "</b>" }
static

Definition at line 45 of file BaseFragmentsBuilder.cs.

String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.COLORED_PRE_TAGS
static
Initial value:
= {
"<b style=\"background:yellow\">", "<b style=\"background:lawngreen\">", "<b style=\"background:aquamarine\">",
"<b style=\"background:magenta\">", "<b style=\"background:palegreen\">", "<b style=\"background:coral\">",
"<b style=\"background:wheat\">", "<b style=\"background:khaki\">", "<b style=\"background:lime\">",
"<b style=\"background:deepskyblue\">", "<b style=\"background:deeppink\">", "<b style=\"background:salmon\">",
"<b style=\"background:peachpuff\">", "<b style=\"background:violet\">", "<b style=\"background:mediumpurple\">",
"<b style=\"background:palegoldenrod\">", "<b style=\"background:darkkhaki\">", "<b style=\"background:springgreen\">",
"<b style=\"background:turquoise\">", "<b style=\"background:powderblue\">"
}

Definition at line 35 of file BaseFragmentsBuilder.cs.

String [] Lucene.Net.Search.Vectorhighlight.BaseFragmentsBuilder.preTags
protected

Definition at line 34 of file BaseFragmentsBuilder.cs.


The documentation for this class was generated from the following file: