org.dspace.discovery.configuration

Class DiscoverySearchFilter

java.lang.Object

org.dspace.discovery.configuration.DiscoverySearchFilter

Direct Known Subclasses:

DiscoverySearchFilterFacet

public class DiscoverySearchFilter
extends Object

Author:

Kevin Van de Velde (kevin at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_TYPE_DEFAULT
protected String	indexFieldName
protected boolean	isOpenByDefault
protected List<String>	metadataFields
protected int	pageSize
protected String	type

Constructor Summary

Constructors

Constructor and Description
DiscoverySearchFilter()

Method Summary

Modifier and Type	Method and Description
String	getFilterType()
String	getIndexFieldName()
List<String>	getMetadataFields()
int	getPageSize()
String	getType() Returns the type of the DiscoverySearchFilter
boolean	isOpenByDefault() This method returns a boolean value indicating whether the search filter should be open or closed by default in the UI
void	setIndexFieldName(String indexFieldName)
void	setIsOpenByDefault(boolean isOpenByDefault) Sets the DiscoverySearchFilter to be open by default or not depending on the parameter given
void	setMetadataFields(List<String> metadataFields)
void	setPageSize(int pageSize)
void	setType(String type) Sets the type of the DiscoverySearchFilter to the one given in the parameter if it matches a set of possible types The possible types are described in: DiscoveryConfigurationParameters For the DiscoverySearchFilter only the TYPE_TEXT, TYPE_DATE and TYPE_HIERARCHICAL are allowed

Methods inherited from class java.lang.Object

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

Field Detail

indexFieldName

protected String indexFieldName

metadataFields

protected List<String> metadataFields

type

protected String type

FILTER_TYPE_DEFAULT

public static final String FILTER_TYPE_DEFAULT

See Also:

Constant Field Values

isOpenByDefault

protected boolean isOpenByDefault

pageSize

protected int pageSize

Constructor Detail

DiscoverySearchFilter

public DiscoverySearchFilter()

Method Detail

getIndexFieldName

public String getIndexFieldName()

setIndexFieldName

public void setIndexFieldName(String indexFieldName)

getMetadataFields

public List<String> getMetadataFields()

setMetadataFields

public void setMetadataFields(List<String> metadataFields)

getType

public String getType()

Returns the type of the DiscoverySearchFilter

Returns:

The type of the DiscoverySearchFilter

setType

public void setType(String type)
             throws DiscoveryConfigurationException

Sets the type of the DiscoverySearchFilter to the one given in the parameter if it matches a set of possible types The possible types are described in: DiscoveryConfigurationParameters For the DiscoverySearchFilter only the TYPE_TEXT, TYPE_DATE and TYPE_HIERARCHICAL are allowed

Parameters:

type - The type for this DiscoverySearchFilter

Throws:

DiscoveryConfigurationException - If none of the types match, this error will be thrown indiciating this

getFilterType

public String getFilterType()

isOpenByDefault

public boolean isOpenByDefault()

This method returns a boolean value indicating whether the search filter should be open or closed by default in the UI

Returns:

A boolean value indicating whether the search filter in the ui should be open or closed by default

setIsOpenByDefault

public void setIsOpenByDefault(boolean isOpenByDefault)

Sets the DiscoverySearchFilter to be open by default or not depending on the parameter given

Parameters:

isOpenByDefault - A boolean value that will indicate whether this DiscoverySearchFilter should be open by default or not in the UI.

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)