001    /*
002        Licensed to the Apache Software Foundation (ASF) under one
003        or more contributor license agreements.  See the NOTICE file
004        distributed with this work for additional information
005        regarding copyright ownership.  The ASF licenses this file
006        to you under the Apache License, Version 2.0 (the
007        "License"); you may not use this file except in compliance
008        with the License.  You may obtain a copy of the License at
009    
010           http://www.apache.org/licenses/LICENSE-2.0
011    
012        Unless required by applicable law or agreed to in writing,
013        software distributed under the License is distributed on an
014        "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015        KIND, either express or implied.  See the License for the
016        specific language governing permissions and limitations
017        under the License.     
018     */
019    package org.apache.wiki.search;
020    
021    import java.io.Serializable;
022    import java.util.Comparator;
023    
024    
025    /**
026     *  Simple class that decides which search results are more important than others.
027     */
028    public class SearchResultComparator implements Comparator< SearchResult >, Serializable {
029        
030        private static final long serialVersionUID = 1L;
031    
032        /**
033         *  Compares two SearchResult objects, returning
034         *  the one that scored higher.
035         *  
036         *  {@inheritDoc}
037         */
038        public int compare( SearchResult s1, SearchResult s2 ) {
039            // Bigger scores are first.
040    
041            int res = s2.getScore() - s1.getScore();
042    
043            if( res == 0 ) {
044                res = s1.getPage().getName().compareTo( s2.getPage().getName() );
045            }
046    
047            return res;
048        }
049    
050    }