Package org.dspace.rest.common
Class FilteredCollection
- java.lang.Object
-
- org.dspace.rest.common.DSpaceObject
-
- org.dspace.rest.common.FilteredCollection
-
public class FilteredCollection extends DSpaceObject
Retrieve items within a collection that match a specific set of Item Filters of interest- Author:
- Terry Brady, Georgetown University
-
-
Field Summary
Fields Modifier and Type Field Description protected org.dspace.content.service.CollectionService
collectionService
protected org.dspace.content.service.CommunityService
communityService
protected org.dspace.content.service.ItemService
itemService
-
Constructor Summary
Constructors Constructor Description FilteredCollection()
FilteredCollection(org.dspace.content.Collection collection, javax.servlet.ServletContext servletContext, String filters, String expand, org.dspace.core.Context context, Integer limit, Integer offset)
Evaluate a collection against of set of Item Filters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<ItemFilter>
getItemFilters()
List<Item>
getItems()
Integer
getNumberItems()
Integer
getNumberItemsProcessed()
Community
getParentCommunity()
List<Community>
getParentCommunityList()
Community
getTopCommunity()
void
setItemFilters(List<ItemFilter> itemFilters)
void
setItems(List<Item> items)
void
setNumberItems(Integer numberItems)
void
setNumberItemsProcessed(Integer numberItemsProcessed)
void
setParentCommunity(Community parentCommunity)
void
setParentCommunityList(List<Community> parentCommunityList)
void
setTopCommunity(Community topCommunity)
-
-
-
Constructor Detail
-
FilteredCollection
public FilteredCollection()
-
FilteredCollection
public FilteredCollection(org.dspace.content.Collection collection, javax.servlet.ServletContext servletContext, String filters, String expand, org.dspace.core.Context context, Integer limit, Integer offset) throws SQLException, javax.ws.rs.WebApplicationException
Evaluate a collection against of set of Item Filters- Parameters:
collection
- DSpace Collection to evaluateservletContext
- Context of the servlet container.filters
- String representing a list of filtersexpand
- String in which is what you want to add to returned instance of collection. Options are: "all", "parentCommunityList", "parentCommunity", "items", "license" and "logo". If you want to use multiple options, it must be separated by commas.context
- The relevant DSpace Context.limit
- Limit value for items in list in collection. Default value is 100.offset
- Offset of start index in list of items of collection. Default value is 0.- Throws:
SQLException
- An exception that provides information on a database access error or other errors.javax.ws.rs.WebApplicationException
- Runtime exception for applications.
-
-
Method Detail
-
getNumberItems
public Integer getNumberItems()
-
setNumberItems
public void setNumberItems(Integer numberItems)
-
getNumberItemsProcessed
public Integer getNumberItemsProcessed()
-
setNumberItemsProcessed
public void setNumberItemsProcessed(Integer numberItemsProcessed)
-
getParentCommunity
public Community getParentCommunity()
-
setParentCommunity
public void setParentCommunity(Community parentCommunity)
-
getTopCommunity
public Community getTopCommunity()
-
setTopCommunity
public void setTopCommunity(Community topCommunity)
-
getItemFilters
public List<ItemFilter> getItemFilters()
-
setItemFilters
public void setItemFilters(List<ItemFilter> itemFilters)
-
-