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 Description static StringFILTER_TYPE_DEFAULTprotected StringindexFieldNameprotected booleanisOpenByDefaultprotected List<String>metadataFieldsprotected intpageSizeprotected Stringtype
-
Constructor Summary
Constructors Constructor Description DiscoverySearchFilter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetFilterType()StringgetIndexFieldName()List<String>getMetadataFields()intgetPageSize()StringgetType()Returns the type of the DiscoverySearchFilterbooleanisOpenByDefault()This method returns a boolean value indicating whether the search filter should be open or closed by default in the UIvoidsetIndexFieldName(String indexFieldName)voidsetIsOpenByDefault(boolean isOpenByDefault)Sets the DiscoverySearchFilter to be open by default or not depending on the parameter givenvoidsetMetadataFields(List<String> metadataFields)voidsetPageSize(int pageSize)voidsetType(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:DiscoveryConfigurationParametersFor the DiscoverySearchFilter only the TYPE_TEXT, TYPE_DATE and TYPE_HIERARCHICAL are allowed
-
-
-
Field Detail
-
indexFieldName
protected String indexFieldName
-
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
-
-
Method Detail
-
getIndexFieldName
public String getIndexFieldName()
-
setIndexFieldName
public void setIndexFieldName(String indexFieldName)
-
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:DiscoveryConfigurationParametersFor 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)
-
-