lumis.portal.bigdata.query

Class DocumentLocaleClause

java.lang.Object

lumis.portal.bigdata.query.DocumentLocaleClause

All Implemented Interfaces:

ISearchQueryFilter

@StableMinor(version="12.4",
             sinceVersion="8.1")
public class DocumentLocaleClause
extends Object
implements ISearchQueryFilter

Clause to filter documents by their locale.
The matched documents must match one of the following rules:

• Document locale equals to the target locale.
• Document locale does not match the target local, but it is the default document for missing locales and there's no equivalent document for the target locale.
• Document has no locale set.

Since:

8.1.0

Version:

$Revision: 23904 $ $Date: 2020-06-16 15:23:44 +0000 (Tue, 16 Jun 2020) $

See Also:

StandardDocument.Standard, StandardDocumentType

Constructor Summary

Constructors

Constructor and Description
DocumentLocaleClause(Locale targetLocale) Creates a new instance.
DocumentLocaleClause(String targetLocale) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getTargetLocale() Returns the target locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentLocaleClause

public DocumentLocaleClause(Locale targetLocale)

Creates a new instance.

Parameters:

targetLocale - the target locale.

Since:

8.1.0

DocumentLocaleClause

public DocumentLocaleClause(String targetLocale)

Creates a new instance.

Parameters:

targetLocale - the target locale.

Since:

8.1.0

Method Detail

getTargetLocale

public String getTargetLocale()

Returns the target locale.

Returns:

the target locale.

Since:

8.1.0