Skip to content

Commit e4b87cb

Browse files
fugerit79fugerit79
authored
Merge pull request #18 from fugerit-org/feature/issue_17_pages
Feature/issue 17 pages
2 parents 7ae7b95 + fc6451d commit e4b87cb

26 files changed

+1191
-22
lines changed

‎CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
jupiterdocs.fugerit.org

‎_config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
theme: jekyll-theme-cayman

‎docgen/parameters.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"title" : "Jupiter (Fugerit Core A.P.I.)",
33
"name": "Jupiter",
4-
"version" : "8.0.0",
5-
"date" : "18/03/2023",
4+
"version" : "8.0.1",
5+
"date" : "19/03/2023",
66
"organization" : {
77
"name" : "Fugerit Org",
88
"url" : "https://www.fugerit.org"

‎docgen/release-notes.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
8.0.0 (2023-03-18)
1+
8.0.1 (2023-03-19)
2+
------------------
3+
+ [Moving github pages to main branch, documenting QueryHelper api](https://github.com/fugerit-org/fj-lib/issues/17)
4+
+ Extensions method to SelectHelper, and junit
5+
6+
8.0.0 (2023-03-18)
27
------------------
38
+ [Added config store facilities](https://github.com/fugerit-org/fj-lib/issues/14)
49
+ [Dropping the 0 version (next release will not be 0.8.14 but 8.0.0](https://github.com/fugerit-org/fj-lib/issues/15)

‎docs/daogen/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[Docs Home](../../index.md)
2+
3+
## DaoGen API reference
4+
5+
[javadoc api](https://javadoc.io/static/org.fugerit.java/fj-core/8.0.0/org/fugerit/java/core/db/daogen/package-summary.html)
6+
7+
API Tutorial :
8+
* [SelectHelper](select_helper.md)

‎docs/daogen/select_helper.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
[DaoGen API Home](index.md) | [Docs Home](../../index.md)
2+
3+
# SelectHelper
4+
5+
The SelectHelper class is basically a wrapper for parameters needed in a `java.sql.PreparedStatement`
6+
7+
8+
Here is a sample code :
9+
10+
11+
```
12+
// SelectHelper setup
13+
BasicDAOHelper<String> daoHelper = new BasicDAOHelper<>(context);
14+
SelectHelper selectHelper = daoHelper.newSelectHelper( "fugerit.address" );
15+
// select helper is basically a query builder, it is possible to add functions, instead of the simple column name
16+
String column = String.format( "UPPER(%s)" , COL_INFO ); // will add 'UPPER(INFO)'
17+
// it is possible to transform upper case the value to be compared
18+
String value = "test address 01".toUpperCase();
19+
// this will perform an ignore case comparison, as both the column and the value are now UPPERCASE
20+
selectHelper.andEqualParam( column , value );
21+
logger.info( "sql -> {}", selectHelper.getQueryContent() ); // method getQueryContent() provides access to current query buffer
22+
// the result
23+
String res = daoHelper.loadOneHelper( selectHelper, RSE_ADDRESS_COL_INFO );
24+
logger.info( "res -> {}", res );
25+
```
26+
27+
The method `selectHelper.getQueryContent()` gives access to the current query buffer.
28+
29+
You can find some examples as Junit too :
30+
* [Simple select sample](../../fj-core/src/test/java/test/org/fugerit/java/core/db/dao/daogen/TestSelectHelperSimple.java)
31+
* [Ignore case select sample](../../fj-core/src/test/java/test/org/fugerit/java/core/db/dao/daogen/TestSelectHelperUpper.java)

‎docs/validator/index.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[Docs Home](../../index.md)
2+
3+
## Validator Catalog configuration reference
4+
5+
&lt;validator-catalog/&gt; structure :
6+
7+
```
8+
+--validator-catalog
9+
+--custom-messages(*)
10+
+--entry(*)
11+
+--validator(*)
12+
+--entry(*)
13+
```
14+
15+
Configuration reference :
16+
* [validator-catalog](tag_validator-catalog.md)
17+
* [custom-messages](tag_validator-catalog_custom-messages.md)
18+
* [validator](tag_validator-catalog_validator.md)
19+
* [entry](tag_validator-catalog_entry.md)
20+
21+
Build in validators :
22+
* [BasicValidator (since 0.7.4.6)](validator_basic.md)
23+
* [ValidatorRegex (since 0.7.4.6)](validator_regex.md)
24+
* [ValidatorDate (since 0.7.4.6)](validator_date.md)
25+
* [ValidatorNumber (since 0.7.4.7)](validator_number.md)
26+
27+
Other configurations :
28+
* [Default Validator Messages](../../fj-core/src/main/resources/core/validator/validator.properties)
29+
30+
Here is a complete [sample validator catalog](../../fj-core/src/test/resources/core/validator/validator-catalog-test.xml)

‎docs/validator/tag_validator-catalog.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[Validator Catalog Home](index.md) | [Docs Home](../../index.md)
2+
3+
### &lt;validator-catalog&gt; reference <a name="top"/>
4+
5+
This is the reference for 'validator-catalog' element configuration and its attributes.
6+
7+
<table width="100%">
8+
<tr>
9+
<th colspan="2">validator-catalog attributes quick reference</th>
10+
</tr>
11+
<tr>
12+
<th width="30%">Attribute</th>
13+
<th width="70%">Description</th>
14+
</tr>
15+
<tr>
16+
<td><a href="#bundle-path">bundle-path</a></td>
17+
<td>Path to default error key properties</td>
18+
</tr>
19+
</table>
20+
21+
<br/><a href="#top">top</a><br/>
22+
23+
<table>
24+
<caption>Attribute <a name="bundle-path">bundle-path</a></caption>
25+
<tr>
26+
<th>Default</th>
27+
<td>core.validator.validator</td>
28+
</tr>
29+
<tr>
30+
<th>Example</th>
31+
<td>core.validator.validator</td>
32+
</tr>
33+
<tr>
34+
<th>Since</th>
35+
<td>0.7.4.6</td>
36+
</tr>
37+
</table>
38+
39+
<br/><a href="#top">top</a><br/>
40+

‎docs/validator/tag_validator-catalog_custom-messages.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[Validator Catalog Home](index.md) | [Docs Home](../../index.md)
2+
3+
### &lt;custom-messages&gt; reference <a name="top"/>
4+
5+
This is the reference for 'custom-messages' element configuration and its attributes.
6+
7+
<table width="100%">
8+
<tr>
9+
<th colspan="2">custom-messages attributes quick reference</th>
10+
</tr>
11+
<tr>
12+
<th width="30%">Attribute</th>
13+
<th width="70%">Description</th>
14+
</tr>
15+
<tr>
16+
<td><a href="#locale">locale</a></td>
17+
<td>Locale for override or added properties</td>
18+
</tr>
19+
</table>
20+
21+
<br/><a href="#top">top</a><br/>
22+
23+
<table>
24+
<caption>Attribute <a name="locale">locale</a></caption>
25+
<tr>
26+
<th>Default</th>
27+
<td>default</td>
28+
</tr>
29+
<tr>
30+
<th>Example</th>
31+
<td>it</td>
32+
</tr>
33+
<tr>
34+
<th>Since</th>
35+
<td>0.7.4.6</td>
36+
</tr>
37+
</table>
38+
39+
<br/><a href="#top">top</a><br/>
40+

‎docs/validator/tag_validator-catalog_entry.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[Validator Catalog Home](index.md) | [Docs Home](../../index.md)
2+
3+
### &lt;entrys&gt; reference <a name="top"/>
4+
5+
This is the reference for 'entry' element configuration and its attributes.
6+
7+
This element represents a property entry. the attribute 'key' is the key. the text content is the value.
8+
9+
<table width="100%">
10+
<tr>
11+
<th colspan="2">entry attributes quick reference</th>
12+
</tr>
13+
<tr>
14+
<th width="30%">Attribute</th>
15+
<th width="70%">Description</th>
16+
</tr>
17+
<tr>
18+
<td><a href="#key">key</a></td>
19+
<td>key for override or added properties</td>
20+
</tr>
21+
</table>
22+
23+
<br/><a href="#top">top</a><br/>
24+
25+
<table>
26+
<caption>Attribute <a name="key">key</a></caption>
27+
<tr>
28+
<th>Default</th>
29+
<td>(no default)</td>
30+
</tr>
31+
<tr>
32+
<th>Example</th>
33+
<td>regex</td>
34+
</tr>
35+
<tr>
36+
<th>Since</th>
37+
<td>0.7.4.6</td>
38+
</tr>
39+
</table>
40+
41+
<br/><a href="#top">top</a><br/>
42+

0 commit comments

Comments
 (0)