Package lumis.search.filter

Class SearchClause

  • All Implemented Interfaces:
    ISearchQueryFilter
    @Deprecated
@StableMinor(version="14.0",
             sinceVersion="4.2.2")
public class SearchClause
extends Object
implements ISearchQueryFilter
    Deprecated.
    Since 8.1.0, lumis.search was replaced by lumis.portal.bigdata.
    A search query clause. Defines an operator and terms to be applied on a optionally specified scope.
    Since:
    4.2.2
    Version:
    $Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

    • Field Detail

      • CLAUSE_OPERATOR_ANY

        public static final String CLAUSE_OPERATOR_ANY
        Deprecated.
        Any of the terms specified must be present in the searching scope.
        Since:
        4.2.2
        See Also:
        Constant Field Values

    • Constructor Detail

      • SearchClause

        public SearchClause()
        Deprecated.

    • Method Detail

      • getOperator

        public String getOperator()
        Deprecated.
        Returns the operator for this clause.
        Returns:
        the operator for this clause.
        Since:
        4.2.2
        See Also:
        setOperator(String)

      • setOperator

        public void setOperator​(String operator)
        Deprecated.
        Sets the operator for this clause. The default value is CLAUSE_OPERATOR_ANY.

        This class contains some operator constants defined as standard operators for clauses. The actual allowed operators and interpretation given depend on the Searcher implementation being used. It is recommended that all searchers implement the standard operators defined in this class for best compatibility.

        Parameters:
        operator - the operator value to set.
        Since:
        4.2.2
        See Also:
        CLAUSE_OPERATOR_ANY

      • getTerms

        public List<String> getTerms()
        Deprecated.
        Returns the terms this clause searches for. The default value is a immutable empty list.
        Returns:
        a immutable list containing the terms.
        Since:
        4.2.2
        See Also:
        setTerms(List)

      • setTerms

        public void setTerms​(List<String> terms)
        Deprecated.
        Sets the terms this clause searches for.

        Its not allowed to set a null list or list of terms that has a empty term or a null term.

        Parameters:
        terms - a list containing the terms.
        Since:
        4.2.2

      • setTerms

        public void setTerms​(String... terms)
        Deprecated.
        Sets the terms this clause searches for.

        Its not allowed to set a null or empty string term.

        Parameters:
        terms - the terms.
        Since:
        4.2.2

      • getScope

        public String getScope()
        Deprecated.
        Returns the scope for this search clause.
        Returns:
        the scope for this search clause.
        Since:
        4.2.2
        See Also:
        setScope(String)

      • setScope

        public void setScope​(String scope)
        Deprecated.
        Sets the scope for this search clause.

        It is assumed as standard the scope being the same as the field name where the terms are searched in. The actual behavior depends on the Searcher implementation being used. It is recommended that all searchers support field names being used as scope value for best compatibility.

        Parameters:
        scope - the scope value to set.
        Since:
        4.2.2