org.elasticsearch.index.fielddata.BytesValues Maven / Gradle / Ivy

/*
 * 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.fielddata;

import org.apache.lucene.util.BytesRef;
import org.elasticsearch.ElasticsearchIllegalStateException;
import org.elasticsearch.index.fielddata.ordinals.Ordinals;
import org.elasticsearch.index.fielddata.ordinals.Ordinals.Docs;

/**
 * A state-full lightweight per document set of byte[] values.
 *
 * To iterate over values in a document use the following pattern:
 *  *   BytesValues values = ..;
 *   final int numValues = values.setDocId(docId);
 *   for (int i = 0; i < numValues; i++) {
 *       BytesRef value = values.nextValue();
 *       // process value
 *   }
 * 
 */
public abstract class BytesValues {

    /**
     * An empty {@link BytesValues instance}
     */
    public static final BytesValues EMPTY = new Empty();

    private boolean multiValued;

    protected final BytesRef scratch = new BytesRef();

    protected int docId = -1;

    /**
     * Creates a new {@link BytesValues} instance
     * @param multiValued true iff this instance is multivalued. Otherwise false.
     */
    protected BytesValues(boolean multiValued) {
        this.multiValued = multiValued;
    }

    /**
     * Is one of the documents in this field data values is multi valued?
     */
    public final boolean isMultiValued() {
        return multiValued;
    }

    /**
     * Converts the current shared {@link BytesRef} to a stable instance. Note,
     * this calls makes the bytes safe for *reads*, not writes (into the same BytesRef). For example,
     * it makes it safe to be placed in a map.
     */
    public BytesRef copyShared() {
        return BytesRef.deepCopyOf(scratch);
    }

    /**
     * Sets iteration to the specified docID and returns the number of
     * values for this document ID,
     * @param docId document ID
     *
     * @see #nextValue()
     */
    public abstract int setDocument(int docId);

    /**
     * Returns the next value for the current docID set to {@link #setDocument(int)}.
     * This method should only be called N times where N is the number
     * returned from {@link #setDocument(int)}. If called more than N times the behavior
     * is undefined. This interface guarantees that the values are returned in order.
     * 
     * If this instance returns ordered values the Nth value is strictly less than the N+1 value with
     * respect to the {@link AtomicFieldData.Order} returned from {@link #getOrder()}. If this instance returns
     * unordered values {@link #getOrder()} must return {@link AtomicFieldData.Order#NONE}
     * Note: the values returned are de-duplicated, only unique values are returned.
     * 
     *
     * Note: the returned {@link BytesRef} might be shared across invocations.
     *
     * @return the next value for the current docID set to {@link #setDocument(int)}.
     */
    public abstract BytesRef nextValue();

    /**
     * Returns the hash value of the previously returned shared {@link BytesRef} instances.
     *
     * @return the hash value of the previously returned shared {@link BytesRef} instances.
     */
    public int currentValueHash() {
        return scratch.hashCode();
    }

    /**
     * Returns the order the values are returned from {@link #nextValue()}.
     *  Note: {@link BytesValues} have {@link AtomicFieldData.Order#BYTES} by default.
     */
    public AtomicFieldData.Order getOrder() {
        return AtomicFieldData.Order.BYTES;
    }

    /**
     * Ordinal based {@link BytesValues}.
     */
    public static abstract class WithOrdinals extends BytesValues {

        protected final Docs ordinals;

        protected WithOrdinals(Ordinals.Docs ordinals) {
            super(ordinals.isMultiValued());
            this.ordinals = ordinals;
        }

        /**
         * Returns the associated ordinals instance.
         * @return the associated ordinals instance.
         */
        public Ordinals.Docs ordinals() {
            return ordinals;
        }

        /**
         * Returns the value for the given ordinal.
         * @param ord the ordinal to lookup.
         * @return a shared {@link BytesRef} instance holding the value associated
         *         with the given ordinal or null if ordinal is 0
         */
        public abstract BytesRef getValueByOrd(long ord);

        @Override
        public int setDocument(int docId) {
            this.docId = docId;
            int length = ordinals.setDocument(docId);
            assert (ordinals.getOrd(docId) != Ordinals.MISSING_ORDINAL) == length > 0 : "Doc: [" + docId + "] hasValue: [" + (ordinals.getOrd(docId) != Ordinals.MISSING_ORDINAL) + "] but length is [" + length + "]";
            return length;
        }

        @Override
        public BytesRef nextValue() {
            assert docId != -1;
            return getValueByOrd(ordinals.nextOrd());
        }
    }

    /**
     * An empty {@link BytesValues} implementation
     */
    private final static class Empty extends BytesValues {

        Empty() {
            super(false);
        }

        @Override
        public int setDocument(int docId) {
            return 0;
        }

        @Override
        public BytesRef nextValue() {
            throw new ElasticsearchIllegalStateException("Empty BytesValues has no next value");
        }

        @Override
        public int currentValueHash() {
            throw new ElasticsearchIllegalStateException("Empty BytesValues has no hash for the current Value");
        }

    }
}