Skip to content

Commit 19158a3

Browse files
ResultIterator: Apply Suggestion changes
Co-Authored-By: David Négrier <[email protected]>
1 parent 9f0bd28 commit 19158a3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ DAOs, Beans and ResultIterators
2424

2525
When you [installed TDBM](install.md), you spent some time configuring a connection to your database and then, you generated the DAOs, beans and resultIterators.
2626

27-
There will be roughly **one class (DAO, Bean, ResultIterator) per table**, in fact only ManyToMany link tables won't get their class.
27+
There will be roughly **one class (DAO, Bean, ResultIterator) per table**, in fact only ManyToMany link tables won't get their classes.
2828

2929
Each time your database model changes (if you add a new table, a new column, an index or a foreign key...), you will need to regenerate those DAOs, beans and resultIterators.
3030

@@ -40,7 +40,7 @@ This instance will allow you to easily update your data using setters and getter
4040

4141
### ResultIterators
4242

43-
A ResultIterator will represent the result of a query. It will allow you to specify it.
43+
A ResultIterator object represents the result of a query. It is an iterable object. You can use it to paginate through the results, sort the results or (in the future) filter the results.
4444

4545
Usage sample
4646
------------
@@ -185,7 +185,7 @@ generated 4 classes:
185185
column of the "users" table. It is generated by TDBM and you should never modify this class.
186186
- `User`: this class extends `AbstractUser`. If you have some custom getters and setters, you should implement them in this class. You can
187187
edit it as TDBM will never overwrite it.
188-
- `AbstractUserResultIterator`: the resultIterator representing a query on the "users" table. This class contains methods to specify you query.
188+
- `AbstractUserResultIterator`: the resultIterator representing a query on the "users" table. This class contains methods to filter/sort/paginate your query.
189189
It is generated by TDBM and you should never modify this class.
190190
- `UserResultIterator`: this class extends `AbstractUserResultIterator`. If you have some custom function to narrow down your queries you should implement them in this class. You can
191191
edit it as TDBM will never overwrite it.

0 commit comments

Comments
 (0)