Skip to content

Commit cfa0874

Browse files
kazuki43zookazuki43zoo
committed
Update document
See gh-1130 gh-1134
1 parent 6576938 commit cfa0874

File tree

5 files changed

+24
-21
lines changed

5 files changed

+24
-21
lines changed

‎src/site/es/xdoc/java-api.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,8 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
445445
<li><code>&lt;select&gt;</code></li>
446446
</ul>
447447
</td>
448-
<td>Estas anotaciones SQL alternativas te permiten especificar un nombre de clases y un método que devolverán la SQL que debe ejecutarse. Cuando se ejecute el método MyBatis instanciará la clase y ejecutará el método especificados en el provider. You can pass objects that passed to arguments of a mapper method, "Mapper interface type" and "Mapper method"
448+
<td>Estas anotaciones SQL alternativas te permiten especificar un nombre de clases y un método que devolverán la SQL que debe ejecutarse (Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
449+
Cuando se ejecute el método MyBatis instanciará la clase y ejecutará el método especificados en el provider. You can pass objects that passed to arguments of a mapper method, "Mapper interface type" and "Mapper method"
449450
via the <code>ProviderContext</code>(available since MyBatis 3.4.5 or later) as method argument.(In MyBatis 3.4 or later, it's allow multiple parameters) Atributos: type, method. El atributo type es el nombre completamente cualificado de una clase. El method es el nombre un método de dicha clase. Nota: A continuación hay una sección sobre la clase, que puede ayudar a construir SQL dinámico de una forma más clara y sencilla de leer.</td>
450451
</tr>
451452
<tr>
@@ -524,7 +525,7 @@ Company getCompanyById(Integer id);</source>
524525
List<User> getUsersByName(String name);
525526
526527
class UserSqlBuilder {
527-
public String buildGetUsersByName(final String name) {
528+
public static String buildGetUsersByName(final String name) {
528529
return new SQL(){{
529530
SELECT("*");
530531
FROM("users");
@@ -544,7 +545,7 @@ List<User> getUsersByName(
544545
class UserSqlBuilder {
545546
546547
// If not use @Param, you should be define same arguments with mapper method
547-
public String buildGetUsersByName(
548+
public static String buildGetUsersByName(
548549
final String name, final String orderByColumn) {
549550
return new SQL(){{
550551
SELECT("*");
@@ -555,7 +556,7 @@ class UserSqlBuilder {
555556
}
556557
557558
// If use @Param, you can define only arguments to be used
558-
public String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
559+
public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
559560
return new SQL(){{
560561
SELECT("*");
561562
FROM("users");

‎src/site/ja/xdoc/java-api.xml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,8 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
464464
<li><code>&lt;select&gt;</code></li>
465465
</ul>
466466
</td>
467-
<td>これらのアノテーションは動的 SQL を生成するためのものです。実行時に指定されたメソッドが呼び出され、メソッドから返された SQL ステートメントが実行されます。マップドステートメントを実行する際、プロバイダーによって指定したクラスのインスタンスが作成され、指定されたメソッドが実行されます。
467+
<td>これらのアノテーションは動的 SQL を生成するためのものです。実行時に指定されたメソッドが呼び出され、メソッドから返された SQL ステートメントが実行されます (MyBatis 3.4.6以降では、メソッドの返り値として <code>String</code> ではなく <code>CharSequence</code> を指定することができます)。
468+
マップドステートメントを実行する際、プロバイダーによって指定したクラスのインスタンスが作成され、指定されたメソッドが実行されます。
468469
なお、メソッド引数にはMapperメソッドの引数に渡したオブジェクトに加え、<code>ProviderContext</code>(MyBatis 3.4.5以降で利用可能)を介して「Mapperインタフェースの型」と「Mapperメソッド」を渡すことができます。(MyBatis 3.4以降では、複数の引数を渡すことができます)
469470
キー: <code>type</code>, <code>method</code>. <code>type</code> にはクラスオブジェクト、<code>method</code> にはメソッド名を指定します。 <span class="label important">NOTE</span> 次の章で、クリーンで可読性の高いコードで動的 SQL を構築するためのクラスについて説明します。
470471
</td>
@@ -541,7 +542,7 @@ Company getCompanyById(Integer id);</source>
541542
List<User> getUsersByName(String name);
542543
543544
class UserSqlBuilder {
544-
public String buildGetUsersByName(final String name) {
545+
public static String buildGetUsersByName(final String name) {
545546
return new SQL(){{
546547
SELECT("*");
547548
FROM("users");
@@ -561,7 +562,7 @@ List<User> getUsersByName(
561562
class UserSqlBuilder {
562563
563564
// @Paramを使わない場合は, Mapperメソッドと同じ引数で定義する必要があります。
564-
public String buildGetUsersByName(
565+
public static String buildGetUsersByName(
565566
final String name, final String orderByColumn) {
566567
return new SQL(){{
567568
SELECT("*");
@@ -572,7 +573,7 @@ class UserSqlBuilder {
572573
}
573574
574575
// @Paramを使う場合は, 必要な引数のみ定義することができます。
575-
public String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
576+
public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
576577
return new SQL(){{
577578
SELECT("*");
578579
FROM("users");

‎src/site/ko/xdoc/java-api.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
579579
<li><code>&lt;select&gt;</code></li>
580580
</ul>
581581
</td>
582-
<td>실행시 SQL 을 리턴할 클래스 과 메소드명을 명시하도록 해주는 대체수단의 애노테이션이다.
582+
<td>실행시 SQL 을 리턴할 클래스 과 메소드명을 명시하도록 해주는 대체수단의 애노테이션이다 (Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
583583
매핑된 구문을 실행할 때 마이바티스는 클래스의 인스턴스를 만들고 메소드를 실행한다.
584584
Mapper 메서드의 인수인 "Mapper interface type" 과 <code>ProviderContext</code>(Mybatis 3.4.5 부터) 를 이용한 "Mapper method" 로 전달 된 객체를 메서드 매개변수로 전달할 수 있다.(마이바티스 3.4이상에서는 복수 파라미터를 허용한다.)
585585
사용가능한 속성들 : type, method.
@@ -676,7 +676,7 @@ Company getCompanyById(Integer id);</source>
676676
List<User> getUsersByName(String name);
677677
678678
class UserSqlBuilder {
679-
public String buildGetUsersByName(final String name) {
679+
public static String buildGetUsersByName(final String name) {
680680
return new SQL(){{
681681
SELECT("*");
682682
FROM("users");
@@ -696,7 +696,7 @@ List<User> getUsersByName(
696696
class UserSqlBuilder {
697697
698698
// @Param애노테이션을 사용하지 않으면 매퍼 메소드와 동일한 인자를 정의해야만 한다.
699-
public String buildGetUsersByName(
699+
public static String buildGetUsersByName(
700700
final String name, final String orderByColumn) {
701701
return new SQL(){{
702702
SELECT("*");
@@ -707,7 +707,7 @@ class UserSqlBuilder {
707707
}
708708
709709
// @Param애노테이션을 사용한다면, 오직 사용할 인자만 정의할 수 있다.
710-
public String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
710+
public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
711711
return new SQL(){{
712712
SELECT("*");
713713
FROM("users");

‎src/site/xdoc/java-api.xml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -496,8 +496,9 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
496496
</ul>
497497
</td>
498498
<td>Allows for creation of dynamic SQL. These alternative SQL annotations allow you to specify a class and
499-
a method name that will return the SQL to run at execution time. Upon executing the mapped statement, MyBatis will
500-
instantiate the class, and execute the method, as specified by the provider.
499+
a method name that will return the SQL to run at execution time
500+
(Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
501+
Upon executing the mapped statement, MyBatis will instantiate the class, and execute the method, as specified by the provider.
501502
You can pass objects that passed to arguments of a mapper method, "Mapper interface type" and "Mapper method"
502503
via the <code>ProviderContext</code>(available since MyBatis 3.4.5 or later) as method argument.
503504
(In MyBatis 3.4 or later, it's allow multiple parameters)
@@ -595,7 +596,7 @@ Company getCompanyById(Integer id);</source>
595596
List<User> getUsersByName(String name);
596597
597598
class UserSqlBuilder {
598-
public String buildGetUsersByName(final String name) {
599+
public static String buildGetUsersByName(final String name) {
599600
return new SQL(){{
600601
SELECT("*");
601602
FROM("users");
@@ -615,7 +616,7 @@ List<User> getUsersByName(
615616
class UserSqlBuilder {
616617
617618
// If not use @Param, you should be define same arguments with mapper method
618-
public String buildGetUsersByName(
619+
public static String buildGetUsersByName(
619620
final String name, final String orderByColumn) {
620621
return new SQL(){{
621622
SELECT("*");
@@ -626,7 +627,7 @@ class UserSqlBuilder {
626627
}
627628
628629
// If use @Param, you can define only arguments to be used
629-
public String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
630+
public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
630631
return new SQL(){{
631632
SELECT("*");
632633
FROM("users");

‎src/site/zh/xdoc/java-api.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,7 @@ resultSets=””。
747747
这些可选的 SQL 注解允许你指定一个
748748
类名和一个方法在执行时来返回运行
749749
允许创建动态
750-
的 SQL。
750+
的 SQL (Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type)。
751751
基于执行的映射语句,
752752
MyBatis
753753
会实例化这个类,然后执行由 provider
@@ -860,7 +860,7 @@ Company getCompanyById(Integer id);</source>
860860
List<User> getUsersByName(String name);
861861
862862
class UserSqlBuilder {
863-
public String buildGetUsersByName(final String name) {
863+
public static String buildGetUsersByName(final String name) {
864864
return new SQL(){{
865865
SELECT("*");
866866
FROM("users");
@@ -880,7 +880,7 @@ List<User> getUsersByName(
880880
class UserSqlBuilder {
881881
882882
// If not use @Param, you should be define same arguments with mapper method
883-
public String buildGetUsersByName(
883+
public static String buildGetUsersByName(
884884
final String name, final String orderByColumn) {
885885
return new SQL(){{
886886
SELECT("*");
@@ -891,7 +891,7 @@ class UserSqlBuilder {
891891
}
892892
893893
// If use @Param, you can define only arguments to be used
894-
public String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
894+
public static String buildGetUsersByName(@Param("orderByColumn") final String orderByColumn) {
895895
return new SQL(){{
896896
SELECT("*");
897897
FROM("users");

0 commit comments

Comments
 (0)