org.sql.generation.api.grammar.builders.definition.TableDefinitionBuilder Maven / Gradle / Ivy

/*
 * Copyright (c) 2010, Stanislav Muhametsin. 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 org.sql.generation.api.grammar.builders.definition;

import org.sql.generation.api.grammar.builders.AbstractBuilder;
import org.sql.generation.api.grammar.common.TableName;
import org.sql.generation.api.grammar.common.TableNameDirect;
import org.sql.generation.api.grammar.definition.table.TableCommitAction;
import org.sql.generation.api.grammar.definition.table.TableContentsSource;
import org.sql.generation.api.grammar.definition.table.TableDefinition;
import org.sql.generation.api.grammar.definition.table.TableElementList;
import org.sql.generation.api.grammar.definition.table.TableScope;

/**
 * This is the builder for table definition statements ({@code CREATE TABLE} ...).
 * 
 * @author Stanislav Muhametsin
 */
public interface TableDefinitionBuilder
    extends AbstractBuilder
{

    /**
     * Sets the scope for this table.
     * 
     * @param scope The scope for this table.
     * @return This builder.
     * @see TableScope
     */
    public TableDefinitionBuilder setTableScope( TableScope scope );

    /**
     * Sets the name for this table.
     * 
     * @param tableName The name for this table.
     * @return This builder.
     * @see TableName
     */
    public TableDefinitionBuilder setTableName( TableNameDirect tableName );

    /**
     * Sets the commit action for this table.
     * 
     * @param commitAction The commit action for this table.
     * @return This builder.
     * @see TableCommitAction
     */
    public TableDefinitionBuilder setCommitAction( TableCommitAction commitAction );

    /**
     * Sets the contents source for this table.
     * 
     * @param contents The contents source for this table.
     * @return This builder.
     * @see TableContentsSource
     * @see TableElementList
     */
    public TableDefinitionBuilder setTableContentsSource( TableContentsSource contents );

    /**
     * Returns the scope for this table.
     * 
     * @return The scope for this table.
     */
    public TableScope getTableScope();

    /**
     * Returns the name for this table.
     * 
     * @return The name for this table.
     */
    public TableNameDirect getTableName();

    /**
     * Returns the commit action for this table.
     * 
     * @return The commit action for this table.
     */
    public TableCommitAction getCommitAction();

    /**
     * Returns the table contents source for this table.
     * 
     * @return The table contents source for this table.
     */
    public TableContentsSource getTableContentsSource();

}