DocumentLocaleClause

java.lang.Object
- lumis.portal.bigdata.query.DocumentLocaleClause

All Implemented Interfaces:

ISearchQueryFilter
```
@StableMinor(version="17.0",
             sinceVersion="8.1")
public class DocumentLocaleClause
extends java.lang.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: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

See Also:

StandardDocument.Standard, StandardDocumentType

Constructor Summary

Constructors
Constructor	Description
`DocumentLocaleClause(java.lang.String targetLocale)`	Creates a new instance.
`DocumentLocaleClause(java.util.Locale targetLocale)`	Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

java.lang.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(java.util.Locale targetLocale)
```
    Creates a new instance.
    
    Parameters:
    
    targetLocale - the target locale.
    
    Since:
    
    8.1.0
  - DocumentLocaleClause
```
public DocumentLocaleClause(java.lang.String targetLocale)
```
    Creates a new instance.
    
    Parameters:
    
    targetLocale - the target locale.
    
    Since:
    
    8.1.0
- Method Detail
  - getTargetLocale
```
public java.lang.String getTargetLocale()
```
    Returns the target locale.
    
    Returns:
    
    the target locale.
    
    Since:
    
    8.1.0