lucene.net源码学习笔记（四）

今天看了一下Document.cs，Document这个类内部包含两个字段，一个是field的集合，通过ArrayList.Synchronized方法创建的，是线程安全的，另一个是boost表示排序时的优先级。下面是Document类的主要方法介绍:

方法	功能
GetFieldsCount()	获取field集合的数量
Void SetBoost(float boost)	设置document的boost值
GetBoost()	获取document的boost值
Void Add(Field field)	增加一个field
Void RemoveField(String name)	根据field的名字移除第一个符合条件的field
Void RemoveFields(String name)	根据field的名字移除所有符合条件的field
Field GetField(String name)	根据field的名字获取field对象，返回第一个结果
Field[] GetFields(String name)	根据field的名字获取field集合
String Get(String name)	根据field的名字获取一组字符串值，返回第一个结果
String[] GetValues(String name)	根据field的名字获取一组字符串值
byte[] GetBinaryValue(String name)	根据field的名字获取一个二进制流值，返回第一个结果
byte[][] GetBinaryValues(String name)	根据field的名字获取一组
String ToString()	重写ToString方法

 

Document类主要提供了对field集合的操作方法，结果比较简单，下面是源码：

 

  1/**//*
  2 * Licensed to the Apache Software Foundation (ASF) under one or more
  3 * contributor license agreements.  See the NOTICE file distributed with
  4 * this work for additional information regarding copyright ownership.
  5 * The ASF licenses this file to You under the Apache License, Version 2.0
  6 * (the "License"); you may not use this file except in compliance with
  7 * the License.  You may obtain a copy of the License at
  8 * 
  9 * http://www.apache.org/licenses/LICENSE-2.0
 10 * 
 11 * Unless required by applicable law or agreed to in writing, software
 12 * distributed under the License is distributed on an "AS IS" BASIS,
 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14 * See the License for the specific language governing permissions and
 15 * limitations under the License.
 16 */
 17
 18using System;
 19using IndexReader = Lucene.Net.Index.IndexReader;
 20using Hits = Lucene.Net.Search.Hits;
 21using Searcher = Lucene.Net.Search.Searcher;
 22
 23namespace Lucene.Net.Documents
 24{
 25    
 26    /**//// <summary>Documents are the unit of indexing and search.
 27    /// 
 28    /// A Document is a set of fields.  Each field has a name and a textual value.
 29    /// A field may be {@link Field#IsStored() stored} with the document, in which
 30    /// case it is returned with search hits on the document.  Thus each document
 31    /// should typically contain one or more stored fields which uniquely identify
 32    /// it.
 33    /// 
 34    /// <p>Note that fields which are <i>not</i> {@link Field#IsStored() stored} are
 35    /// <i>not</i> available in documents retrieved from the index, e.g. with {@link
 36    /// Hits#Doc(int)}, {@link Searcher#Doc(int)} or {@link
 37    /// IndexReader#Document(int)}.
 38    /// </summary>
 39    
 40    [Serializable]
 41    public sealed class Document
 42    {
 43        internal System.Collections.IList fields = System.Collections.ArrayList.Synchronized(new System.Collections.ArrayList(10));
 44        private float boost = 1.0f;
 45        
 46        /**//// <summary>Constructs a new document with no fields. </summary>
 47        public Document()
 48        {
 49        }
 50        
 51        /**//// <summary>Returns the number of fields in this document</summary>
 52        /// Added as a helper for Lucene.Net
 53        public int GetFieldsCount()
 54        {
 55            return fields.Count;
 56        }
 57        
 58        /**//// <summary>Sets a boost factor for hits on any field of this document.  This value
 59        /// will be multiplied into the score of all hits on this document.
 60        /// 
 61        /// <p>Values are multiplied into the value of {@link Field#GetBoost()} of
 62        /// each field in this document.  Thus, this method in effect sets a default
 63        /// boost for the fields of this document.
 64        /// 
 65        /// </summary>
 66        /// <seealso cref="Field.SetBoost(float)">
 67        /// </seealso>
 68        public void  SetBoost(float boost)
 69        {
 70            this.boost = boost;
 71        }
 72        
 73        /**//// <summary>Returns the boost factor for hits on any field of this document.
 74        /// 
 75        /// <p>The default value is 1.0.
 76        /// 
 77        /// <p>Note: This value is not stored directly with the document in the index.
 78        /// Documents returned from {@link IndexReader#Document(int)} and
 79        /// {@link Hits#Doc(int)} may thus not have the same value present as when
 80        /// this document was indexed.
 81        /// 
 82        /// </summary>
 83        /// <seealso cref="SetBoost(float)">
 84        /// </seealso>
 85        public float GetBoost()
 86        {
 87            return boost;
 88        }
 89        
 90        /**//// <summary> <p>Adds a field to a document.  Several fields may be added with
 91        /// the same name.  In this case, if the fields are indexed, their text is
 92        /// treated as though appended for the purposes of search.</p>
 93        /// <p> Note that add like the removeField(s) methods only makes sense 
 94        /// prior to adding a document to an index. These methods cannot
 95        /// be used to change the content of an existing index! In order to achieve this,
 96        /// a document has to be deleted from an index and a new changed version of that
 97        /// document has to be added.</p>
 98        /// </summary>
 99        public void  Add(Field field)
        {
            fields.Add(field);
        }
        
        /**//// <summary> <p>Removes field with the specified name from the document.
        /// If multiple fields exist with this name, this method removes the first field that has been added.
        /// If there is no field with the specified name, the document remains unchanged.</p>
        /// <p> Note that the removeField(s) methods like the add method only make sense 
        /// prior to adding a document to an index. These methods cannot
        /// be used to change the content of an existing index! In order to achieve this,
        /// a document has to be deleted from an index and a new changed version of that
        /// document has to be added.</p>
        /// </summary>
        public void  RemoveField(System.String name)
        {
            System.Collections.IEnumerator it = fields.GetEnumerator();
            while (it.MoveNext())
            {
                Field field = (Field) it.Current;
                if (field.Name().Equals(name))
                {
                    fields.Remove(field);
                    return ;
                }
            }
        }
        
        /**//// <summary> <p>Removes all fields with the given name from the document.
        /// If there is no field with the specified name, the document remains unchanged.</p>
        /// <p> Note that the removeField(s) methods like the add method only make sense 
        /// prior to adding a document to an index. These methods cannot
        /// be used to change the content of an existing index! In order to achieve this,
        /// a document has to be deleted from an index and a new changed version of that
        /// document has to be added.</p>
        /// </summary>
        public void  RemoveFields(System.String name)
        {
            for (int i = fields.Count - 1; i >= 0; i--)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name))
                {
                    fields.RemoveAt(i);
                }
            }
        }
        
        /**//// <summary>Returns a field with the given name if any exist in this document, or
        /// null.  If multiple fields exists with this name, this method returns the
        /// first value added.
        /// </summary>
        public Field GetField(System.String name)
        {
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name))
                    return field;
            }
            return null;
        }
        
        /**//// <summary>Returns the string value of the field with the given name if any exist in
        /// this document, or null.  If multiple fields exist with this name, this
        /// method returns the first value added. If only binary fields with this name
        /// exist, returns null.
        /// </summary>
        public System.String Get(System.String name)
        {
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name) && (!field.IsBinary()))
                    return field.StringValue();
            }
            return null;
        }
        
        /**//// <summary>Returns an Enumeration of all the fields in a document. </summary>
        public System.Collections.IEnumerable Fields()
        {
            return fields;
        }
        
        /**//// <summary> Returns an array of {@link Field}s with the given name.
        /// This method can return <code>null</code>.
        /// 
        /// </summary>
        /// <param name="name">the name of the field
        /// </param>
        /// <returns> a <code>Field[]</code> array
        /// </returns>
        public Field[] GetFields(System.String name)
        {
            System.Collections.ArrayList result = new System.Collections.ArrayList();
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name))
                {
                    result.Add(field);
                }
            }
            
            if (result.Count == 0)
                return null;
            
            return (Field[]) result.ToArray(typeof(Field));
        }
        
        /**//// <summary> Returns an array of values of the field specified as the method parameter.
        /// This method can return <code>null</code>.
        /// 
        /// </summary>
        /// <param name="name">the name of the field
        /// </param>
        /// <returns> a <code>String[]</code> of field values
        /// </returns>
        public System.String[] GetValues(System.String name)
        {
            System.Collections.ArrayList result = new System.Collections.ArrayList();
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name) && (!field.IsBinary()))
                    result.Add(field.StringValue());
            }
            
            if (result.Count == 0)
                return null;
            
            return (System.String[]) (result.ToArray(typeof(System.String)));
        }
        
        /**//// <summary> Returns an array of byte arrays for of the fields that have the name specified
        /// as the method parameter. This method will return <code>null</code> if no
        /// binary fields with the specified name are available.
        /// 
        /// </summary>
        /// <param name="name">the name of the field
        /// </param>
        /// <returns> a  <code>byte[][]</code> of binary field values.
        /// </returns>
        public byte[][] GetBinaryValues(System.String name)
        {
            System.Collections.IList result = new System.Collections.ArrayList();
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name) && (field.IsBinary()))
                {
                    byte[] byteArray = field.BinaryValue();
                    byte[] resultByteArray = new byte[byteArray.Length];
                    for (int index = 0; index < byteArray.Length; index++)
                        resultByteArray[index] = (byte) byteArray[index];

                    result.Add(resultByteArray);
                }
            }
            
            if (result.Count == 0)
                return null;
            
            System.Collections.ICollection c = result;
            System.Object[] objects = new byte[result.Count][];

            System.Type type = objects.GetType().GetElementType();
            System.Object[] objs = (System.Object[]) Array.CreateInstance(type, c.Count );

            System.Collections.IEnumerator e = c.GetEnumerator();
            int ii = 0;

            while (e.MoveNext())
                objs[ii++] = e.Current;

            // If objects is smaller than c then do not return the new array in the parameter
            if (objects.Length >= c.Count)
                objs.CopyTo(objects, 0);

            return (byte[][]) objs;
        }
        
        /**//// <summary> Returns an array of bytes for the first (or only) field that has the name
        /// specified as the method parameter. This method will return <code>null</code>
        /// if no binary fields with the specified name are available.
        /// There may be non-binary fields with the same name.
        /// 
        /// </summary>
        /// <param name="name">the name of the field.
        /// </param>
        /// <returns> a <code>byte[]</code> containing the binary field value.
        /// </returns>
        public byte[] GetBinaryValue(System.String name)
        {
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                if (field.Name().Equals(name) && (field.IsBinary()))
                    return field.BinaryValue();
            }
            return null;
        }
        
        /**//// <summary>Prints the fields of a document for human consumption. </summary>
        public override System.String ToString()
        {
            System.Text.StringBuilder buffer = new System.Text.StringBuilder();
            buffer.Append("Document<");
            for (int i = 0; i < fields.Count; i++)
            {
                Field field = (Field) fields[i];
                buffer.Append(field.ToString());
                if (i != fields.Count - 1)
                    buffer.Append(" ");
            }
            buffer.Append(">");
            return buffer.ToString();
        }
    }
}