container-search/src/main/java/com/yahoo/search/schema/FieldInfo.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.schema;

import com.yahoo.api.annotations.Beta;

import java.util.Set;

/**
 * Information about a field or field set.
 *
 * @author bratseth
 */
@Beta
public interface FieldInfo {

    /** Returns the name of this field or field set. */
    String name();

    Field.Type type();

    /** Returns whether this field or field set is attribute(s), i.e. does indexing: attribute. */
    boolean isAttribute();

    /** Returns whether this field is index(es), i.e. does indexing: index. */
    boolean isIndex();

}