Package 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 Details

    • 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:

    • isOpenByDefault

      protected boolean isOpenByDefault

    • pageSize

      protected int pageSize

  • Constructor Details

    • DiscoverySearchFilter

      public DiscoverySearchFilter()

  • Method Details

    • getIndexFieldName

      public String getIndexFieldName()

    • setIndexFieldName

      @Autowired(required=true) public void setIndexFieldName(String indexFieldName)

    • getMetadataFields

      public List<String> getMetadataFields()

    • setMetadataFields

      @Autowired(required=true) 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 indicating 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)