modules/catalog/src/main/java/org/apache/ignite/internal/catalog/descriptors/TableDescriptor.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.ignite.internal.catalog.descriptors;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.apache.ignite.internal.tostring.IgniteToStringExclude;
import org.apache.ignite.internal.tostring.S;
import org.jetbrains.annotations.Nullable;

/**
 * Table descriptor.
 */
public class TableDescriptor extends ObjectDescriptor {
    private static final long serialVersionUID = -2021394971104316570L;

    private final int zoneId = 0;
    private final int engineId = 0;

    private final List<TableColumnDescriptor> columns;
    private final List<String> primaryKeyColumns;
    private final List<String> colocationColumns;

    @IgniteToStringExclude
    private transient Map<String, TableColumnDescriptor> columnsMap;

    /**
     * Constructor.
     *
     * @param id Table id.
     * @param name Table name.
     * @param columns Table column descriptors.
     * @param pkCols Primary key column names.
     * @param colocationCols Colocation column names.
     */
    public TableDescriptor(
            int id,
            String name,
            List<TableColumnDescriptor> columns,
            List<String> pkCols,
            @Nullable List<String> colocationCols
    ) {
        super(id, Type.TABLE, name);

        this.columns = Objects.requireNonNull(columns, "No columns defined.");
        primaryKeyColumns = Objects.requireNonNull(pkCols, "No primary key columns.");
        colocationColumns = colocationCols == null ? pkCols : colocationCols;

        this.columnsMap = columns.stream().collect(Collectors.toMap(TableColumnDescriptor::name, Function.identity()));

        // TODO: IGNITE-19082 Throw proper exceptions.
        assert !columnsMap.isEmpty() : "No columns.";
        assert !primaryKeyColumns.isEmpty() : "No primary key columns.";
        assert !colocationColumns.isEmpty() : "No colocation columns.";

        assert primaryKeyColumns.stream().noneMatch(c -> Objects.requireNonNull(columnsMap.get(c), c).nullable());
        assert Set.copyOf(primaryKeyColumns).containsAll(colocationColumns);
    }

    /**
     * Returns column descriptor for column with given name.
     */
    public TableColumnDescriptor columnDescriptor(String columnName) {
        return columnsMap.get(columnName);
    }

    public int zoneId() {
        return zoneId;
    }

    public int engineId() {
        return engineId;
    }

    public List<String> primaryKeyColumns() {
        return primaryKeyColumns;
    }

    public List<String> colocationColumns() {
        return colocationColumns;
    }

    public List<TableColumnDescriptor> columns() {
        return columns;
    }

    public TableColumnDescriptor column(String name) {
        return columnsMap.get(name);
    }

    public boolean isPrimaryKeyColumn(String name) {
        return primaryKeyColumns.contains(name);
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        this.columnsMap = columns.stream().collect(Collectors.toMap(TableColumnDescriptor::name, Function.identity()));
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        return S.toString(this);
    }
}