CmsSearchResultList


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/search/CmsSearchResultList.java,v $
3    * Date   : $Date: 2005/07/03 09:41:51 $
4    * Version: $Revision: 1.6 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.search;
33  
34  import java.util.ArrayList  ;
35  import java.util.Map  ;
36  
37  /**
38   * A search result object returned as result of a search in
39   * <code>{@link org.opencms.search.CmsSearchIndex}</code>.<p>
40   * 
41   * @author Alexander Kandzior 
42   * 
43   * @version $Revision: 1.6 $ 
44   * 
45   * @since 6.0.0 
46   */
47  public class CmsSearchResultList extends ArrayList   {
48  
49      /** Serial version UID required for safe serialization. */
50      private static final long serialVersionUID = 606716301025993114L;
51  
52      /** The (otional) categories found in the last the search. */
53      private Map   m_categories;
54  
55      /** The total size of all results found in the last search. */
56      private int m_hitCount;
57  
58      /**
59       * Creates a new result list with a default initial capacity of 100.<p>
60       */
61      public CmsSearchResultList() {
62  
63          this(100);
64      }
65  
66      /**
67       * Creates a new result list with the specified initial capacity.<p>
68       * 
69       * @param initialCapacity the initial capacity
70       */
71      public CmsSearchResultList(int initialCapacity) {
72  
73          super(initialCapacity);
74      }
75  
76      /**
77       * Returns the (otional) categories found in the last the search, or <code>null</code> 
78       * if the category list was not requested in the search.<p>
79       *
80       * @return the (otional) categories found in the last the search
81       * 
82       * @see CmsSearch#getCalculateCategories()
83       */
84      public Map   getCategories() {
85  
86          return m_categories;
87      }
88  
89      /**
90       * Returns the hit count of all results found in the last search.<p>
91       * 
92       * Since this list will only contain the result objects for the current display page,
93       * the size of the list is usually much less then the hit count of all results found.<p>
94       * 
95       * @return the hit count of all results found in the last search
96       */
97      public int getHitCount() {
98  
99          return m_hitCount;
100     }
101 
102     /**
103      * Sets the categories found in the last the search.<p>
104      *
105      * @param categories the categories to set
106      * 
107      * @see CmsSearch#setCalculateCategories(boolean)
108      */
109     public void setCategories(Map   categories) {
110 
111         m_categories = categories;
112     }
113 
114     /**
115      * Sets the hit count of all results found in the last search.<p>
116      *
117      * Since this list will only contain the result objects for the current display page,
118      * the size of the list is usually much less then the hit count of all results found.<p>
119      *
120      *  @param hitCount the hit count to set
121      */
122     public void setHitCount(int hitCount) {
123 
124         m_hitCount = hitCount;
125     }
126 }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags