com.googlecode.paradox.metadata.SoftIndex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of paradoxdriver Show documentation
A Paradox Java Driver (using JDBC 4)
The newest version!
/*
 * Copyright (c) 2009 Leonardo Alves da Costa
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
 * later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details. You should have received a copy of the GNU General Public License along with this
 * program. If not, see .
 */
package com.googlecode.paradox.metadata;

import com.googlecode.paradox.planner.sorting.OrderType;

import java.util.function.Supplier;

/**
 * A virtual index for system tables.
 *
 * @version 1.0
 * @since 1.6.0
 */
public class SoftIndex implements Index {

    /**
     * The index name.
     */
    private final String name;

    /**
     * The index uniqueness.
     */
    private final boolean unique;

    /**
     * The fields list.
     */
    private final Field[] fields;

    /**
     * Total rows supplier.
     */
    private final Supplier total;

    /**
     * Index type.
     */
    private final IndexType type;

    /**
     * Creates a new instance.
     *
     * @param name   the index name.
     * @param unique the index uniqueness.
     * @param fields the field list.
     * @param total  the total rows supplier.
     * @param type   the index type.
     */
    public SoftIndex(final String name, final boolean unique, final Field[] fields, final IndexType type,
                     final Supplier total) {
        this.name = name;
        this.unique = unique;
        this.fields = fields;
        this.type = type;
        this.total = total;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public boolean isUnique() {
        return unique;
    }

    @Override
    public OrderType getOrder() {
        return OrderType.ASC;
    }

    @Override
    public Field[] getFields() {
        return fields;
    }

    @Override
    public int getRowCount() {
        return total.get();
    }

    /**
     * Returns always zero.
     *
     * @return zero.
     */
    @Override
    public int getTotalBlocks() {
        return 0;
    }

    @Override
    public IndexType type() {
        return type;
    }
}