com.googlecode.paradox.metadata.Table 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 java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

/**
 * A generic table.
 *
 * @since 1.6.0
 */
public interface Table {

    /**
     * Gets the table name.
     *
     * @return the table name.
     */
    String getName();

    /**
     * Gets the row count.
     *
     * @return the row count.
     */
    int getRowCount();

    /**
     * Gets the table type.
     *
     * @return the table type.
     */
    TableType type();

    /**
     * Gets the write protected value.
     *
     * @return the write protected value.
     */
    default boolean isWriteProtected() {
        return true;
    }

    /**
     * Gets the field list.
     *
     * @return the field list.
     */
    Field[] getFields();

    /**
     * Gets the schema name.
     *
     * @return the schema name.
     */
    String getSchemaName();

    /**
     * Gets the charset.
     *
     * @return the charset.
     */
    default Charset getCharset() {
        return StandardCharsets.UTF_8;
    }

    /**
     * Loads the all table rows.
     *
     * @param fields the fields to load.
     * @return the all table rows filtered by {@code fields}.
     * @throws SQLException in case of failures.
     */
    List load(final Field[] fields) throws SQLException;

    /**
     * Gets the primary key index.
     *
     * @return the primary key index or {@code null} if there is no index.
     */
    default Index getPrimaryKeyIndex() {
        return Arrays.stream(getIndexes())
                .filter(index -> index.type() == IndexType.PRIMARY_KEY)
                .findFirst().orElse(null);
    }

    /**
     * Gets the table indexes.
     *
     * @return the table indexes.
     */
    default Index[] getIndexes() {
        return new Index[0];
    }

    /**
     * Gets the table indexes.
     *
     * @return the table indexes.
     */
    default Index[] getCheckConstraints() {
        return Arrays.stream(getIndexes())
                .filter(index -> index.type() == IndexType.CHECK)
                .toArray(Index[]::new);
    }

    default ForeignKey[] getForeignKeys() {
        return new ForeignKey[0];
    }

    /**
     * Gets the table constraints.
     *
     * @return the table indexes.
     */
    default Index[] getConstraints() {
        return Arrays.stream(getIndexes())
                .filter(index -> index.type() != IndexType.INDEX)
                .toArray(Index[]::new);
    }

    /**
     * Gets if this table is encrypted.
     *
     * @return {@code true} if this table is encrypted.
     */
    default boolean isEncrypted() {
        return false;
    }

    /**
     * Gets the autoincrement value.
     *
     * @return the autoincrement value.
     */
    default int getAutoIncrementValue() {
        return 0;
    }

    /**
     * Return the block size in bytes.
     *
     * @return the block size in bytes.
     */
    default int getBlockSizeBytes() {
        return 0;
    }

    /**
     * Gets the file total blocks.
     *
     * @return the file total blocks.
     */
    default int getTotalBlocks() {
        return 0;
    }

    /**
     * Gets the used blocks.
     *
     * @return the used blocks.
     */
    default int getUsedBlocks() {
        return 0;
    }

    /**
     * Gets the record size.
     *
     * @return the record size.
     */
    default int getRecordSize() {
        return Arrays.stream(getFields()).mapToInt(Field::getRealSize).sum();
    }

    /**
     * Gets boolean description.
     *
     * @param value the boolean value to describe.
     * @return YES if {@code value} is {@code true}, NO if not.
     */
    default String description(Boolean value) {
        if (Boolean.TRUE.equals(value)) {
            return "YES";
        }

        return "NO";
    }

    /**
     * Gets the field values from context.
     *
     * @param fields  the fields to get.
     * @param mapper  the value mapper.
     * @param context the context to use.
     * @param      The context type.
     * @return the field values.
     */
    static  Object[] getFieldValues(Field[] fields, Map> mapper, T context) {
        final Object[] row = new Object[fields.length];
        for (int i = 0; i < fields.length; i++) {
            final Field field = fields[i];
            final Function function = mapper.get(field);
            if (function != null) {
                row[i] = mapper.get(field).apply(context);
            }
        }

        return row;
    }
}