Package lumis.portal.bigdata.query

Class SearchFieldClause

java.lang.Object

lumis.portal.bigdata.query.SearchFieldClause

All Implemented Interfaces:

ISearchQueryFilter

@StableMinor(version="17.0",
             sinceVersion="8.1")
public class SearchFieldClause
extends java.lang.Object
implements ISearchQueryFilter

A search query clause used by a searcher to search content. Defines an operator and values to be applied on a optionally specified field.

Since:

8.1.0

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchFieldClause.Operator	Supported operators.

Constructor Summary

Constructors

Constructor	Description
SearchFieldClause(java.lang.String fieldId)	Creates a new instance using the given field identifier.
SearchFieldClause(DocumentTypeField field)	Creates a new search field clause for the given field.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFieldId()	Returns the field identifier for this search clause.
SearchFieldClause.Operator	getOperator()	Returns the operator for this clause.
java.util.Collection<java.lang.Object>	getValues()	Returns the values this clause searches for.
SearchFieldClause	setOperator(SearchFieldClause.Operator operator)	Sets the operator for this clause.
SearchFieldClause	setValues(java.lang.Object... values)	Sets the values this clause searches for.
SearchFieldClause	setValues(java.util.Collection<?> values)	Sets the values this clause searches for.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFieldClause

public SearchFieldClause(DocumentTypeField field)

Creates a new search field clause for the given field.

Parameters:

field - the field.

Since:

8.1.0

SearchFieldClause

public SearchFieldClause(java.lang.String fieldId)

Creates a new instance using the given field identifier.

Parameters:

fieldId - the field identifier.

Since:

8.1.0

Method Detail

getOperator

public SearchFieldClause.Operator getOperator()

Returns the operator for this clause.

Returns:

the operator for this clause.

Since:

8.1.0

See Also:

#setOperator(String)

setOperator

public SearchFieldClause setOperator(SearchFieldClause.Operator operator)

Sets the operator for this clause. The default value is SearchFieldClause.Operator.ANY.

Parameters:

operator - the operator value to set.

Returns:

this SearchFieldClause.

Since:

8.1.0

See Also:

SearchFieldClause.Operator

getValues

public java.util.Collection<java.lang.Object> getValues()

Returns the values this clause searches for. The default value is an empty list.

Returns:

a immutable collection containing the values.

Since:

8.1.0

See Also:

setValues(java.util.Collection<?>)

setValues

public SearchFieldClause setValues(java.util.Collection<?> values)

Sets the values this clause searches for.

Its not allowed to set a null list or list of values that has a empty value or a null value.

Parameters:

values - a list containing the values.

Returns:

this SearchFieldClause.

Since:

8.1.0

setValues

public SearchFieldClause setValues(java.lang.Object... values)

Sets the values this clause searches for.

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

Parameters:

values - the values.

Returns:

this SearchFieldClause.

Since:

8.1.0

getFieldId

public java.lang.String getFieldId()

Returns the field identifier for this search clause.

Returns:

the field identifier for this search clause.

Since:

8.1.0

See Also:

#setScope(String)