Field (SearchHub Services - Parent 0.22.1 API)

java.lang.Object
- de.cxp.ocs.config.Field

```
public class Field
extends Object
```

Field Summary

Fields
Modifier and Type Field Description

protected @NonNull String name
Sets the name of the field used in the Elasticsearch index.

Constructor Summary

Constructors
Constructor Description

Field()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Field`	`addSourceName(String name)`	Adds the specified name to the source names list.
`boolean`	`isBothLevel()`	Checks if the field is be indexed on both - master and variant - level.
`boolean`	`isMasterLevel()`	Checks if the field is indexed on master level.
`boolean`	`isVariantLevel()`	Checks if the field is indexed on variant level.
`Field`	`setUsage(FieldUsage usage1, FieldUsage... usages)`
`Field`	`setUsage(Collection<FieldUsage> usages)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
@NonNull
protected @NonNull String name
```
    Sets the name of the field used in the Elasticsearch index.
- Constructor Detail
  - Field
```
public Field()
```
- Method Detail
  - isVariantLevel
```
public boolean isVariantLevel()
```
    Checks if the field is indexed on variant level.
    
    Returns:
    
    true if the field is on variant level, false otherwise.
  - isMasterLevel
```
public boolean isMasterLevel()
```
    Checks if the field is indexed on master level.
    
    Returns:
    
    true if the field is on master level, false otherwise.
  - isBothLevel
```
public boolean isBothLevel()
```
    Checks if the field is be indexed on both - master and variant - level.
    
    Returns:
    
    true if the field is on both level, false otherwise.
  - addSourceName
```
public Field addSourceName(String name)
```
    Adds the specified name to the source names list.
    
    Parameters:
    
    name - the name to add to the list of source names.
    
    Returns:
    
    this instance.
  - setUsage
```
public Field setUsage(FieldUsage usage1,
                      FieldUsage... usages)
```
  - setUsage
```
public Field setUsage(Collection<FieldUsage> usages)
```