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

今天看了一下DateTool.cs里面的源码，这个文件里的代码还是比较简单的。DateTool类提供一些日期字符串与日期时间类型之间的互相转换。与DateField类不同是，DateField中的日期字符串是一串36进制的字符串，而这里的日期字符串是我们常见的格式，如"yyyy","yyyymm"等。DateTool类里面还嵌套了一个Resolution类。该类采用多例模式，内置了YEAR,MONTH,DAY,HOUR,MINUTE,SECOND,MILLISECOND 7个实例，用以表示时间的分辨率。当日期时间类型转换成日期字符串时，需要一个Resolution作为参数，例如日期时间为2009年2月24日，Resolution参数为MONTH，转换之后的日期字符串则为"200902"("yyyymm")。下面是我对源码的一些分析。

 

  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;
 19
 20namespace Lucene.Net.Documents
 21{
 22    
 23    /**//// <summary> Provides support for converting dates to strings and vice-versa.
 24    /// The strings are structured so that lexicographic sorting orders 
 25    /// them by date, which makes them suitable for use as field values 
 26    /// and search terms.
 27    /// 
 28    /// <P>This class also helps you to limit the resolution of your dates. Do not
 29    /// save dates with a finer resolution than you really need, as then
 30    /// RangeQuery and PrefixQuery will require more memory and become slower.
 31    /// 
 32    /// <P>Compared to {@link DateField} the strings generated by the methods
 33    /// in this class take slightly more space, unless your selected resolution
 34    /// is set to <code>Resolution.DAY</code> or lower.
 35    /// </summary>
 36    public class DateTools
 37    {
 38
 39        //私有的构造函数，由于该类只是提供一些静态方法，因此无需被实例化
 40        private DateTools()
 41        {
 42        }
 43        
 44        /**//// <summary> Converts a Date to a string suitable for indexing.
 45        /// 将日期时间类型对象转换成日期字符串（yyyy,yyyymm,yyyymmdd.）
 46        /// </summary>
 47        /// <param name="date">the date to be converted
 48        /// </param>
 49        /// <param name="resolution">the desired resolution, see
 50        /// {@link #Round(Date, DateTools.Resolution)}
 51        /// </param>
 52        /// <returns> a string in format <code>yyyyMMddHHmmssSSS</code> or shorter,
 53        /// depeding on <code>resolution</code>
 54        /// </returns>
 55        public static System.String DateToString(System.DateTime date, Resolution resolution)
 56        {
 57            return TimeToString(date.Ticks, resolution);
 58        }
 59        
 60        /**//// <summary> Converts a millisecond time to a string suitable for indexing.
 61        /// 将长整型日期time转换成日期字符串，通过DateTime对象的Ticks可以得到这样的time值，Ticks的单位是100纳秒，而这里的英文注释说是毫秒，应该是错误的
 62        /// </summary>
 63        /// <param name="time">the date expressed as milliseconds since January 1, 1970, 00:00:00 GMT
 64        /// 看不出这里的代码与1970年1月1日有什么关联，可能是受DateField能表示的最小时间影响吧
 65        /// </param>
 66        /// <param name="resolution">the desired resolution, see
 67        /// {@link #Round(long, DateTools.Resolution)}
 68        /// </param>
 69        /// <returns> a string in format <code>yyyyMMddHHmmssSSS</code> or shorter,
 70        /// depeding on <code>resolution</code>; using UTC as timezone
 71        /// </returns>
 72        public static System.String TimeToString(long time, Resolution resolution)
 73        {
 74            // cal这个对象似乎在这里是没有用处的
 75            System.Globalization.Calendar cal = new System.Globalization.GregorianCalendar(); // {{Aroush}} do we care about 'cal'
 76            
 77            //protected in JDK's prior to 1.4
 78            // 下面的setTimeInMillis在.net找不着，应该是java里面的
 79            //cal.setTimeInMillis(round(time, resolution));
 80            
 81            // 调用Round方法对time进行舍入操作，不过这个舍入操作在这里似乎是多余的，调用ToString函数应该可以完成转换了，不明白为什么要在这里进行舍入操作
 82            System.DateTime dt = new System.DateTime(Round(time, resolution));
 83
 84            System.String t = "";
 85
 86            // 根据不同分辨率转换成不同的日期字符串
 87            if (resolution == Resolution.YEAR)
 88            {
 89                t = dt.ToString("yyyy");
 90            }
 91            else if (resolution == Resolution.MONTH)
 92            {
 93                t = dt.ToString("yyyyMM");
 94            }
 95            else if (resolution == Resolution.DAY)
 96            {
 97                t = dt.ToString("yyyyMMdd");
 98            }
 99            else if (resolution == Resolution.HOUR)
            {
                t = dt.ToString("yyyyMMddHH");
            }
            else if (resolution == Resolution.MINUTE)
            {
                t = dt.ToString("yyyyMMddHHmm");
            }
            else if (resolution == Resolution.SECOND)
            {
                t = dt.ToString("yyyyMMddHHmmss");
            }
            else if (resolution == Resolution.MILLISECOND)
            {
                t = dt.ToString("yyyyMMddHHmmssfff");
            }
            else
            {
                throw new System.ArgumentException("unknown resolution " + resolution);
            }

            return t;
        }
        
        /**//// <summary> Converts a string produced by <code>timeToString</code> or
        /// <code>DateToString</code> back to a time, represented as the
        /// number of milliseconds since January 1, 1970, 00:00:00 GMT.
        /// 将日期字符串转换成对应时间的长整型值
        /// </summary>
        /// <param name="dateString">the date string to be converted
        /// </param>
        /// <returns> the number of milliseconds since January 1, 1970, 00:00:00 GMT
        /// </returns>
        /// <throws>  ParseException if <code>dateString</code> is not in the  </throws>
        /// <summary>  expected format 
        /// </summary>
        public static long StringToTime(System.String dateString)
        {
            return StringToDate(dateString).Ticks;
        }
        
        /**//// <summary> Converts a string produced by <code>timeToString</code> or
        /// <code>DateToString</code> back to a time, represented as a
        /// Date object.
        /// 将日期字符串转换成对应的日期时间类型
        /// </summary>
        /// <param name="dateString">the date string to be converted
        /// </param>
        /// <returns> the parsed time as a Date object 
        /// </returns>
        /// <throws>  ParseException if <code>dateString</code> is not in the  </throws>
        /// <summary>  expected format 
        /// </summary>
        public static System.DateTime StringToDate(System.String dateString)
        {
            System.String yyyy = "1";
            System.String MM = "1";
            System.String dd = "1";
            System.String HH = "0";
            System.String mm = "0";
            System.String ss = "0";
            System.String SSS = "0";

            if (dateString.Length == 4)     // "yyyy"
            {
                yyyy = dateString.Substring(0, 4);
            }
            else if (dateString.Length == 6)     // "yyyyMM";
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
            }
            else if (dateString.Length == 8)     // "yyyyMMdd"
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
                dd = dateString.Substring(6, 2);
            }
            else if (dateString.Length == 10)    // "yyyyMMddHH"
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
                dd = dateString.Substring(6, 2);
                HH = dateString.Substring(8, 2);
            }
            else if (dateString.Length == 12)    // "yyyyMMddHHmm";
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
                dd = dateString.Substring(6, 2);
                HH = dateString.Substring(8, 2);
                mm = dateString.Substring(10, 2);
            }
            else if (dateString.Length == 14)    // "yyyyMMddHHmmss";
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
                dd = dateString.Substring(6, 2);
                HH = dateString.Substring(8, 2);
                mm = dateString.Substring(10, 2);
                ss = dateString.Substring(12, 2);
            }
            else if (dateString.Length == 17)    // "yyyyMMddHHmmssSSS";
            {
                yyyy = dateString.Substring(0, 4);
                MM = dateString.Substring(4, 2);
                dd = dateString.Substring(6, 2);
                HH = dateString.Substring(8, 2);
                mm = dateString.Substring(10, 2);
                ss = dateString.Substring(12, 2);
                SSS = dateString.Substring(14, 3);
            }
            else
            {
                throw new System.FormatException("Input is not valid date string: " + dateString);
            }

            int y, M, d, H, m, s, S;
            y = Convert.ToInt16(yyyy);
            M = Convert.ToInt16(MM);
            d = Convert.ToInt16(dd);
            H = Convert.ToInt16(HH);
            m = Convert.ToInt16(mm);
            s = Convert.ToInt16(ss);
            S = Convert.ToInt16(SSS);

            return new System.DateTime(y, 
                M, d, H, 
                m, s, S);

            // 没用的代码为什么不删掉
            //return new System.DateTime(Convert.ToInt16(yyyy), 
            //    Convert.ToInt16(MM), Convert.ToInt16(dd), Convert.ToInt16(HH), 
            //    Convert.ToInt16(mm), Convert.ToInt16(ss), Convert.ToInt16(SSS));
        }
        
        /**//// <summary> Limit a date's resolution. For example, the date <code>2004-09-21 13:50:11</code>
        /// will be changed to <code>2004-09-01 00:00:00</code> when using
        /// <code>Resolution.MONTH</code>. 
        /// 根据Resolution参数对日期时间类型进行舍入操作，例如2009年2月24日8点30分30秒，若Resolution为Month，则舍入的结果为2009年2月1日0点0分0秒
        /// </summary>
        /// <param name="resolution">The desired resolution of the date to be returned
        /// </param>
        /// <returns> the date with all values more precise than <code>resolution</code>
        /// set to 0 or 1
        /// </returns>
        public static System.DateTime Round(System.DateTime date, Resolution resolution)
        {
            return new System.DateTime(Round(date.Ticks, resolution));
        }
        
        /**//// <summary> Limit a date's resolution. For example, the date <code>1095767411000</code>
        /// (which represents 2004-09-21 13:50:11) will be changed to 
        /// <code>1093989600000</code> (2004-09-01 00:00:00) when using
        /// <code>Resolution.MONTH</code>.
        /// 根据Resolution参数对日期时间类型进行舍入操作
        /// </summary>
        /// <param name="resolution">The desired resolution of the date to be returned
        /// </param>
        /// <returns> the date with all values more precise than <code>resolution</code>
        /// set to 0 or 1, expressed as milliseconds since January 1, 1970, 00:00:00 GMT
        /// </returns>
        public static long Round(long time, Resolution resolution)
        {
            System.Globalization.Calendar cal = new System.Globalization.GregorianCalendar(); // {{Aroush}} do we care about 'cal'
            
            // protected in JDK's prior to 1.4
            //cal.setTimeInMillis(time);
            
            System.DateTime dt = new System.DateTime(time);
            
            //根据不同分辨率，减去相应的时间偏移量
            if (resolution == Resolution.YEAR)
            {
                dt = dt.AddMonths(1 - dt.Month);
                dt = dt.AddDays(1 - dt.Day);
                dt = dt.AddHours(0 - dt.Hour);
                dt = dt.AddMinutes(0 - dt.Minute);
                dt = dt.AddSeconds(0 - dt.Second);
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.MONTH)
            {
                dt = dt.AddDays(1 - dt.Day);
                dt = dt.AddHours(0 - dt.Hour);
                dt = dt.AddMinutes(0 - dt.Minute);
                dt = dt.AddSeconds(0 - dt.Second);
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.DAY)
            {
                dt = dt.AddHours(0 - dt.Hour);
                dt = dt.AddMinutes(0 - dt.Minute);
                dt = dt.AddSeconds(0 - dt.Second);
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.HOUR)
            {
                dt = dt.AddMinutes(0 - dt.Minute);
                dt = dt.AddSeconds(0 - dt.Second);
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.MINUTE)
            {
                dt = dt.AddSeconds(0 - dt.Second);
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.SECOND)
            {
                dt = dt.AddMilliseconds(0 - dt.Millisecond);
            }
            else if (resolution == Resolution.MILLISECOND)
            {
                // don't cut off anything
            }
            else
            {
                throw new System.ArgumentException("unknown resolution " + resolution);
            }
            return dt.Ticks;
        }
        
        /**//// <summary>Specifies the time granularity. 
        /// 采用多例模式，内置了YEAR,MONTH,DAY,HOUR,MINUTE,SECOND,MILLISECOND 7个实例
        /// </summary>
        public class Resolution
        {
            public static readonly Resolution YEAR = new Resolution("year");
            public static readonly Resolution MONTH = new Resolution("month");
            public static readonly Resolution DAY = new Resolution("day");
            public static readonly Resolution HOUR = new Resolution("hour");
            public static readonly Resolution MINUTE = new Resolution("minute");
            public static readonly Resolution SECOND = new Resolution("second");
            public static readonly Resolution MILLISECOND = new Resolution("millisecond");
            
            private System.String resolution;
            
            internal Resolution()
            {
            }
            
            internal Resolution(System.String resolution)
            {
                this.resolution = resolution;
            }
            
            public override System.String ToString()
            {
                return resolution;
            }
        }
    }
}