Package org.dspace.browse

Provides classes and mehtods for browsing Items in DSpace by whatever is specified in the configuration.

See:
          Description

Interface Summary
BrowseCreateDAO Interface for any class wishing to provide a browse storage later.
BrowseDAO Interface for any class wishing to interact with the Browse storage layer for Read Only operations.
BrowseDAOUtils Utility class for retrieving the size of the columns to be used in the browse tables, and applying truncation to the strings that will be inserted into the tables.
BrowseItemDAO  
ItemCountDAO Interface for data access of cached community and collection item count information
 

Class Summary
BrowseConsumer Class for updating browse system from content events.
BrowseCreateDAOOracle This class implements the BrowseCreateDAO interface for the Oracle database as associated with the default DSpace installation.
BrowseCreateDAOPostgres This class implements the BrowseCreateDAO interface for the PostgreSQL database as associated with the default DSpace installation.
BrowseDAOFactory Factory class to generate DAOs based on the configuration
BrowseDAOOracle This class is the Oracle driver class for reading information from the Browse tables.
BrowseDAOPostgres This class is the PostgreSQL driver class for reading information from the Browse tables.
BrowseDAOUtilsDefault Utility class for retrieving the size of the columns to be used in the browse tables, and applying truncation to the strings that will be inserted into the tables.
BrowseDAOUtilsOracle Utility class for retrieving the size of the columns to be used in the browse tables, and applying truncation to the strings that will be inserted into the tables.
BrowseDAOUtilsPostgres Utility class for retrieving the size of the columns to be used in the browse tables, and applying truncation to the strings that will be inserted into the tables.
BrowseEngine This class does most of the actual grunt work of preparing a browse result.
BrowseIndex This class holds all the information about a specifically configured BrowseIndex.
BrowseInfo The results of a Browse, including all the contextual information about the query, as well as the results and associated information to create pagable navigation.
BrowseItem Entity class to represent an item that is being used to generate Browse results.
BrowseItemDAOOracle  
BrowseItemDAOPostgres  
BrowseOutput Utility class to provide a wrapper for the various output possibilities from the IndexBrowse class.
BrowserScope A class which represents the initial request to the browse system.
CrossLinks Class to represent the configuration of the cross-linking between browse pages (for example, between the author name in one full listing to the author's list of publications).
IndexBrowse Tool to create Browse indexes.
ItemCountDAOFactory Factory class to allow us to load the correct DAO for registering item count information
ItemCountDAOOracle Oracle driver implementing ItemCountDAO interface to cache item count information in communities and collections
ItemCountDAOPostgres Postgres driver implementing ItemCountDAO interface to cache item count information in communities and collections
ItemCounter This class provides a standard interface to all item counting operations for communities and collections.
ItemListConfig Class to mediate with the item list configuration
LocaleOrderingFilter Makes a sort string that is Locale dependent.
 

Exception Summary
BrowseException Just a quick BrowseException class to give us the relevant data type
ItemCountException Exception type to handle item count specific problems
 

Package org.dspace.browse Description

Provides classes and mehtods for browsing Items in DSpace by whatever is specified in the configuration. The standard method by which you would perform a browse is as follows:

Browses only return archived Items; other Items (eg, those in the workflow system) are ignored.

Using the Browse API

An example use of the Browse API is shown below:

    // Create or obtain a context object
    Context context = new Context();

    // Create a BrowseScope object within the context
    BrowserScope scope = new BrowserScope(context);
    
    // The browse is limited to the test collection
    Collection test = Collection.find(context, someID);
    scope.setBrowseContainer(test);
    
    // Set the focus
    scope.setFocus("Test Title");
    
    // A maximum of 30 items will be returned
    scope.setResultsPerPage(30);
    
    // set ordering to DESC
    scope.setOrder("DESC");

        // now execute the browse
        BrowseEngine be = new BrowseEngine();
    BrowseInfo results = be.browse(scope);

In this case, the results might be Items with titles like:

Tehran, City of the Ages
Ten Little Indians
Tenchi Universe
Tension
Tennessee Williams
Test Title              (the focus)
Thematic Alignment
Thesis and Antithesis
...

Browse Indexes

The Browse API uses database tables to index Items based on the supplied configuration. When an Item is added to DSpace, modified or removed via the Content Management API, the indexes are automatically updated.

To rebuild the database tables for the browse (on configuration change), or to re-index just the contents of the existing tables, use the following commands from IndexBrowse:

A complete rebuild of the database and the indices:

[dspace]/dsrun org.dspace.browse.IndexBrowse -f -r

A complete re-index of the archive contents:

[dspace]/dsrun org.dspace.browse.IndexBrowse -i



Copyright © 2010 DuraSpace. All Rights Reserved.