net.ttddyy.dsproxy.transform.TransformInfo Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of datasource-proxy Show documentation

Provide a datasource proxy that can inject your own logic into all queries.

There is a newer version: 1.10

package net.ttddyy.dsproxy.transform;

import java.sql.Statement;

/**
 * Hold context information for {@link ParameterTransformer#transformParameters(ParameterReplacer, TransformInfo)}.
 *
 * 
 * clazz: calling class. {@link java.sql.PreparedStatement} or {@link java.sql.CallableStatement}
 * 
dataSourceName: datasource name
 * 
query: query string
 * 
isBatch: true when called in batch
 * 
count: current number of call in batch. 0 origin. 0 if call is not batched
 * 
 *
 * Semantics of {@link #isBatch()}:
 * For {@link QueryTransformer},  {@link #isBatch()} is only true when {@link Statement#addBatch(String)} is called.
 * {@link #isBatch()} is always false for {@link java.sql.PreparedStatement} and {@link java.sql.CallableStatement}.
 * For {@link ParameterTransformer}, {@link #isBatch()} returns true when
 * {@link java.sql.PreparedStatement#addBatch()} or {@link java.sql.CallableStatement#addBatch()} is called.
 *
 * @author Tadaya Tsuyukubo
 * @see net.ttddyy.dsproxy.transform.ParameterTransformer
 * @see net.ttddyy.dsproxy.transform.QueryTransformer
 * @since 1.2
 */
public class TransformInfo {

    private Class clazz;
    private String dataSourceName;
    private String query;
    private boolean isBatch;
    private int count;

    public TransformInfo() {
    }

    public TransformInfo(Class clazz, String dataSourceName, String query, boolean batch, int count) {
        this.clazz = clazz;
        this.dataSourceName = dataSourceName;
        this.query = query;
        isBatch = batch;
        this.count = count;
    }

    public Class getClazz() {
        return clazz;
    }

    public void setClazz(Class clazz) {
        this.clazz = clazz;
    }

    public String getDataSourceName() {
        return dataSourceName;
    }

    public void setDataSourceName(String dataSourceName) {
        this.dataSourceName = dataSourceName;
    }

    public String getQuery() {
        return query;
    }

    public void setQuery(String query) {
        this.query = query;
    }

    public boolean isBatch() {
        return isBatch;
    }

    public void setBatch(boolean batch) {
        isBatch = batch;
    }

    /**
     * Current order in batch.
     * 0 origin. always 0 if called in non-batch.
     *
     * @return current order in batch
     */
    public int getCount() {
        return count;
    }

    public void setCount(int count) {
        this.count = count;
    }
}