io.permazen.core.Index3View Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of permazen-core Show documentation
Permazen core API classes which provide objects, fields, indexes, queries, and schema management on top of a key/value store.
The newest version!

/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.core;

import io.permazen.encoding.Encoding;
import io.permazen.encoding.Tuple2Encoding;
import io.permazen.encoding.Tuple3Encoding;
import io.permazen.kv.KeyFilter;
import io.permazen.tuple.Tuple2;
import io.permazen.tuple.Tuple3;
import io.permazen.util.UnsignedIntEncoder;

/**
 * A view of an index on three values.
 */
class Index3View extends AbstractIndexView {

    /**
     * Normal constructor.
     *
     * @param storageId field storage ID
     * @param value1Encoding first value encoding
     * @param value2Encoding second value encoding
     * @param value3Encoding third value encoding
     * @param targetEncoding index target encoding
     * @throws IllegalArgumentException if any parameter is null is null or empty
     */
    Index3View(int storageId, Encoding value1Encoding,
      Encoding value2Encoding, Encoding value3Encoding, Encoding targetEncoding) {
        this(UnsignedIntEncoder.encode(storageId), false, value1Encoding, value2Encoding, value3Encoding, targetEncoding);
    }

    /**
     * Constructor for views formed from larger composite indexes.
     *
     * @param prefix key prefix
     * @param prefixMode true if {@code targetEncoding} is not the final field in the index
     * @param value1Encoding first value encoding
     * @param value2Encoding second value encoding
     * @param value3Encoding third value encoding
     * @param targetEncoding index target encoding
     * @throws IllegalArgumentException if any parameter is null is null or empty
     */
    Index3View(byte[] prefix, boolean prefixMode,
      Encoding value1Encoding, Encoding value2Encoding, Encoding value3Encoding, Encoding targetEncoding) {
        super(prefix, prefixMode, value1Encoding, value2Encoding, value3Encoding, targetEncoding);
    }

    // Internal copy constructor
    private Index3View(Index3View original) {
        super(original);
    }

    @SuppressWarnings("unchecked")
    public Encoding getValue1Encoding() {
        return (Encoding)this.encodings[0];
    }

    @SuppressWarnings("unchecked")
    public Encoding getValue2Encoding() {
        return (Encoding)this.encodings[1];
    }

    @SuppressWarnings("unchecked")
    public Encoding getValue3Encoding() {
        return (Encoding)this.encodings[2];
    }

    @SuppressWarnings("unchecked")
    public Encoding getTargetEncoding() {
        return (Encoding)this.encodings[3];
    }

    @Override
    @SuppressWarnings("unchecked")
    public Index3View filter(int index, KeyFilter keyFilter) {
        return (Index3View)super.filter(index, keyFilter);
    }

    @Override
    protected Index3View copy() {
        return new Index3View<>(this);
    }

// Tuple views

    public Index1View, T> asTuple3Index1View() {

        // Create new IndexView
        Index1View, T> indexView = new Index1View<>(this.prefix, this.prefixMode,
          new Tuple3Encoding<>(this.getValue1Encoding(), this.getValue2Encoding(), this.getValue3Encoding()),
          this.getTargetEncoding());

        // Get filters
        final KeyFilter value1Filter = this.getFilter(0);
        final KeyFilter value2Filter = this.getFilter(1);
        final KeyFilter value3Filter = this.getFilter(2);
        final KeyFilter targetFilter = this.getFilter(3);

        // Apply filtering to tuple field
        if (value1Filter != null || value2Filter != null || value3Filter != null) {
            EncodingsFilter tupleFilter = new EncodingsFilter(null,
              this.getValue1Encoding(), this.getValue2Encoding(), this.getValue3Encoding());
            if (value1Filter != null)
                tupleFilter = tupleFilter.filter(0, value1Filter);
            if (value2Filter != null)
                tupleFilter = tupleFilter.filter(1, value2Filter);
            if (value3Filter != null)
                tupleFilter = tupleFilter.filter(2, value3Filter);
            indexView = indexView.filter(0, tupleFilter);
        }

        // Apply filtering to target field
        if (targetFilter != null)
            indexView = indexView.filter(1, targetFilter);

        // Done
        return indexView;
    }

    public Index2View, V3, T> asTuple2Index2View() {

        // Create new IndexView
        Index2View, V3, T> indexView = new Index2View<>(this.prefix, this.prefixMode,
          new Tuple2Encoding<>(this.getValue1Encoding(),
           this.getValue2Encoding()), this.getValue3Encoding(), this.getTargetEncoding());

        // Get filters
        final KeyFilter value1Filter = this.getFilter(0);
        final KeyFilter value2Filter = this.getFilter(1);
        final KeyFilter value3Filter = this.getFilter(2);
        final KeyFilter targetFilter = this.getFilter(3);

        // Apply filtering to tuple field
        if (value1Filter != null || value2Filter != null) {
            EncodingsFilter tupleFilter = new EncodingsFilter(null, this.getValue1Encoding(), this.getValue2Encoding());
            if (value1Filter != null)
                tupleFilter = tupleFilter.filter(0, value1Filter);
            if (value2Filter != null)
                tupleFilter = tupleFilter.filter(1, value2Filter);
            indexView = indexView.filter(0, tupleFilter);
        }

        // Apply filtering to value field #3
        if (value3Filter != null)
            indexView = indexView.filter(1, value3Filter);

        // Apply filtering to target field
        if (targetFilter != null)
            indexView = indexView.filter(2, targetFilter);

        // Done
        return indexView;
    }

// Prefix view

    public Index2View asIndex2View() {

        // Create IndexView
        Index2View indexView = new Index2View<>(this.prefix,
          true, this.getValue1Encoding(), this.getValue2Encoding(), this.getValue3Encoding());

        // Get filters
        final KeyFilter value1Filter = this.getFilter(0);
        final KeyFilter value2Filter = this.getFilter(1);
        final KeyFilter value3Filter = this.getFilter(2);

        // Apply filters
        if (value1Filter != null)
            indexView = indexView.filter(0, value1Filter);
        if (value2Filter != null)
            indexView = indexView.filter(1, value2Filter);
        if (value3Filter != null)
            indexView = indexView.filter(2, value3Filter);

        // Done
        return indexView;
    }

// Suffix view

    public Index2View asIndex2View(byte[] keyPrefix) {

        // Create IndexView
        Index2View indexView = new Index2View<>(keyPrefix,
          this.prefixMode, this.getValue2Encoding(), this.getValue3Encoding(), this.getTargetEncoding());

        // Get filters
        final KeyFilter value2Filter = this.getFilter(1);
        final KeyFilter value3Filter = this.getFilter(2);
        final KeyFilter targetFilter = this.getFilter(3);

        // Apply filters
        if (value2Filter != null)
            indexView = indexView.filter(0, value2Filter);
        if (value3Filter != null)
            indexView = indexView.filter(1, value3Filter);
        if (targetFilter != null)
            indexView = indexView.filter(2, targetFilter);

        // Done
        return indexView;
    }
}