/*
 * 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.core.rewrite.engine;

import org.apache.shardingsphere.core.rewrite.SQLBuilder;
import org.apache.shardingsphere.core.route.SQLUnit;
import org.apache.shardingsphere.core.route.type.RoutingUnit;

/**
 * SQL rewrite engine.
 *
 * @author panjuan
 */
public interface BaseSQLRewriteEngine {
    
    /**
     * rewrite SQL.
     *
     * @return SQL builder
     */
    SQLBuilder rewrite();
    
    /**
     * Generate SQL string.
     *
     * @param routingUnit routing unit
     * @param sqlBuilder SQL builder
     * @return SQL unit
     */
    SQLUnit generateSQL(RoutingUnit routingUnit, SQLBuilder sqlBuilder);
}

/*
 * 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.core.rewrite.engine;

import org.apache.shardingsphere.core.rewrite.SQLBuilder;
import org.apache.shardingsphere.core.route.SQLUnit;
import org.apache.shardingsphere.core.route.type.RoutingUnit;

/**
 * Base SQL rewrite engine.
 *
 * @author panjuan
 */
public interface BaseSQLRewriteEngine {
    
    /**
     * rewrite SQL.
     *
     * @return SQL builder
     */
    SQLBuilder rewrite();
    
    /**
     * Generate SQL string.
     *
     * @param routingUnit routing unit
     * @param sqlBuilder SQL builder
     * @return SQL unit
     */
    SQLUnit generateSQL(RoutingUnit routingUnit, SQLBuilder sqlBuilder);
}

modify java doc for BaseSQLRewriteEngine