| Package | Description |
|---|---|
| org.dspace.browse |
Provides classes and methods for browsing Items in DSpace by whatever
is specified in the configuration.
|
| Modifier and Type | Method and Description |
|---|---|
BrowseInfo |
BrowseEngine.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 |
BrowseEngine.browseMini(BrowserScope bs)
Perform a limited browse, which only returns the results requested,
without any extraneous information.
|
int |
SolrBrowseDAO.doCountQuery() |
int |
BrowseDAO.doCountQuery()
This executes a query which will count the number of results for the
parameters you set.
|
int |
SolrBrowseDAO.doDistinctOffsetQuery(String column,
String value,
boolean isAscending) |
int |
BrowseDAO.doDistinctOffsetQuery(String column,
String value,
boolean isAscending)
This executes a query which returns the offset where the value (or nearest greater
equivalent) can be found in the specified table ordered by the column.
|
String |
SolrBrowseDAO.doMaxQuery(String column,
String table,
int itemID) |
String |
BrowseDAO.doMaxQuery(String column,
String table,
int itemID)
This executes a query which returns the value of the "highest" (max) value
in the given table's column for the given item id.
|
int |
SolrBrowseDAO.doOffsetQuery(String column,
String value,
boolean isAscending) |
int |
BrowseDAO.doOffsetQuery(String column,
String value,
boolean isAscending)
This executes a query which returns the offset where the value (or nearest greater
equivalent) can be found in the specified table ordered by the column.
|
List<Item> |
SolrBrowseDAO.doQuery() |
List<Item> |
BrowseDAO.doQuery()
This executes a query which returns a List object containing BrowseItem objects
representing the results of a full item browse.
|
List |
SolrBrowseDAO.doValueQuery() |
List<String[]> |
BrowseDAO.doValueQuery()
This executes a query which returns a List object containing String
values which represent the results of a single value browse (for
example, the list of all subject headings).
|
static BrowseIndex |
BrowseIndex.getBrowseIndex(SortOption so)
Get the configured browse index that is defined to use this sort option.
|
static BrowseIndex |
BrowseIndex.getBrowseIndex(String name)
Get the browse index from configuration with the specified name.
|
static BrowseIndex[] |
BrowseIndex.getBrowseIndices()
Get an array of all the browse indices for the current configuration
|
static BrowseDAO |
BrowseDAOFactory.getInstance(Context context)
Get an instance of the relevant Read Only DAO class, which will
conform to the BrowseDAO interface
|
String |
BrowseIndex.getSortField(boolean isSecondLevel)
Get the field for sorting associated with this index.
|
SortOption |
BrowserScope.getSortOption()
Obtain the sort option
|
void |
BrowserScope.setBrowseContainer(DSpaceObject dso)
Set the DSpaceObject that is the container for this browse.
|
void |
BrowseInfo.setBrowseContainer(DSpaceObject dso)
Set the DSpaceObject that is the container for this browse.
|
void |
BrowserScope.setBrowseIndex(BrowseIndex browseIndex) |
void |
BrowserScope.setSortBy(int sortBy) |
void |
BrowseOutput.sql(String sql)
Pass in some SQL.
|
static String[] |
BrowseIndex.tables()
Deprecated.
|
| Constructor and Description |
|---|
BrowseEngine(Context context)
Create a new instance of the Browse engine, using the given DSpace
Context object.
|
CrossLinks()
Construct a new object which will obtain the configuration for itself.
|
ItemListConfig()
Create a new instance of the Item list configuration.
|
Copyright © 2022 LYRASIS. All rights reserved.