org.dspace.browse
Class BrowseEngine

java.lang.Object
  extended by org.dspace.browse.BrowseEngine

public class BrowseEngine
extends Object

This class does most of the actual grunt work of preparing a browse result. It takes in to a couple of available methods (depending on your desired browse type) a BrowserScope object, and uses this to produce a BrowseInfo object which is sufficient to describe to the User Interface the results of the requested browse

Author:
Richard Jones

Constructor Summary
BrowseEngine(Context context)
          Create a new instance of the Browse engine, using the given DSpace Context object.
 
Method Summary
 BrowseInfo browse(BrowserScope bs)
          Perform a standard browse, which will return a BrowseInfo object that represents the results for the current page, the total number of results, the range, and information to construct previous and next links on any web page
 BrowseInfo browseMini(BrowserScope bs)
          Perform a limited browse, which only returns the results requested, without any extraneous information.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BrowseEngine

public BrowseEngine(Context context)
             throws BrowseException
Create a new instance of the Browse engine, using the given DSpace Context object. This will automatically assign a Data Access Object for the Browse Engine, based on the dspace.cfg setting for db.name

Parameters:
context - the DSpace context
Throws:
BrowseException
Method Detail

browse

public BrowseInfo browse(BrowserScope bs)
                  throws BrowseException
Perform a standard browse, which will return a BrowseInfo object that represents the results for the current page, the total number of results, the range, and information to construct previous and next links on any web page

Parameters:
bs - the scope of the browse
Returns:
the results of the browse
Throws:
BrowseException

browseMini

public BrowseInfo browseMini(BrowserScope bs)
                      throws BrowseException
Perform a limited browse, which only returns the results requested, without any extraneous information. To perform a full browse, use BrowseEngine.browse() above. This supports Item browse only, and does not currently support focus or values. This method is used, for example, to generate the Recently Submitted Items results.

Parameters:
bs - the scope of the browse
Returns:
the results of the browse
Throws:
BrowseException


Copyright © 2010 DuraSpace. All Rights Reserved.