/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.shardingsphere.infra.metadata.database.schema.reviser;

import org.apache.shardingsphere.infra.config.props.ConfigurationProperties;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.column.ColumnExistedReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.column.ColumnGeneratedReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.column.ColumnNameReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.constraint.ConstraintReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.index.IndexReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.schema.SchemaTableAggregationReviser;
import org.apache.shardingsphere.infra.metadata.database.schema.reviser.table.TableNameReviser;
import org.apache.shardingsphere.infra.rule.ShardingSphereRule;
import org.apache.shardingsphere.infra.spi.annotation.SingletonSPI;
import org.apache.shardingsphere.infra.spi.type.ordered.OrderedSPI;

import java.util.Optional;

/**
 * Meta data revise entry.
 * 
 * @param <T> type of rule
 */
@SingletonSPI
public interface MetaDataReviseEntry<T extends ShardingSphereRule> extends OrderedSPI<T> {
    
    /**
     * Get schema table aggregation reviser.
     *
     * @param props configuration properties
     * @return schema table aggregation reviser
     */
    default Optional<? extends SchemaTableAggregationReviser<T>> getSchemaTableAggregationReviser(final ConfigurationProperties props) {
        return Optional.empty();
    }
    
    /**
     * Get table name reviser.
     *
     * @return table name reviser
     */
    default Optional<? extends TableNameReviser<T>> getTableNameReviser() {
        return Optional.empty();
    }
    
    /**
     * Get column existed reviser.
     *
     * @param rule rule
     * @param tableName table name
     * @return column existed reviser
     */
    default Optional<? extends ColumnExistedReviser> getColumnExistedReviser(final T rule, final String tableName) {
        return Optional.empty();
    }
    
    /**
     * Get column name reviser.
     *
     * @param rule rule
     * @param tableName table name
     * @return column name reviser
     */
    default Optional<? extends ColumnNameReviser> getColumnNameReviser(final T rule, final String tableName) {
        return Optional.empty();
    }
    
    /**
     * Get column generated reviser.
     *
     * @param rule rule
     * @param tableName table name
     * @return column generated reviser
     */
    default Optional<? extends ColumnGeneratedReviser> getColumnGeneratedReviser(final T rule, final String tableName) {
        return Optional.empty();
    }
    
    /**
     * Get index reviser.
     *
     * @param rule rule
     * @param tableName table name
     * @return index reviser
     */
    default Optional<? extends IndexReviser<T>> getIndexReviser(final T rule, final String tableName) {
        return Optional.empty();
    }
    
    /**
     * Get constraint reviser.
     *
     * @param rule rule
     * @param tableName table name
     * @return constraint reviser
     */
    default Optional<? extends ConstraintReviser<T>> getConstraintReviser(final T rule, final String tableName) {
        return Optional.empty();
    }
}
