com.speedment.tool.config.component.DocumentPropertyComponent Maven / Gradle / Ivy

Go to download
/*
 *
 * 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.tool.config.component;

import com.speedment.common.injector.annotation.InjectKey;
import com.speedment.runtime.config.Document;
import com.speedment.tool.config.DocumentProperty;

import java.util.List;

/**
 * Describes which implementations the {@link Document} interface to use at
 * different places in the config tree. This is purely used by the UI.
 * 
 * @author  Emil Forslund
 * @since   2.3.0
 */
@InjectKey(DocumentPropertyComponent.class)
public interface DocumentPropertyComponent {

    /**
     * Functional interface that describes a constructor for an observable 
     * document.
     * 
     * @param   the parent type
     */
    @FunctionalInterface
    interface Constructor {
        DocumentProperty create(PARENT parent);
    }

    /**
     * Sets the method used to produce an observable view of a branch in the 
     * tree. The specified {@code keyPath} describes where in the tree this
     * method should be used. The last string in the array is the key for the
     * collection that is added to.
     * 
     * Example:
     * 

     *     setConstructor(ProjectProperty::new);
     *     
setConstructor(DbmsProperty::new, "dbmses")
     *     
setConstructor(SchemaProperty::new, "dbmses", "schemas");
     *     
setConstructor(TableProperty::new, "dbmses", "schemas", "tables");
     * 
     * 
     * @param      the type of the parent
     * @param constructor  the new constructor to use
     * @param keyPath      the path to the collection where to use it
     */
     void setConstructor(Constructor constructor, List keyPath);
    
    /**
     * Creates a new observable document using the installed constructor, at
     * the path specified by {@code keyPath}. To change the implementation, use 
     * {@link #setConstructor(Constructor, java.util.List) }.
     * 
     * @param   the parent type
     * @param keyPath   the path of the constructor
     * @return          the created document
     */
     Constructor getConstructor(List keyPath);
}