org.elasticsearch.index.fieldvisitor.IdOnlyFieldVisitor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation

Elasticsearch subproject :server

There is a newer version: 8.13.2

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.index.fieldvisitor;

import org.apache.lucene.index.FieldInfo;
import org.apache.lucene.index.StoredFieldVisitor;
import org.elasticsearch.index.mapper.IdFieldMapper;
import org.elasticsearch.index.mapper.Uid;

public final class IdOnlyFieldVisitor extends StoredFieldVisitor {
    private String id = null;
    private boolean visited = false;

    @Override
    public Status needsField(FieldInfo fieldInfo) {
        if (visited) {
            return Status.STOP;
        }
        if (IdFieldMapper.NAME.equals(fieldInfo.name)) {
            visited = true;
            return Status.YES;
        } else {
            return Status.NO;
        }
    }

    @Override
    public void binaryField(FieldInfo fieldInfo, byte[] value) {
        assert IdFieldMapper.NAME.equals(fieldInfo.name) : fieldInfo;
        if (IdFieldMapper.NAME.equals(fieldInfo.name)) {
            id = Uid.decodeId(value);
        }
    }

    public String getId() {
        return id;
    }

    public void reset() {
        id = null;
        visited = false;
    }
}