This is an automated email from the git hooks/post-receive script. New commit to branch feature/3860_introduce_topiasqlbatchsupport in repository topia. See http://git.nuiton.org/topia.git commit 7d394c1abbd7a34a45b3b2d9677c663795de74a7 Author: Tony CHEMIT <chemit@codelutin.com> Date: Fri Jan 8 13:42:26 2016 +0100 Add javadoc --- .../topia/service/sql/batch/SqlRequests.java | 2 + .../service/sql/batch/TopiaSqlBatchService.java | 52 ++++++++++++++++++++++ .../batch/TopiaSqlBatchServiceConfiguration.java | 8 ++++ .../service/sql/batch/tables/TopiaSqlTable.java | 2 + .../service/sql/batch/tables/TopiaSqlTables.java | 2 + .../sql/batch/tables/TopiaSqlTablesFactory.java | 2 + 6 files changed, 68 insertions(+) diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/SqlRequests.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/SqlRequests.java index b67afe4..07d0894 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/SqlRequests.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/SqlRequests.java @@ -41,6 +41,8 @@ import java.nio.file.Path; import java.util.Iterator; /** + * A {@link SqlRequests} is a container of requests. + * * Created on 04/01/16. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchService.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchService.java index 3e97c14..aa312c8 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchService.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchService.java @@ -37,30 +37,82 @@ import org.nuiton.topia.service.sql.batch.actions.UpdateTablesRequest; */ public interface TopiaSqlBatchService extends TopiaService { + /** + * @return the service configuration. + */ TopiaSqlBatchServiceConfiguration getConfiguration(); + /** + * @return Starts a new {@link SqlRequests} builder. + */ SqlRequests.Builder requestBuilder(); + /** + * @return Starts a new {@link CreateSchemaRequest} builder. + */ CreateSchemaRequest.Builder createSchemaRequestBuilder(); + /** + * @return Starts a new {@link DropSchemaRequest} builder. + */ DropSchemaRequest.Builder dropSchemaRequestBuilder(); + /** + * @return Starts a new {@link ReplicateTablesRequest} builder. + */ ReplicateTablesRequest.Builder replicateTablesRequestBuilder(); + /** + * @return Starts a new {@link UpdateTablesRequest} builder. + */ UpdateTablesRequest.Builder updateTablesRequestBuilder(); + + /** + * @return Starts a new {@link DeleteTablesRequest} builder. + */ DeleteTablesRequest.Builder deleteTablesRequestBuilder(); + /** + * Execute a {@link SqlRequests}. + * + * @param requests the request to execute + */ void execute(SqlRequests requests); + /** + * Execute a {@link CreateSchemaRequest}. + * + * @param request the request to execute + */ void execute(CreateSchemaRequest request); + /** + * Execute a {@link DropSchemaRequest}. + * + * @param request the request to execute + */ void execute(DropSchemaRequest request); + /** + * Execute a {@link ReplicateTablesRequest}. + * + * @param request the request to execute + */ void execute(ReplicateTablesRequest request); + /** + * Execute a {@link UpdateTablesRequest}. + * + * @param request the request to execute + */ void execute(UpdateTablesRequest request); + /** + * Execute a {@link DeleteTablesRequest}. + * + * @param request the request to execute + */ void execute(DeleteTablesRequest request); } diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchServiceConfiguration.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchServiceConfiguration.java index b889c8b..e7770a2 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchServiceConfiguration.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/TopiaSqlBatchServiceConfiguration.java @@ -23,6 +23,8 @@ package org.nuiton.topia.service.sql.batch; */ /** + * Configuration of the {@link TopiaSqlBatchService}. + * <p> * Created on 05/01/16. * * @author Tony Chemit - chemit@codelutin.com @@ -35,8 +37,14 @@ public class TopiaSqlBatchServiceConfiguration { public static final int DEFAULT_READ_FETCH_SIZE = 1000; public static final int DEFAULT_WRITE_BATCH_SIZE = 1000; + /** + * The fetch size used by read statements. + */ protected int readFetchSize = DEFAULT_READ_FETCH_SIZE; + /** + * The batch size used by write statements. + */ protected int writeBatchSize = DEFAULT_WRITE_BATCH_SIZE; public int getReadFetchSize() { diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTable.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTable.java index fd04e9e..e493e15 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTable.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTable.java @@ -28,6 +28,8 @@ import com.google.common.collect.ImmutableSet; import java.util.Objects; /** + * This object represents a sql table. + * * Created on 30/12/15. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTables.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTables.java index 5498284..c99f63e 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTables.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTables.java @@ -37,6 +37,8 @@ import java.util.Objects; import java.util.TreeMap; /** + * A container of {@link TopiaSqlTable}. + * * Created on 01/01/16. * * @author Tony Chemit - chemit@codelutin.com diff --git a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTablesFactory.java b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTablesFactory.java index 9c4e489..0ee5d12 100644 --- a/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTablesFactory.java +++ b/topia-service-sql-batch/src/main/java/org/nuiton/topia/service/sql/batch/tables/TopiaSqlTablesFactory.java @@ -34,6 +34,8 @@ import java.util.LinkedHashSet; import java.util.Set; /** + * A factory of {@link TopiaSqlTables}. + * * Created on 04/01/16. * * @author Tony Chemit - chemit@codelutin.com -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.