Skip to content

Commit f73e5d3

Browse files
authored
Merge pull request #1378 from CodeingBoy/doc-errors-fix
Fix and improvement for docs
2 parents bee7ba2 + 1fef6f9 commit f73e5d3

File tree

5 files changed

+41
-37
lines changed

5 files changed

+41
-37
lines changed

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ SqlSessionFactory factory = builder.build(configuration);</source>
158158
SqlSession openSession(boolean autoCommit)
159159
SqlSession openSession(Connection connection)
160160
SqlSession openSession(TransactionIsolationLevel level)
161-
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
161+
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
162162
SqlSession openSession(ExecutorType execType)
163163
SqlSession openSession(ExecutorType execType, boolean autoCommit)
164164
SqlSession openSession(ExecutorType execType, Connection connection)
@@ -195,12 +195,6 @@ int insert(String statement, Object parameter)
195195
int update(String statement, Object parameter)
196196
int delete(String statement, Object parameter)]]></source>
197197
<p>La diferencia entre selectOne y selectList es que selectOne debe devolver sólo un objeto. Si hay más de uno se lanzará una excepción. Si no hay ninguno se devolverá null. Si no sabes cuantos objetos esperas recibir, usa selectList. Si quieres comprobar la existencia de un objeto sería mejor que devuelvas un count(). SelectMap es un caso especial diseñado para convertir una lista de resultados en un Map basado en las propiedades de los objetos recibidos. Como no todas las sentencias requieren un parámetro, estos métodos han sido sobrecargados de forma que se proporcionan versiones que no reciben el parámetro objeto.</p>
198-
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
199-
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
200-
for (MyEntity entity:entities) {
201-
// process one entity
202-
}
203-
}]]></source>
204198
<p>El valor devuelto por los métodos insert, update and delete indica el número de filas afectadas por la sentencia.</p>
205199
<source><![CDATA[<T> T selectOne(String statement)
206200
<E> List<E> selectList(String statement)
@@ -209,6 +203,13 @@ int delete(String statement, Object parameter)]]></source>
209203
int insert(String statement)
210204
int update(String statement)
211205
int delete(String statement)]]></source>
206+
207+
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
208+
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
209+
for (MyEntity entity:entities) {
210+
// process one entity
211+
}
212+
}]]></source>
212213

213214
<p>Finalmente hay tres versiones avanzadas de los métodos select que te permiten restringir el rango de filas devueltas, o proporcionar lógica de tratamiento de resultados personalizada, normalmente para grandes cantidades de datos.</p>
214215
<source><![CDATA[<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ SqlSessionFactory factory = builder.build(configuration);</source>
159159
SqlSession openSession(boolean autoCommit)
160160
SqlSession openSession(Connection connection)
161161
SqlSession openSession(TransactionIsolationLevel level)
162-
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
162+
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
163163
SqlSession openSession(ExecutorType execType)
164164
SqlSession openSession(ExecutorType execType, boolean autoCommit)
165165
SqlSession openSession(ExecutorType execType, Connection connection)
@@ -196,12 +196,6 @@ int insert(String statement, Object parameter)
196196
int update(String statement, Object parameter)
197197
int delete(String statement, Object parameter)]]></source>
198198
<p>selectOne と selectList の違いは、selectOne は1つのオブジェクトまたは null を返さなくてはならないということです。複数のオブジェクトが返されると例外が発生します。結果のオブジェクト数が未知の場合は selectList を使用してください。オブジェクトが存在するかどうかを確認したいのなら、カウント結果(0 or 1)を返すようにした方が良いでしょう。selectMap は、結果のリストを mapKey で指定したプロパティに基づいたマップに格納して返す特殊なメソッドです。<br />ステートメントの引数は不要な場合もあるので、parameter オブジェクトの引数を持たないオーバーロードメソッドも用意されています。</p>
199-
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
200-
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
201-
for (MyEntity entity:entities) {
202-
// process one entity
203-
}
204-
}]]></source>
205199
<p>insert, update, delete の各メソッドは、ステートメントの実行によって影響を受けた行数を返します。</p>
206200
<source><![CDATA[<T> T selectOne(String statement)
207201
<E> List<E> selectList(String statement)
@@ -211,6 +205,13 @@ int insert(String statement)
211205
int update(String statement)
212206
int delete(String statement)]]></source>
213207

208+
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
209+
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
210+
for (MyEntity entity:entities) {
211+
// process one entity
212+
}
213+
}]]></source>
214+
214215
<p>最後に、高度な処理を行うための select メソッドがあります。これらは主に非常に大きなデータセットを扱う場合に、返される行の範囲を限定したり、カスタムの ResultHandler を使って独自に結果処理を行うことができるようになっています。</p>
215216
<source><![CDATA[<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)
216217
<T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds)

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ SqlSessionFactory factory = builder.build(configuration);</source>
199199
SqlSession openSession(boolean autoCommit)
200200
SqlSession openSession(Connection connection)
201201
SqlSession openSession(TransactionIsolationLevel level)
202-
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
202+
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
203203
SqlSession openSession(ExecutorType execType)
204204
SqlSession openSession(ExecutorType execType, boolean autoCommit)
205205
SqlSession openSession(ExecutorType execType, Connection connection)
@@ -260,12 +260,6 @@ int delete(String statement, Object parameter)]]></source>
260260
selectMap은 결과 목록을 Map으로 변환하기 위해 디자인된 특별한 경우이다.
261261
이 경우 결과 객체의 프로퍼티 중 하나를 키로 사용하게 된다.
262262
모든 구문이 파라미터를 필요로 하지는 않기 때문에 파라미터 객체를 요구하지 않는 형태로 오버로드되었다.</p>
263-
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
264-
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
265-
for (MyEntity entity:entities) {
266-
// process one entity
267-
}
268-
}]]></source>
269263
<p>insert, update 그리고 delete 메소드에 의해 리턴되는 값은 실행된 구문에 의해 영향을 받은 레코드수를 표시한다. </p>
270264
<source><![CDATA[<T> T selectOne(String statement)
271265
<E> List<E> selectList(String statement)
@@ -275,6 +269,13 @@ int insert(String statement)
275269
int update(String statement)
276270
int delete(String statement)]]></source>
277271

272+
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
273+
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
274+
for (MyEntity entity:entities) {
275+
// process one entity
276+
}
277+
}]]></source>
278+
278279
<p>마지막으로 리턴되는 데이터의 범위를 제한하거나 결과를 핸들링 하는 로직을 부여할 수 있는 3개의 select 메소드가 있다.</p>
279280

280281
<source><![CDATA[<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)

src/site/xdoc/java-api.xml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ SqlSessionFactory factory = builder.build(configuration);</source>
157157
SqlSession openSession(boolean autoCommit)
158158
SqlSession openSession(Connection connection)
159159
SqlSession openSession(TransactionIsolationLevel level)
160-
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
160+
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
161161
SqlSession openSession(ExecutorType execType)
162162
SqlSession openSession(ExecutorType execType, boolean autoCommit)
163163
SqlSession openSession(ExecutorType execType, Connection connection)
@@ -201,13 +201,6 @@ int insert(String statement, Object parameter)
201201
int update(String statement, Object parameter)
202202
int delete(String statement, Object parameter)]]></source>
203203
<p>The difference between selectOne and selectList is only in that selectOne must return exactly one object or null (none). If any more than one, an exception will be thrown. If you don't' know how many objects are expected, use selectList. If you want to check for the existence of an object, you're better off returning a count (0 or 1). The selectMap is a special case in that it is designed to convert a list of results into a Map based on one of the properties in the resulting objects. Because not all statements require a parameter, these methods are overloaded with versions that do not require the parameter object.</p>
204-
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
205-
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
206-
for (MyEntity entity:entities) {
207-
// process one entity
208-
}
209-
}]]></source>
210-
211204
<p>The value returned by the insert, update and delete methods indicate the number of rows affected by the statement.</p>
212205
<source><![CDATA[<T> T selectOne(String statement)
213206
<E> List<E> selectList(String statement)
@@ -216,7 +209,14 @@ int delete(String statement, Object parameter)]]></source>
216209
int insert(String statement)
217210
int update(String statement)
218211
int delete(String statement)]]></source>
219-
212+
213+
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
214+
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
215+
for (MyEntity entity:entities) {
216+
// process one entity
217+
}
218+
}]]></source>
219+
220220
<p>Finally, there are three advanced versions of the select methods that allow you to restrict the range of rows to return, or provide custom result handling logic, usually for very large data sets.</p>
221221
<source><![CDATA[<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)
222222
<T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds)

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ SqlSessionFactory factory = builder.build(configuration);</source>
162162
SqlSession openSession(boolean autoCommit)
163163
SqlSession openSession(Connection connection)
164164
SqlSession openSession(TransactionIsolationLevel level)
165-
SqlSession openSession(ExecutorType execType,TransactionIsolationLevel level)
165+
SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)
166166
SqlSession openSession(ExecutorType execType)
167167
SqlSession openSession(ExecutorType execType, boolean autoCommit)
168168
SqlSession openSession(ExecutorType execType, Connection connection)
@@ -204,12 +204,6 @@ int update(String statement, Object parameter)
204204
int delete(String statement, Object parameter)]]></source>
205205
 <p>selectOne 和 selectList 的不同仅仅是 selectOne 必须返回一个对象或 null 值。如果返回值多于一个,那么就会抛出异常。如果你不知道返回对象的数量,请使用 selectList。如果需要查看返回对象是否存在,可行的方案是返回一个值即可(0 或 1)。selectMap 稍微特殊一点,因为它会将返回的对象的其中一个属性作为 key 值,将对象作为 value 值,从而将多结果集转为 Map 类型值。因为并不是所有语句都需要参数,所以这些方法都重载成不需要参数的形式。
206206
 </p>
207-
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
208-
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
209-
for (MyEntity entity:entities) {
210-
// process one entity
211-
}
212-
}]]></source>
213207
<p>The value returned by the insert, update and delete methods indicate the number of rows affected by the statement.</p>
214208
<source><![CDATA[<T> T selectOne(String statement)
215209
<E> List<E> selectList(String statement)
@@ -219,6 +213,13 @@ int insert(String statement)
219213
int update(String statement)
220214
int delete(String statement)]]></source>
221215

216+
<p>A Cursor offers the same results as a List, except it fetches data lazily using an Iterator.</p>
217+
<source><![CDATA[try (Cursor<MyEntity> entities = session.selectCursor(statement, param)) {
218+
for (MyEntity entity:entities) {
219+
// process one entity
220+
}
221+
}]]></source>
222+
222223
 <p>最后,还有 select 方法的三个高级版本,它们允许你限制返回行数的范围,或者提供自定义结果控制逻辑,这通常在数据集合庞大的情形下使用。
223224
</p>
224225
<source><![CDATA[<E> List<E> selectList (String statement, Object parameter, RowBounds rowBounds)

0 commit comments

Comments
 (0)