Calculate a scoring factor based on the data in the payload. Overriding implementations are responsible for interpreting what is in the payload. Lucene makes no assumptions about what is in the byte array.

The default implementation returns 1.

Namespace: Lucene.Net.Search
Assembly: Lucene.Net (in Lucene.Net.dll) Version: 2.9.4.1

Syntax

C#
[ObsoleteAttribute("See ScorePayload(int, String, int, int, byte[], int, int)")]
public virtual float ScorePayload(
	string fieldName,
	byte[] payload,
	int offset,
	int length
)
Visual Basic
<ObsoleteAttribute("See ScorePayload(int, String, int, int, byte[], int, int)")> _
Public Overridable Function ScorePayload ( _
	fieldName As String, _
	payload As Byte(), _
	offset As Integer, _
	length As Integer _
) As Single
Visual C++
[ObsoleteAttribute(L"See ScorePayload(int, String, int, int, byte[], int, int)")]
public:
virtual float ScorePayload(
	String^ fieldName, 
	array<unsigned char>^ payload, 
	int offset, 
	int length
)

Parameters

fieldName
Type: System..::..String
The fieldName of the term this payload belongs to
payload
Type: array<System..::..Byte>[]()[][]
The payload byte array to be scored
offset
Type: System..::..Int32
The offset into the payload array
length
Type: System..::..Int32
The length in the array

Return Value

An implementation dependent float to be used as a scoring factor

See Also