org.dspace.browse.package.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation

DSpace core data model and service APIs.

There is a newer version: 8.0









Provides classes and methods 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:



	Create a BrowserScope object.
	This object holds all of the parameters of your browse request
	Pass the BrowserScope object
	into the BrowseEngine object. This
	object should be invoked through either the browse() method or the
	browseMini() method
	The BrowseEngine will pass
	back a BrowseInfo object which contains
	all the relevant details of your request



Browses only return archived Items; other Items (e.g. 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