| 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.
|
void |
IndexBrowse.clearDatabase()
delete all the existing browse tables
|
java.lang.String |
SolrBrowseCreateDAO.createCollectionView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createCollectionView(java.lang.String table,
java.lang.String view,
boolean execute)
Create the View of the full item index as seen from a collection.
|
java.lang.String |
BrowseCreateDAOPostgres.createCollectionView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createCollectionView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.createCommunityView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createCommunityView(java.lang.String table,
java.lang.String view,
boolean execute)
Create the View of the full item index as seen from a community
If the boolean execute is true this operation should be carried out, and if it is false
it should not.
|
java.lang.String |
BrowseCreateDAOPostgres.createCommunityView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createCommunityView(java.lang.String table,
java.lang.String view,
boolean execute) |
java.lang.String[] |
SolrBrowseCreateDAO.createDatabaseIndices(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean value,
boolean execute) |
java.lang.String[] |
BrowseCreateDAO.createDatabaseIndices(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean value,
boolean execute)
Create any indices that the implementing DAO sees fit to maximise performance.
|
java.lang.String[] |
BrowseCreateDAOPostgres.createDatabaseIndices(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean value,
boolean execute) |
java.lang.String[] |
BrowseCreateDAOOracle.createDatabaseIndices(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean value,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.createDistinctMap(java.lang.String table,
java.lang.String map,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createDistinctMap(java.lang.String table,
java.lang.String map,
boolean execute)
Create a table to hold a mapping between an item and a distinct metadata value that can appear
across multiple items (for example, author names).
|
java.lang.String |
BrowseCreateDAOPostgres.createDistinctMap(java.lang.String table,
java.lang.String map,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createDistinctMap(java.lang.String table,
java.lang.String map,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.createDistinctTable(java.lang.String table,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createDistinctTable(java.lang.String table,
boolean execute)
Create the table which will hold the distinct metadata values that appear in multiple
items.
|
java.lang.String |
BrowseCreateDAOPostgres.createDistinctTable(java.lang.String table,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createDistinctTable(java.lang.String table,
boolean execute) |
java.lang.String[] |
SolrBrowseCreateDAO.createMapIndices(java.lang.String disTable,
java.lang.String mapTable,
boolean execute) |
java.lang.String[] |
BrowseCreateDAO.createMapIndices(java.lang.String disTable,
java.lang.String mapTable,
boolean execute)
Create any indices that the implementing DAO sees fit to maximise performance.
|
java.lang.String[] |
BrowseCreateDAOPostgres.createMapIndices(java.lang.String disTable,
java.lang.String mapTable,
boolean execute) |
java.lang.String[] |
BrowseCreateDAOOracle.createMapIndices(java.lang.String disTable,
java.lang.String mapTable,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createPrimaryTable(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean execute)
Create the main index table.
|
java.lang.String |
BrowseCreateDAOPostgres.createPrimaryTable(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createPrimaryTable(java.lang.String table,
java.util.List<java.lang.Integer> sortCols,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.createPrimaryTable(java.lang.String table,
java.util.List sortCols,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.createSequence(java.lang.String sequence,
boolean execute) |
java.lang.String |
BrowseCreateDAO.createSequence(java.lang.String sequence,
boolean execute)
Create the sequence with the given name.
|
java.lang.String |
BrowseCreateDAOPostgres.createSequence(java.lang.String sequence,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.createSequence(java.lang.String sequence,
boolean execute) |
void |
SolrBrowseCreateDAO.deleteByItemID(java.lang.String table,
int itemID) |
void |
BrowseCreateDAO.deleteByItemID(java.lang.String table,
int itemID)
Delete the record for the given item id from the specified table.
|
void |
BrowseCreateDAOPostgres.deleteByItemID(java.lang.String table,
int itemID) |
void |
BrowseCreateDAOOracle.deleteByItemID(java.lang.String table,
int itemID) |
void |
SolrBrowseCreateDAO.deleteCommunityMappings(int itemID) |
void |
BrowseCreateDAO.deleteCommunityMappings(int itemID) |
void |
BrowseCreateDAOPostgres.deleteCommunityMappings(int itemID) |
void |
BrowseCreateDAOOracle.deleteCommunityMappings(int itemID) |
java.util.List<java.lang.Integer> |
SolrBrowseCreateDAO.deleteMappingsByItemID(java.lang.String mapTable,
int itemID) |
java.util.List<java.lang.Integer> |
BrowseCreateDAO.deleteMappingsByItemID(java.lang.String mapTable,
int itemID) |
java.util.List<java.lang.Integer> |
BrowseCreateDAOPostgres.deleteMappingsByItemID(java.lang.String mapTable,
int itemID) |
java.util.List<java.lang.Integer> |
BrowseCreateDAOOracle.deleteMappingsByItemID(java.lang.String mapTable,
int itemID) |
int |
BrowseDAOOracle.doCountQuery() |
int |
BrowseDAO.doCountQuery()
This executes a query which will count the number of results for the
parameters you set.
|
int |
SolrBrowseDAO.doCountQuery() |
int |
BrowseDAOPostgres.doCountQuery() |
int |
BrowseDAOOracle.doDistinctOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
int |
BrowseDAO.doDistinctOffsetQuery(java.lang.String column,
java.lang.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.
|
int |
SolrBrowseDAO.doDistinctOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
int |
BrowseDAOPostgres.doDistinctOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
java.lang.String |
BrowseDAOOracle.doMaxQuery(java.lang.String column,
java.lang.String table,
int itemID) |
java.lang.String |
BrowseDAO.doMaxQuery(java.lang.String column,
java.lang.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.
|
java.lang.String |
SolrBrowseDAO.doMaxQuery(java.lang.String column,
java.lang.String table,
int itemID) |
java.lang.String |
BrowseDAOPostgres.doMaxQuery(java.lang.String column,
java.lang.String table,
int itemID) |
int |
BrowseDAOOracle.doOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
int |
BrowseDAO.doOffsetQuery(java.lang.String column,
java.lang.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.
|
int |
SolrBrowseDAO.doOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
int |
BrowseDAOPostgres.doOffsetQuery(java.lang.String column,
java.lang.String value,
boolean isAscending) |
java.util.List<BrowseItem> |
BrowseDAOOracle.doQuery() |
java.util.List<BrowseItem> |
BrowseDAO.doQuery()
This executes a query which returns a List object containing BrowseItem objects
representing the results of a full item browse.
|
java.util.List |
SolrBrowseDAO.doQuery() |
java.util.List<BrowseItem> |
BrowseDAOPostgres.doQuery() |
java.util.List<java.lang.String[]> |
BrowseDAOOracle.doValueQuery() |
java.util.List<java.lang.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).
|
java.util.List |
SolrBrowseDAO.doValueQuery() |
java.util.List<java.lang.String[]> |
BrowseDAOPostgres.doValueQuery() |
java.lang.String |
SolrBrowseCreateDAO.dropIndexAndRelated(java.lang.String table,
boolean execute) |
java.lang.String |
BrowseCreateDAO.dropIndexAndRelated(java.lang.String table,
boolean execute)
Drop the given table name, and all other resources that are attached to it.
|
java.lang.String |
BrowseCreateDAOPostgres.dropIndexAndRelated(java.lang.String table,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.dropIndexAndRelated(java.lang.String table,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.dropSequence(java.lang.String sequence,
boolean execute) |
java.lang.String |
BrowseCreateDAO.dropSequence(java.lang.String sequence,
boolean execute)
Drop the given sequence name.
|
java.lang.String |
BrowseCreateDAOPostgres.dropSequence(java.lang.String sequence,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.dropSequence(java.lang.String sequence,
boolean execute) |
java.lang.String |
SolrBrowseCreateDAO.dropView(java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAO.dropView(java.lang.String view,
boolean execute)
Drop the given view name.
|
java.lang.String |
BrowseCreateDAOPostgres.dropView(java.lang.String view,
boolean execute) |
java.lang.String |
BrowseCreateDAOOracle.dropView(java.lang.String view,
boolean execute) |
static BrowseIndex |
BrowseIndex.getBrowseIndex(SortOption so)
Get the configured browse index that is defined to use this sort option.
|
static BrowseIndex |
BrowseIndex.getBrowseIndex(java.lang.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 BrowseCreateDAO |
BrowseDAOFactory.getCreateInstance(Context context)
Get an instance of the relevant Write Only DAO class, which will
conform to the BrowseCreateDAO interface
|
int |
SolrBrowseCreateDAO.getDistinctID(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
int |
BrowseCreateDAO.getDistinctID(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue)
Get the browse index's internal id for the location of the given string
and sort value in the given table.
|
int |
BrowseCreateDAOPostgres.getDistinctID(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
int |
BrowseCreateDAOOracle.getDistinctID(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
static BrowseDAO |
BrowseDAOFactory.getInstance(Context context)
Get an instance of the relevant Read Only DAO class, which will
conform to the BrowseDAO interface
|
static BrowseItemDAO |
BrowseDAOFactory.getItemInstance(Context context)
Get an instance of the relevant Read Only DAO class, which will
conform to the BrowseItemDAO interface
|
Item[] |
BrowseInfo.getItemResults(Context context)
Return the results of the Browse as an Item array.
|
java.lang.String |
BrowseIndex.getSortField(boolean isSecondLevel)
Get the field for sorting associated with this index.
|
SortOption |
BrowserScope.getSortOption()
Obtain the sort option
|
static BrowseDAOUtils |
BrowseDAOFactory.getUtils(Context context)
Get an instance of the relevant DAO Utilities class, which will
conform to the BrowseDAOUtils interface
|
void |
IndexBrowse.indexItem(Item item)
Index the given item
|
void |
IndexBrowse.initBrowse()
index everything
|
int |
SolrBrowseCreateDAO.insertDistinctRecord(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
int |
BrowseCreateDAO.insertDistinctRecord(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue)
Insert the given value and sort value into the distinct index table.
|
int |
BrowseCreateDAOPostgres.insertDistinctRecord(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
int |
BrowseCreateDAOOracle.insertDistinctRecord(java.lang.String table,
java.lang.String value,
java.lang.String authority,
java.lang.String sortValue) |
void |
SolrBrowseCreateDAO.insertIndex(java.lang.String table,
int itemID,
java.util.Map sortCols) |
void |
BrowseCreateDAO.insertIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols)
Insert an index record into the given table for the given item id.
|
void |
BrowseCreateDAOPostgres.insertIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols) |
void |
BrowseCreateDAOOracle.insertIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols) |
boolean |
IndexBrowse.itemRemoved(int itemID) |
boolean |
IndexBrowse.itemRemoved(Item item)
remove all the indices for the given item
|
static void |
IndexBrowse.main(java.lang.String[] argv)
Creates Browse indexes, destroying the old ones.
|
void |
SolrBrowseCreateDAO.pruneDistinct(java.lang.String table,
java.lang.String map,
java.util.List<java.lang.Integer> distinctIds) |
void |
BrowseCreateDAO.pruneDistinct(java.lang.String table,
java.lang.String map,
java.util.List<java.lang.Integer> distinctIds)
So that there are no distinct values indexed which are no longer referenced from the
map table, this method checks for values which are not referenced from the map,
and removes them.
|
void |
BrowseCreateDAOPostgres.pruneDistinct(java.lang.String table,
java.lang.String map,
java.util.List<java.lang.Integer> distinctIds) |
void |
BrowseCreateDAOOracle.pruneDistinct(java.lang.String table,
java.lang.String map,
java.util.List<java.lang.Integer> distinctIds) |
void |
SolrBrowseCreateDAO.pruneExcess(java.lang.String table,
boolean withdrawn) |
void |
BrowseCreateDAO.pruneExcess(java.lang.String table,
boolean withdrawn)
So that any left over indices for items which have been deleted can be assured to have
been removed, this method checks for indices for items which are not in the item table.
|
void |
BrowseCreateDAOPostgres.pruneExcess(java.lang.String table,
boolean withdrawn) |
void |
BrowseCreateDAOOracle.pruneExcess(java.lang.String table,
boolean withdrawn) |
void |
SolrBrowseCreateDAO.pruneMapExcess(java.lang.String map,
boolean withdrawn,
java.util.List<java.lang.Integer> distinctIds) |
void |
BrowseCreateDAO.pruneMapExcess(java.lang.String map,
boolean withdrawn,
java.util.List<java.lang.Integer> distinctIds)
So that any left over indices for items which have been deleted can be assured to have
been removed, this method checks for indices for items which are not in the item table.
|
void |
BrowseCreateDAOPostgres.pruneMapExcess(java.lang.String map,
boolean withdrawn,
java.util.List<java.lang.Integer> distinctIds) |
void |
BrowseCreateDAOOracle.pruneMapExcess(java.lang.String map,
boolean withdrawn,
java.util.List<java.lang.Integer> distinctIds) |
void |
BrowseInfo.setBrowseContainer(DSpaceObject dso)
Set the DSpaceObject that is the container for this browse.
|
void |
BrowserScope.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(java.lang.String sql)
Pass in some SQL.
|
static java.lang.String[] |
BrowseIndex.tables()
Deprecated.
|
boolean |
SolrBrowseCreateDAO.testTableExistence(java.lang.String table) |
boolean |
BrowseCreateDAO.testTableExistence(java.lang.String table)
Find out of a given table exists.
|
boolean |
BrowseCreateDAOPostgres.testTableExistence(java.lang.String table) |
boolean |
BrowseCreateDAOOracle.testTableExistence(java.lang.String table) |
void |
SolrBrowseCreateDAO.updateCommunityMappings(int itemID) |
void |
BrowseCreateDAO.updateCommunityMappings(int itemID) |
void |
BrowseCreateDAOPostgres.updateCommunityMappings(int itemID) |
void |
BrowseCreateDAOOracle.updateCommunityMappings(int itemID) |
org.dspace.browse.MappingResults |
SolrBrowseCreateDAO.updateDistinctMappings(java.lang.String table,
int itemID,
java.util.Set<java.lang.Integer> distinctIDs) |
org.dspace.browse.MappingResults |
BrowseCreateDAO.updateDistinctMappings(java.lang.String table,
int itemID,
java.util.Set<java.lang.Integer> distinctIDs)
Update a mapping between an item id and a distinct metadata field such as an author,
who can appear in multiple items.
|
org.dspace.browse.MappingResults |
BrowseCreateDAOPostgres.updateDistinctMappings(java.lang.String table,
int itemID,
java.util.Set<java.lang.Integer> distinctIDs) |
org.dspace.browse.MappingResults |
BrowseCreateDAOOracle.updateDistinctMappings(java.lang.String table,
int itemID,
java.util.Set<java.lang.Integer> distinctIDs) |
boolean |
SolrBrowseCreateDAO.updateIndex(java.lang.String table,
int itemID,
java.util.Map sortCols) |
boolean |
BrowseCreateDAO.updateIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols)
Updates an index record into the given table for the given item id.
|
boolean |
BrowseCreateDAOPostgres.updateIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols) |
boolean |
BrowseCreateDAOOracle.updateIndex(java.lang.String table,
int itemID,
java.util.Map<java.lang.Integer,java.lang.String> sortCols) |
| Constructor and Description |
|---|
BrowseCreateDAOOracle(Context context)
Required constructor for classes implementing the BrowseCreateDAO
interface.
|
BrowseCreateDAOPostgres(Context context)
Required constructor for classes implementing the BrowseCreateDAO interface.
|
BrowseDAOOracle(Context context) |
BrowseDAOPostgres(Context context)
Required constructor for use by BrowseDAOFactory
|
BrowseEngine(Context context)
Create a new instance of the Browse engine, using the given DSpace
Context object.
|
BrowseItemDAOOracle(Context context) |
BrowseItemDAOPostgres(Context context) |
CrossLinks()
Construct a new object which will obtain the configuration for itself.
|
IndexBrowse()
Construct a new index browse.
|
IndexBrowse(Context context)
Create a new IndexBrowse object.
|
ItemListConfig()
Create a new instance of the Item list configuration.
|
SolrBrowseCreateDAO(Context context) |
Copyright © 2018 DuraSpace. All Rights Reserved.