Package lumis.search

Class SearchAttributes

  • All Implemented Interfaces:
    IAttributeSetReader

    @Deprecated
    @StableMinor(version="17.0",
                 sinceVersion="4.0")
    public final class SearchAttributes
    extends java.lang.Object
    implements IAttributeSetReader
    Deprecated.
    Since 8.1.0, lumis.search was replaced by lumis.portal.bigdata.
    Set of attributes aggregated to a SearchQuery, a SearchHit or a SearchResults. They represent extra information aggregated to these objects. For example, in a SearchQuery, they contain information that affetcs the criteria used in search.
    Since:
    4.0.4
    Version:
    $Revision: 26586 $ $Date: 2024-08-26 21:06:04 -0300 (Mon, 26 Aug 2024) $
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> attributes
      Deprecated.
      The Map of attributes and respective values.
    • Constructor Summary

      Constructors 
      Constructor Description
      SearchAttributes()
      Deprecated.
       
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addAttributeValue​(java.lang.String attributeName, java.lang.String attributeValue)
      Deprecated.
      Add a value to the set of values of an attribute.
      java.util.List<java.lang.String> getAttributeValues​(java.lang.String attributeName)
      Deprecated.
      Returns all the values related to the attribute named as specified.
      boolean hasAttribute​(java.lang.String attributeName)
      Deprecated.
      Checks if the attribute set contains at least one attribute with the specified name.
      void removeAttribute​(java.lang.String attributeName)
      Deprecated.
      Remove an attribute.
      void setAttributeValues​(java.lang.String attributeName, java.lang.String[] attributeValues)
      Deprecated.
      Set the values of an attribute.
      void setAttributeValues​(java.lang.String attributeName, java.util.List<java.lang.String> attributeValues)
      Deprecated.
      Set the values of an attribute.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • attributes

        protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> attributes
        Deprecated.
        The Map of attributes and respective values. The map key is the attribute name, and the map value is a List of attribute values.
    • Constructor Detail

      • SearchAttributes

        public SearchAttributes()
        Deprecated.
    • Method Detail

      • setAttributeValues

        public void setAttributeValues​(java.lang.String attributeName,
                                       java.lang.String[] attributeValues)
        Deprecated.
        Set the values of an attribute.
        Parameters:
        attributeName - attribute name
        attributeValues - attribute values
        Since:
        4.0.4
      • setAttributeValues

        public void setAttributeValues​(java.lang.String attributeName,
                                       java.util.List<java.lang.String> attributeValues)
        Deprecated.
        Set the values of an attribute.
        Parameters:
        attributeName - attribute name
        attributeValues - attribute values
        Since:
        4.0.4
      • addAttributeValue

        public void addAttributeValue​(java.lang.String attributeName,
                                      java.lang.String attributeValue)
        Deprecated.
        Add a value to the set of values of an attribute.
        Parameters:
        attributeName - attribute name
        attributeValue - new value to be added
        Since:
        4.0.4
      • removeAttribute

        public void removeAttribute​(java.lang.String attributeName)
        Deprecated.
        Remove an attribute.
        Parameters:
        attributeName - attribute name
        Since:
        4.0.4
      • hasAttribute

        public boolean hasAttribute​(java.lang.String attributeName)
        Deprecated.
        Description copied from interface: IAttributeSetReader
        Checks if the attribute set contains at least one attribute with the specified name.
        Specified by:
        hasAttribute in interface IAttributeSetReader
        Parameters:
        attributeName - name of the attribute.
        Returns:
        true if at least one attribute with the provided name was found.
      • getAttributeValues

        public java.util.List<java.lang.String> getAttributeValues​(java.lang.String attributeName)
        Deprecated.
        Description copied from interface: IAttributeSetReader
        Returns all the values related to the attribute named as specified.
        Specified by:
        getAttributeValues in interface IAttributeSetReader
        Parameters:
        attributeName - name of the attribute.
        Returns:
        all values related to the specified attribute name, or an empty List if there is no value to return.