com.speedment.runtime.config.Table Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of generator-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.
The newest version!
/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * Licensed 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 com.speedment.runtime.config;

import com.speedment.runtime.config.internal.TableImpl;
import com.speedment.runtime.config.mutator.DocumentMutator;
import com.speedment.runtime.config.mutator.TableMutator;
import com.speedment.runtime.config.trait.*;
import com.speedment.runtime.config.util.DocumentUtil;

import java.util.Optional;
import java.util.stream.Stream;

/**
 * A typed {@link Document} that represents a table instance in the database. A
 * {@code Table} is located inside a {@link Schema} and can have multiple 
 * {@link Column Columns} as children.
 * 
 * @author  Emil Forslund
 * @since   2.0.0
 */
public interface Table extends
        Document,
        HasParent,
        HasDeepCopy,
        HasEnabled,
        HasId,        
        HasName,
        HasChildren,
        HasAlias,
        HasPackageName,
        HasMainInterface,
        HasMutator> {

    /**
     * Returns {@code true} if this {@code Table} represents a VIEW in the
     * database. VIEW Tables are not necessarily writable and might not have
     * all the functionality a regular Table has.
     * 
     * The default value for this property is {@code false}.
     *
     * @return  {@code true} if this is just a SQL VIEW, else {@code false}
     * @since   3.0.11
     */
    default boolean isView() {
        return getAsBoolean(TableUtil.IS_VIEW).orElse(false);
    }

    /**
     * Creates a stream of columns located in this document.
     * 
     * @return  columns
     */
    Stream columns();
    
    /**
     * Creates a stream of indexes located in this document.
     * 
     * @return  indexes
     */
    Stream indexes();
    
    /**
     * Creates a stream of foreign keys located in this document.
     * 
     * @return  foreign keys
     */
    Stream foreignKeys();
    
    /**
     * Creates a stream of primary key columns located in this document.
     * 
     * @return  primary key columns
     */
    Stream primaryKeyColumns();

    /**
     * Locate the {@link Column} child with the specified id if it exists, else
     * return an empty {@code Optional}.
     *
     * @param id  the {@link HasId#getId()} of the column
     * @return    the child found or an empty {@code Optional}
     */
    default Optional findColumn(String id) {
        return columns().filter(child -> child.getId().equals(id)).findAny();
    }

    /**
     * Locate the {@link Index} child with the specified id if it exists, else
     * return an empty {@code Optional}.
     *
     * @param id  the {@link HasId#getId()} of the index
     * @return    the child found or an empty {@code Optional}
     */
    default Optional findIndex(String id) {
        return indexes().filter(child -> child.getId().equals(id)).findAny();
    }

    /**
     * Locate the {@link ForeignKey} child with the specified id if it exists,
     * else return an empty {@code Optional}.
     *
     * @param id  the {@link HasId#getId()} of the foreign key
     * @return    the child found or an empty {@code Optional}
     */
    default Optional findForeignKey(String id) {
        return foreignKeys().filter(child -> child.getId().equals(id)).findAny();
    }

    /**
     * Locate the {@link PrimaryKeyColumn} child with the specified id if it
     * exists, else return an empty {@code Optional}.
     *
     * @param id  the {@link HasId#getId()} of the primary key column
     * @return    the child found or an empty {@code Optional}
     */
    default Optional findPrimaryKeyColumn(String id) {
        return primaryKeyColumns().filter(child -> child.getId().equals(id)).findAny();
    }

    @Override
    default Class mainInterface() {
        return Table.class;
    }

    @Override
    default TableMutator mutator() {
        return DocumentMutator.of(this);
    }

    @Override
    default Table deepCopy() {
        return DocumentUtil.deepCopy(this, TableImpl::new);
    }
}



© 2015 - 2024 Weber Informatics LLC | Privacy Policy