org.sqlproc.engine.plugin.SqlSequencePlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sql-processor Show documentation

SQL Processor - Data Driven Queries

There is a newer version: 3.6.1

package org.sqlproc.engine.plugin;

import org.sqlproc.engine.SqlFeature;
import org.sqlproc.engine.SqlRuntimeContext;

/**
 * The SQL Processor plugin devoted to the sequence SELECT SQL construction.
 * 
 * There are utilized the patterns from the {@link SqlFeature}. These pattern have to be combined with the sequence name
 * used in the META SQL query in the next way:
 * 
 * $n is the name of the sequence from the META SQL query
 * 
 * 
 * @author Vladimir Hudec
 */
public interface SqlSequencePlugin extends Modifiers {

    /**
     * Used to construct the sequence SELECT SQL.
     * 
     * @param runtimeCtx
     *            the public runtime context
     * @param sequenceName
     *            the sequence name
     * @return the final sequence SELECT SQL
     */
    public String sequenceSelect(SqlRuntimeContext runtimeCtx, String sequenceName);
}