-
Notifications
You must be signed in to change notification settings - Fork 624
/
IPayloadAttribute.cs
45 lines (42 loc) · 1.82 KB
/
IPayloadAttribute.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
using Lucene.Net.Util;
namespace Lucene.Net.Analysis.TokenAttributes
{
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// javadocs
using BytesRef = Lucene.Net.Util.BytesRef;
/// <summary>
/// The payload of a Token.
/// <para/>
/// The payload is stored in the index at each position, and can
/// be used to influence scoring when using Payload-based queries
/// in the <see cref="Lucene.Net.Search.Payloads"/> and
/// <see cref="Lucene.Net.Search.Spans"/> namespaces.
/// <para/>
/// NOTE: because the payload will be stored at each position, its usually
/// best to use the minimum number of bytes necessary. Some codec implementations
/// may optimize payload storage when all payloads have the same length.
/// </summary>
/// <seealso cref="Index.DocsAndPositionsEnum"/>
public interface IPayloadAttribute : IAttribute
{
/// <summary>
/// Gets or Sets this <see cref="Token"/>'s payload.
/// </summary>
BytesRef Payload { get; set; }
}
}