org.sql.generation.api.grammar.modification.TargetTable 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.modification;

import org.atp.api.Typeable;
import org.sql.generation.api.grammar.common.TableName;
import org.sql.generation.api.grammar.common.TableNameDirect;

/**
 * This syntax element represents the target table of {@code DELETE FROM} and {@code UPDATE} statements.
 * 
 * @author Stanislav Muhametsin
 */
public interface TargetTable
    extends Typeable
{

    /**
     * Returns whether only this table should be updated (and not, for example, inheriting tables).
     * 
     * @return {@code true} if only this table should be updated; {@code false} otherwise.
     */
    public Boolean isOnly();

    /**
     * Returns the table name of the target table.
     * 
     * @return The table name of the target table.
     * @see TableName
     */
    public TableNameDirect getTableName();
}