Merge pull request #285 from domaframework/translate

Translate documents from Japanese into English

Author: nakamura-to

docs/faq.rst

@@ -8,45 +8,45 @@ Frequently Asked Questions
 General Questions
 =================
 
-What does Doma stand for?
--------------------------
+What does "Doma" mean?
+----------------------
 
-Doma stands for the **D** ao **O** riented database **MA** pping framework.
+The name "Doma" comes from the "Dao Oriented database MApping framework".
 
 What is annotation processing?
 ------------------------------
 
-Annotation processing, that is introduced in Java 6,
-allows us to validate and generate source codes at compile time.
+Annotation processing, that was introduced in Java 6,
+allows us to validate and generate source code at compile time.
 
-We use annotation processing to do followings:
+We use annotation processing to the following:
 
-- Generating meta classes from the classes annotated with ``@Entity`` and ``@Domain``
-- Generating implementation classes of the interfaces annotated with ``@Dao``
-- Validating SQL statements
+- generating meta classes from the classes annotated with ``@Entity`` and ``@Domain``;
+- generating implementation classes of the interfaces annotated with ``@Dao``; and
+- validating SQL statements.
 
 Runtime environment
 ===================
 
 Which version of JRE does Doma support?
 ---------------------------------------
 
-JRE 8、9、10 and 11.
+JRE 8, 9, 10 and 11.
 
-What libraries are required to work Doma?
------------------------------------------
+Which libraries are required for Doma to work?
+----------------------------------------------
 
-Nothing.
+None.
 
-Doma has no dependencies to other libraries.
+Doma has no dependencies on other libraries.
 
 Development environment
 =======================
 
 Which version of JDK does Doma support?
 ---------------------------------------
 
-JDK 8、9、10 and 11.
+JDK 8, 9, 10 and 11.
 
 Which IDE do you recommend?
 ---------------------------
@@ -67,7 +67,7 @@ In Eclipse, they are found in the .apt_generated directory.
 In Eclipse, where is the .apt_generated directory?
 --------------------------------------------------
 
-You can find it in the Nivigator view.
+You can find it in the Navigator view.
 
 I get the message that the sql file is not found, but it exists.
 ----------------------------------------------------------------
@@ -79,35 +79,35 @@ You may get the following message, though the file exists:
   [DOMA4019] The file[META-INF/../select.sql] is not found from the classpath
 
 When you use Eclipse, check that the location of the output folder of resources is
-same as the one of class files in the Java Build Path dialog.
+same as the one for the class files in the Java Build Path dialog.
 
 When you use Gradle, check that the resource files are copied to ``compileJava.destinationDir``
 in advance of the compileJava task. See also :ref:`build-with-gradle`.
 
 
-Features as the database access library
-=======================================
+Features as a database access library
+=====================================
 
 Does Doma generate SQL statements?
 ----------------------------------
 
-Yes, Doma generates following statements:
+Yes, Doma generates the following statements:
 
-- INSERT
-- DELETE
-- UPDATE
-- stored procedure call
-- stored function call
+- INSERT;
+- DELETE;
+- UPDATE;
+- stored procedure call; and
+- stored function call.
 
 Doma doesn't generate SELECT statements
 but executes arbitrary SELECT statements and maps the results to the Java objects.
 
-See also :doc:`query/index` for detail information.
+See also :doc:`query/index` for detailed information.
 
-How dynamic SQL statements are executed?
+How are dynamic SQL statements executed?
 ----------------------------------------
 
-The dynamic SQL statements are built by directives that are represented as the SQL comments.
+Dynamic SQL statements are built by directives that are represented by the SQL comments.
 
 See also :doc:`sql` for detail information.
 
@@ -124,5 +124,5 @@ Does Doma provide a JDBC connection pooling feature?
 No.
 
 Use Doma together with
-the JDBC connection pool library such as `HikariCP <https://github.com/brettwooldridge/HikariCP>`_.
+a JDBC connection pool library such as `HikariCP <https://github.com/brettwooldridge/HikariCP>`_.
 

docs/query/factory.rst

@@ -1,66 +1,66 @@
-==================
-ファクトリ
-==================
+=========
+Factories
+=========
 
-.. contents:: 目次
+.. contents::
    :depth: 3
 
-``java.sql.Connection`` が提供するファクトリメソッドからインスタンスを取得するには、
-Daoのメソッドに次のアノテーションを注釈します。
+To get instances from the factory methods of ``java.sql.Connection``,
+annotate DAO methods with one of following annotations;
 
-* java.sql.Arrayを生成するには、@ArrayFactory
-* java.sql.Blobを生成するには、@BlobFactory
-* java.sql.Clobを生成するには、@ClobFactory
-* java.sql.NClobを生成するには、@NClobFactory
-* java.sql.SQLXMLを生成するには、@SQLXMLFactory
+* @ArrayFactory
+* @BlobFactory
+* @ClobFactory
+* @NClobFactory
+* @SQLXMLFactory
 
-Arrayの生成
-===========
+Creating Array instances
+========================
 
-戻り値の型は ``java.sql.Array`` 、パラメータは1つの配列型でなければいけません。
-引数は ``null`` であってはいけません。
+A return type must be ``java.sql.Array`` and the number of parameters must be one.
+The parameter type must be an array type and the parameter must not be null.
 
-``@ArrayFactory`` の ``typeName`` 要素にはデータベースの型名を指定します。
+Specify a database type name to the ``@ArrayFactory``'s ``typeName`` element:
 
 .. code-block:: java
 
   @ArrayFactory(typeName = "integer")
   Array createIntegerArray(Integer[] elements);
 
-Blobの生成
-==========
+Creating Blob instances
+=======================
 
-戻り値の型は ``java.sql.Blob`` 、パラメータの数は0でなければいけません。
+A return type must be ``java.sql.Blob`` and the number of parameters must be zero:
 
 .. code-block:: java
 
   @BlobFactory
   Blob createBlob();
 
-Clobの生成
-==========
+Creating Clob instances
+=======================
 
-戻り値の型は ``java.sql.Clob`` 、パラメータの数は0でなければいけません。
+A return type must be ``java.sql.Clob`` and the number of parameters must be zero:
 
 .. code-block:: java
 
   @ClobFactory
   Clob createClob();
 
-NClobの生成
-===========
+Creating NClob instances
+========================
 
-戻り値の型は ``java.sql.NClob`` 、パラメータの数は0でなければいけません。
+A return type must be ``java.sql.NClob`` and the number of parameters must be zero:
 
 .. code-block:: java
 
   @NClobFactory
   NClob createNClob();
 
-SQLXMLの生成
-============
+Creating SQLXML instances
+=========================
 
-戻り値の型は ``java.sql.SQLXML`` 、パラメータの数は0でなければいけません。
+A return type must be ``java.sql.SQLXML`` and the number of parameters must be zero:
 
 .. code-block:: java