001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 String[] getQueryTerms();
033    
034            public float[] getScores();
035    
036            public float getSearchTime();
037    
038            public String[] getSnippets();
039    
040            public long getStart();
041    
042            public float score(int n);
043    
044            public void setDocs(Document[] docs);
045    
046            public void setLength(int length);
047    
048            public void setQueryTerms(String[] queryTerms);
049    
050            public void setScores(float[] scores);
051    
052            public void setScores(Float[] scores);
053    
054            public void setSearchTime(float time);
055    
056            public void setSnippets(String[] snippets);
057    
058            public void setStart(long start);
059    
060            public String snippet(int n);
061    
062            public List<Document> toList();
063    
064    }