com.speedment.runtime.core.component.SqlAdapter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation
Show all versions of tool-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
The newest version!
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. 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 com.speedment.runtime.core.component;
import com.speedment.common.injector.annotation.InjectKey;
import com.speedment.runtime.config.identifier.TableIdentifier;
import com.speedment.runtime.core.db.SqlFunction;
import java.sql.ResultSet;
/**
* An SqlAdapter provides a means to read entities from a ResultSet.
*
* @author Per Minborg
* @param type for which mapping shall be carried out
* @since 3.0.23
*/
@InjectKey(SqlAdapter.class)
public interface SqlAdapter {
/**
* Returns the TableIdentifier for this SqlAdapter.
*
* @return the TableIdentifier for this SqlAdapter
*/
TableIdentifier identifier();
/**
* Returns an entity mapper for this SqlAdapter. The entity mapper will
* start reading form the first column in the ResultSet.
*
* @return an entity mapper for this SqlAdapter
*/
SqlFunction entityMapper();
/**
* Returns an entity mapper for this SqlAdapter. The entity mapper will
* start reading form the first column plus the given {@code offset} in the
* ResultSet. This is usable for ResultSets obtained from joined operations.
*
* @param offset to add when reading columns from the ResultSet
* @return an entity mapper for this SqlAdapter.
*
* @throws IllegalArgumentException if the given {@code offset } is
* negative.
*/
SqlFunction entityMapper(int offset);
}