/**
* Return the focus value.
*
* @return the focus value to use
* @throws BrowseException
*/
private String getJumpToValue() throws BrowseException {
log.debug(LogManager.getHeader(context, "get_focus_value", ""));
// if the focus is by value, just return it
if (scope.hasJumpToValue()) {
log.debug(
LogManager.getHeader(
context, "get_focus_value_return", "return=" + scope.getJumpToValue()));
return scope.getJumpToValue();
}
// if the focus is to start with, then we need to return the value of the starts with
if (scope.hasStartsWith()) {
log.debug(
LogManager.getHeader(
context, "get_focus_value_return", "return=" + scope.getStartsWith()));
return scope.getStartsWith();
}
// since the focus is not by value, we need to obtain it
// get the id of the item to focus on
int id = scope.getJumpToItem();
// get the table name. We don't really need to care about whether we are in a
// community or collection at this point. This is only for full or second
// level browse, so there is no need to worry about distinct value browsing
String tableName = browseIndex.getTableName();
// we need to make sure that we select from the correct column. If the sort option
// is the 0th option then we use sort_value, but if it is one of the others we have
// to select from that column instead. Otherwise, we end up missing the focus value
// to do comparisons in other columns. The use of the focus value needs to be consistent
// across the browse
SortOption so = scope.getSortOption();
if (so == null || so.getNumber() == 0) {
if (browseIndex.getSortOption() != null) {
so = browseIndex.getSortOption();
}
}
String col = "sort_1";
if (so.getNumber() > 0) {
col = "sort_" + Integer.toString(so.getNumber());
}
// now get the DAO to do the query for us, returning the highest
// string value in the given column in the given table for the
// item (I think)
String max = dao.doMaxQuery(col, tableName, id);
log.debug(LogManager.getHeader(context, "get_focus_value_return", "return=" + max));
return max;
}
String getKey() {
try {
String key = "";
key += "-" + scope.getBrowseIndex().getName();
key += "-" + scope.getBrowseLevel();
key += "-" + scope.getStartsWith();
key += "-" + scope.getResultsPerPage();
key += "-" + scope.getSortBy();
key += "-" + scope.getSortOption().getNumber();
key += "-" + scope.getOrder();
key += "-" + scope.getJumpToItem();
key += "-" + scope.getFilterValue();
key += "-" + scope.getFilterValueLang();
key += "-" + scope.getJumpToValue();
key += "-" + scope.setJumpToValueLang();
key += "-" + etAl;
return key;
} catch (Exception e) {
return null; // ignore exception and return no key
}
}
/**
* Browse the archive by the full item browse mechanism. This produces a BrowseInfo object which
* contains full BrowseItem objects as its result set.
*
* @param bs the scope of the browse
* @return the results of the browse
* @throws BrowseException
*/
private BrowseInfo browseByItem(BrowserScope bs) throws BrowseException {
log.info(LogManager.getHeader(context, "browse_by_item", ""));
try {
// get the table name that we are going to be getting our data from
dao.setTable(browseIndex.getTableName());
// tell the browse query whether we are ascending or descending on the value
dao.setAscending(scope.isAscending());
// assemble the value clause
String rawValue = null;
if (scope.hasFilterValue() && scope.isSecondLevel()) {
String value = scope.getFilterValue();
rawValue = value;
// make sure the incoming value is normalised
value =
OrderFormat.makeSortString(
value, scope.getFilterValueLang(), scope.getBrowseIndex().getDataType());
dao.setAuthorityValue(scope.getAuthorityValue());
// set the values in the Browse Query
if (scope.isSecondLevel()) {
dao.setFilterValueField("value");
dao.setFilterValue(rawValue);
} else {
dao.setFilterValueField("sort_value");
dao.setFilterValue(value);
}
dao.setFilterValuePartial(scope.getFilterValuePartial());
// to apply the filtering, we need the distinct and map tables for the index
dao.setFilterMappingTables(
browseIndex.getDistinctTableName(), browseIndex.getMapTableName());
}
// define a clause for the WHERE clause which will allow us to constrain
// our browse to a specified community or collection
if (scope.inCollection() || scope.inCommunity()) {
if (scope.inCollection()) {
Collection col = (Collection) scope.getBrowseContainer();
dao.setContainerTable("collection2item");
dao.setContainerIDField("collection_id");
dao.setContainerID(col.getID());
} else if (scope.inCommunity()) {
Community com = (Community) scope.getBrowseContainer();
dao.setContainerTable("communities2item");
dao.setContainerIDField("community_id");
dao.setContainerID(com.getID());
}
}
// this is the total number of results in answer to the query
int total = getTotalResults();
// assemble the ORDER BY clause
String orderBy = browseIndex.getSortField(scope.isSecondLevel());
if (scope.getSortBy() > 0) {
orderBy = "sort_" + Integer.toString(scope.getSortBy());
}
dao.setOrderField(orderBy);
int offset = scope.getOffset();
String rawFocusValue = null;
if (offset < 1
&& (scope.hasJumpToItem() || scope.hasJumpToValue() || scope.hasStartsWith())) {
// We need to convert these to an offset for the actual browse query.
// First, get a value that we can look up in the ordering field
rawFocusValue = getJumpToValue();
// make sure the incoming value is normalised
String focusValue = normalizeJumpToValue(rawFocusValue);
log.debug("browsing using focus: " + focusValue);
// Convert the focus value into an offset
offset = getOffsetForValue(focusValue);
}
dao.setOffset(offset);
// assemble the LIMIT clause
dao.setLimit(scope.getResultsPerPage());
// Holder for the results
List<BrowseItem> results = null;
// Does this browse have any contents?
if (total > 0) {
// now run the query
results = dao.doQuery();
// now, if we don't have any results, we are at the end of the browse. This will
// be because a starts_with value has been supplied for which we don't have
// any items.
if (results.size() == 0) {
// In this case, we will calculate a new offset for the last page of results
offset = total - scope.getResultsPerPage();
if (offset < 0) {
offset = 0;
}
// And rerun the query
dao.setOffset(offset);
results = dao.doQuery();
}
} else {
// No records, so make an empty list
results = new ArrayList<BrowseItem>();
}
// construct the BrowseInfo object to pass back
// BrowseInfo browseInfo = new BrowseInfo(results, position, total, offset);
BrowseInfo browseInfo = new BrowseInfo(results, offset, total, offset);
if (offset + scope.getResultsPerPage() < total) {
browseInfo.setNextOffset(offset + scope.getResultsPerPage());
}
if (offset - scope.getResultsPerPage() > -1) {
browseInfo.setPrevOffset(offset - scope.getResultsPerPage());
}
// add the browse index to the Browse Info
browseInfo.setBrowseIndex(browseIndex);
// set the sort option for the Browse Info
browseInfo.setSortOption(scope.getSortOption());
// tell the Browse Info which way we are sorting
browseInfo.setAscending(scope.isAscending());
// tell the Browse Info which level of browse we are at
browseInfo.setBrowseLevel(scope.getBrowseLevel());
// set the browse value if there is one
browseInfo.setValue(rawValue);
// set the browse authority key if there is one
browseInfo.setAuthority(scope.getAuthorityValue());
// set the focus value if there is one
browseInfo.setFocus(rawFocusValue);
if (scope.hasJumpToItem()) {
browseInfo.setFocusItem(scope.getJumpToItem());
}
// tell the browse info if it is working from a starts with parameter
browseInfo.setStartsWith(scope.hasStartsWith());
// tell the browse info what the container for the browse was
if (scope.inCollection() || scope.inCommunity()) {
browseInfo.setBrowseContainer(scope.getBrowseContainer());
}
browseInfo.setResultsPerPage(scope.getResultsPerPage());
browseInfo.setEtAl(scope.getEtAl());
return browseInfo;
} catch (SQLException e) {
log.error("caught exception: ", e);
throw new BrowseException(e);
}
}