com.speedment.runtime.config.trait.HasColumn Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-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.trait;

import com.speedment.runtime.config.Column;
import com.speedment.runtime.config.Document;
import com.speedment.runtime.config.Table;

import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Optional;

import static com.speedment.runtime.config.util.TraitUtil.viewOf;

/**
 * Trait for {@link Document} implementations that reference another 
 * {@link Column} document and therefore has a {@link #findColumn()} method. If 
 * a {@code Document} implements this trait, it is also expected to implement 
 * the {@link HasName} trait.
 * 
 * @author  Emil Forslund
 * @since   2.3.0
 */
public interface HasColumn extends Document, HasId, HasName {

    /**
     * Locates and returns the column referenced by the {@link #getId()} 
     * method.
     * 
     * The column must reside as a child to the table that is
     * an ancestor (i.g. a parent or a parent of a parent...) to this
     * Document.
     * 
     * @return  the referenced column
     */
    default Optional findColumn() {
        return ancestors()
            .filter(Table.class::isInstance)
            .map(Table.class::cast)
            .findFirst()
            .flatMap(table -> table
                .columns()
                .filter(col -> col.getId().equals(getId()))
                .findAny()
            );
    }
    /**
     * Locates and returns the column referenced by the {@link #getId()} or throws
     * an Exception.
     * 
     * The column must reside as a child to the table that is
     * an ancestor (i.g. a parent or a parent of a parent...) to this
     * Document.

     * @return  the referenced column
     * @throws java.util.NoSuchElementException if no column exists
     */
    default Column findColumnOrThrow() {
        return findColumn()
            .orElseThrow(() -> new NoSuchElementException(
                String.format(
                    "No column in the table %s has the id %s",
                    ancestors()
                        .filter(Table.class::isInstance)
                        .map(Table.class::cast)
                        .findFirst()
                        .map(Table::getId).orElse("NO_TABLE_FOUND"),
                    getId()
            )));
    }

    /**
     * Returns a wrapper of the specified document that implements the 
     * {@link HasColumn} trait. If the specified document already implements the
     * trait, it is returned unwrapped.
     * 
     * @param document  the document to wrap
     * @return          the wrapper
     */
    static HasColumn of(Document document) {
        return viewOf(document, HasColumn.class, HasColumnView::new);
    }
}

/**
 * A wrapper class that makes sure that a given {@link Document} implements the
 * {@link HasColumn} trait.
 * 
 * @author  Emil Forslund
 * @since   2.3
 */
class HasColumnView extends AbstractTraitView implements HasColumn {

    /**
     * Constructs a new alias view of with the specified parent and data.
     * 
     * @param parent         the parent of the wrapped document
     * @param data           the data of the wrapped document
     * @param mainInterface  the main interface of the wrapped document
     */
    HasColumnView(Document parent, Map data, Class mainInterface) {
        super(parent, data, mainInterface);
    }
}