Package org.dspace.rest.common

Class ItemFilter

java.lang.Object

org.dspace.rest.common.ItemFilter

public class ItemFilter
extends Object

Use Case Item Filters that match a specific set of criteria.

Author:

Terry Brady, Georgetown University

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL
static String	ALL_FILTERS

Constructor Summary

Constructors

Constructor	Description
ItemFilter()
ItemFilter(String name, String title, String description, String category, boolean saveItems)
ItemFilter(ItemFilterTest itemFilterTest, boolean saveItems)

Method Summary

Modifier and Type	Method	Description
void	addItem(Item restItem)
void	annotateQuery(List<String> query_field, List<String> query_op, List<String> query_val)
static ItemFilter	getAllFiltersFilter(List<ItemFilter> itemFilters)
String	getCategory()
String	getDescription()
String	getFilterName()
Integer	getItemCount()
List<ItemFilterQuery>	getItemFilterQueries()
static List<ItemFilter>	getItemFilters(String filters, boolean saveItems)
List<Item>	getItems()
List<MetadataEntry>	getMetadata()
String	getQueryAnnotation()
String	getTitle()
Integer	getUnfilteredItemCount()
boolean	hasItemTest()
void	initMetadataList(List<String> show_fields)
void	setCategory(String category)
void	setDescription(String description)
void	setFilterName(String name)
void	setItemCount(Integer itemCount)
void	setItemFilterQueries(List<ItemFilterQuery> itemFilterQueries)
void	setItems(List<Item> items)
void	setMetadata(List<MetadataEntry> metadata)
void	setQueryAnnotation(String queryAnnotation)
void	setTitle(String title)
void	setUnfilteredItemCount(Integer unfilteredItemCount)
boolean	testItem(org.dspace.core.Context context, org.dspace.content.Item item, Item restItem)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_FILTERS

public static final String ALL_FILTERS

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

Constructor Detail

ItemFilter

public ItemFilter()

ItemFilter

public ItemFilter(ItemFilterTest itemFilterTest,
                  boolean saveItems)
           throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

ItemFilter

public ItemFilter(String name,
                  String title,
                  String description,
                  String category,
                  boolean saveItems)
           throws javax.ws.rs.WebApplicationException

Throws:

javax.ws.rs.WebApplicationException

Method Detail

getItemFilters

public static List<ItemFilter> getItemFilters(String filters,
                                              boolean saveItems)

getAllFiltersFilter

public static ItemFilter getAllFiltersFilter(List<ItemFilter> itemFilters)

hasItemTest

public boolean hasItemTest()

addItem

public void addItem(Item restItem)

testItem

public boolean testItem(org.dspace.core.Context context,
                        org.dspace.content.Item item,
                        Item restItem)

getFilterName

public String getFilterName()

setFilterName

public void setFilterName(String name)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getCategory

public String getCategory()

setCategory

public void setCategory(String category)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getQueryAnnotation

public String getQueryAnnotation()

annotateQuery

public void annotateQuery(List<String> query_field,
                          List<String> query_op,
                          List<String> query_val)
                   throws SQLException

Throws:

SQLException

setQueryAnnotation

public void setQueryAnnotation(String queryAnnotation)

getItemCount

public Integer getItemCount()

setItemCount

public void setItemCount(Integer itemCount)

getUnfilteredItemCount

public Integer getUnfilteredItemCount()

setUnfilteredItemCount

public void setUnfilteredItemCount(Integer unfilteredItemCount)

getItems

public List<Item> getItems()

setItems

public void setItems(List<Item> items)

getItemFilterQueries

public List<ItemFilterQuery> getItemFilterQueries()

setItemFilterQueries

public void setItemFilterQueries(List<ItemFilterQuery> itemFilterQueries)

initMetadataList

public void initMetadataList(List<String> show_fields)

getMetadata

public List<MetadataEntry> getMetadata()

setMetadata

public void setMetadata(List<MetadataEntry> metadata)