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 */
019package org.apache.wiki.search;
020
021import org.apache.wiki.api.search.SearchResult;
022
023import java.io.Serializable;
024import java.util.Comparator;
025
026
027/**
028 *  Simple class that decides which search results are more important than others.
029 */
030public class SearchResultComparator implements Comparator< SearchResult >, Serializable {
031    
032    private static final long serialVersionUID = 1L;
033
034    /**
035     *  Compares two SearchResult objects, returning the one that scored higher.
036     *  
037     *  {@inheritDoc}
038     */
039    public int compare( final SearchResult s1, final SearchResult s2 ) {
040        // Bigger scores are first.
041        int res = s2.getScore() - s1.getScore();
042        if( res == 0 ) {
043            res = s1.getPage().getName().compareTo( s2.getPage().getName() );
044        }
045
046        return res;
047    }
048
049}