| using Lucene.Net.Index; |
| using Lucene.Net.Util; |
| using System; |
| |
| namespace Lucene.Net.Documents |
| { |
| /* |
| * 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. |
| */ |
| |
| /// <summary> |
| /// Field that stores a per-document <see cref="BytesRef"/> value. |
| /// <para/> |
| /// The values are stored directly with no sharing, which is a good fit when |
| /// the fields don't share (many) values, such as a title field. If values |
| /// may be shared and sorted it's better to use <see cref="SortedDocValuesField"/>. |
| /// Here's an example usage: |
| /// |
| /// <code> |
| /// document.Add(new BinaryDocValuesField(name, new BytesRef("hello"))); |
| /// </code> |
| /// <para/> |
| /// If you also need to store the value, you should add a |
| /// separate <see cref="StoredField"/> instance. |
| /// </summary> |
| /// <seealso cref="BinaryDocValues"/> |
| public class BinaryDocValuesField : Field |
| { |
| /// <summary> |
| /// Type for straight bytes <see cref="DocValues"/>. |
| /// </summary> |
| public static readonly FieldType fType = new FieldType(); |
| |
| static BinaryDocValuesField() |
| { |
| fType.DocValueType = DocValuesType.BINARY; |
| fType.Freeze(); |
| } |
| |
| /// <summary> |
| /// Create a new binary <see cref="DocValues"/> field. </summary> |
| /// <param name="name"> field name </param> |
| /// <param name="value"> binary content </param> |
| /// <exception cref="ArgumentNullException"> if the field name is null </exception> |
| public BinaryDocValuesField(string name, BytesRef value) |
| : base(name, fType) |
| { |
| FieldsData = value; |
| } |
| } |
| } |