001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search;
016    
017    import java.io.Serializable;
018    
019    import java.util.List;
020    
021    /**
022     * @author Brian Wing Shun Chan
023     */
024    public interface Hits extends Serializable {
025    
026            public Document doc(int n);
027    
028            public Document[] getDocs();
029    
030            public int getLength();
031    
032            public Query getQuery();
033    
034            public String[] getQueryTerms();
035    
036            public float[] getScores();
037    
038            public float getSearchTime();
039    
040            public String[] getSnippets();
041    
042            public long getStart();
043    
044            public float score(int n);
045    
046            public void setDocs(Document[] docs);
047    
048            public void setLength(int length);
049    
050            public void setQuery(Query query);
051    
052            public void setQueryTerms(String[] queryTerms);
053    
054            public void setScores(float[] scores);
055    
056            public void setScores(Float[] scores);
057    
058            public void setSearchTime(float time);
059    
060            public void setSnippets(String[] snippets);
061    
062            public void setStart(long start);
063    
064            public String snippet(int n);
065    
066            public List<Document> toList();
067    
068    }