Sort.cs

Go to the documentation of this file.

/* 
 * 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.
 */

using System;
using Lucene.Net.Support;

namespace Lucene.Net.Search
{
    
    
    [Serializable]
    public class Sort
    {
        
        public static readonly Sort RELEVANCE = new Sort();
        
        public static readonly Sort INDEXORDER;
        
        // internal representation of the sort criteria
        internal SortField[] fields;
        
        public Sort():this(SortField.FIELD_SCORE)
        {
        }
        
        public Sort(SortField field)
        {
            SetSort(field);
        }
        
        public Sort(params SortField[] fields)
        {
            SetSort(fields);
        }
        
        public virtual void  SetSort(SortField field)
        {
            this.fields = new SortField[]{field};
        }
        
        public virtual void  SetSort(params SortField[] fields)
        {
            this.fields = fields;
        }
        
        public virtual SortField[] GetSort()
        {
            return fields;
        }
        
        public override System.String ToString()
        {
            System.Text.StringBuilder buffer = new System.Text.StringBuilder();
            
            for (int i = 0; i < fields.Length; i++)
            {
                buffer.Append(fields[i].ToString());
                if ((i + 1) < fields.Length)
                    buffer.Append(',');
            }
            
            return buffer.ToString();
        }
        
        public  override bool Equals(System.Object o)
        {
            if (this == o)
                return true;
            if (!(o is Sort))
                return false;
            Sort other = (Sort) o;

            bool result = false;
            if ((this.fields == null) && (other.fields == null))
                result = true;
            else if ((this.fields != null) && (other.fields != null))
            {
                if (this.fields.Length == other.fields.Length)
                {
                    int length = this.fields.Length;
                    result = true;
                    for (int i = 0; i < length; i++)
                    {
                        if (!(this.fields[i].Equals(other.fields[i])))
                        {
                            result = false;
                            break;
                        }
                    }
                }
            }
            return result;
        }
        
        public override int GetHashCode()
        {
            // TODO in Java 1.5: switch to Arrays.hashCode().  The 
            // Java 1.4 workaround below calculates the same hashCode
            // as Java 1.5's new Arrays.hashCode()
            return 0x45aaf665 + EquatableList<SortField>.GetHashCode(fields);
        }
        static Sort()
        {
            INDEXORDER = new Sort(SortField.FIELD_DOC);
        }
    }
}