Skip to content

Commit 2785900

Browse files
mbernemannmbernemann
committed
Update docu to 5.7.0 and add JS Api subs as modules and Typescript
1 parent 383d1e3 commit 2785900

File tree

200 files changed

+39364
-35674
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+39364
-35674
lines changed

‎build.gradle‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,28 @@ task buildTutorial(type: AsciidoctorTask) {
7373
}
7474
}
7575

76+
/**
77+
* Collect js Api subs and TypeScript .d.ts type files
78+
*/
79+
task zipJsApiStubs(type: Zip) {
80+
from '../BCD-UI/Docu/build/jsApiStubs'
81+
archiveFileName = "bcduiApiStubs-${getProperty('bcdui.version')}.zip"
82+
destinationDirectory = file('resources')
83+
}
84+
task zipTypescriptApi(type: Zip) {
85+
from '../BCD-UI/Docu/build/tsTypes'
86+
archiveFileName = "bcduiTsTypes-${getProperty('bcdui.version')}.zip"
87+
destinationDirectory = file('resources')
88+
}
89+
7690
//*********************************************
7791
// This collects BCD-UI docu (tutorial, js-api, java-api) to /docs
7892
// The resulting structure is aligned with GitHub
7993
// This task requires BCD-UI cloned next to BCD-UI-Docu and task bcduiBuildDocu being executed there already
8094
// GitHub pages is setup to use /docs
8195
task updateDocs( type: Copy ) {
8296
group 'bcdui'
83-
dependsOn buildTutorial
97+
dependsOn buildTutorial, zipJsApiStubs, zipTypescriptApi
8498

8599
def bcduiDocuFolder = '../BCD-UI/Docu/build/htmldocs'
86100

@@ -103,9 +117,7 @@ task updateDocs( type: Copy ) {
103117
from( '../BCD-UI/Docu/xsd' ) {
104118
into 'xsd'
105119
}
106-
from( '../BCD-UI/Docu/build/jsApiStubs/bcduiApiStubs.js' ) {
107-
into 'resources'
108-
}
120+
109121

110122
// Replace version and date placeholders
111123
doLast {

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ <h3>Our Company</h3>
158158

159159
<script>
160160
<!-- Dynamically replace version and date when displayed to keep sources as stable as possible -->
161-
document.querySelector(".bcd-dyn-replace-current-version-date").textContent = "5.6.0 (2025-07-16)";
161+
document.querySelector(".bcd-dyn-replace-current-version-date").textContent = "5.7.0 (2025-12-24)";
162162
</script>
163163

164164
</html>

‎docs/javadoc/allclasses-index.html‎

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
107107
</div>
108108
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/web/AuthenticationListener.html" title="class in de.businesscode.bcdui.web">AuthenticationListener</a></div>
109109
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
110-
<div class="block">Support for bcd_log_login logging as well as further security enhancement, such as session-fixation {@link https://owasp.org/www-community/attacks/Session_fixation}</div>
110+
<div class="block">Support for bcd_log_login logging as well as further security enhancement, such as session-fixation, see <a href="https://owasp.org/www-community/attacks/Session_fixation">OWASP Session_fixation</a></div>
111111
</div>
112112
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/subjectsettings/config/AuthenticationType.html" title="class in de.businesscode.bcdui.subjectsettings.config">AuthenticationType</a></div>
113113
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -782,18 +782,19 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
782782
</div>
783783
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/SqlFromFullSelect.html" title="class in de.businesscode.bcdui.wrs.load">SqlFromFullSelect</a></div>
784784
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
785-
<div class="block">Takes the parent node of SELECTs with SET operators (formally a "full-select") in Wrq format
786-
and generates SQL from it together with the bound variables, ready to be executed</div>
785+
<div class="block">Mainly handles SET operators like UNION and calls SqlFromSubSelect for each select.</div>
787786
</div>
788787
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/SqlFromSubSelect.html" title="class in de.businesscode.bcdui.wrs.load">SqlFromSubSelect</a></div>
789788
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
790-
<div class="block">Takes a single wrq:Select (formally a "sub-select") and turns it into a SQLStatementWithParams</div>
789+
<div class="block">Takes a single wrq:Select (formally a "sub-select") and turns it into a SQLStatementWithParams
790+
Each select taking part in UNIONs or being a sub-select is represented by an instance of this class.</div>
791791
</div>
792792
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/web/accessLogging/SqlLogAppender.html" title="class in de.businesscode.bcdui.web.accessLogging">SqlLogAppender</a></div>
793793
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
794794
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/SQLStatementWithParams.html" title="class in de.businesscode.bcdui.wrs.load">SQLStatementWithParams</a></div>
795795
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
796-
<div class="block">Represents part of an SQL string and the values for bound variables</div>
796+
<div class="block">Represents part of an SQL string and the values for bound variables
797+
Can be a single clause or a whole SQL statement</div>
797798
</div>
798799
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/logging/SqlToDatabaseLogger.html" title="class in de.businesscode.bcdui.logging">SqlToDatabaseLogger</a></div>
799800
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -1041,8 +1042,8 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
10411042
&lt;param-value>
10421043
MY_STEP_NAME: de.my.package.ClassName;
10431044
MY_STEP_NAME2: de.my.package.ClassName2;
1044-
&lt;/param-value>
1045-
&lt;/init-param -->
1045+
&lt;/param-value>&lt;
1046+
&lt;/init-para -->
10461047
Such Steps
10471048
- need a Constructor getting (UploadControl uc, String userId)
10481049
- implement IUploadStep
@@ -1160,14 +1161,17 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
11601161
</div>
11611162
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/WrqBindingSetFromDerivedTable.html" title="class in de.businesscode.bcdui.wrs.load">WrqBindingSetFromDerivedTable</a></div>
11621163
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
1163-
<div class="block">Represents a virtual BindingSet resulting from a sub-select during the execution of a Wrq</div>
1164+
<div class="block">This class allows using a sub-select (SqlFromSubSelect) like a BindingSet
1165+
I.e., it represents its output (selected columns) as a BindingSet
1166+
Represents a virtual BindingSet resulting from a sub-select during the execution of a Wrq</div>
11641167
</div>
11651168
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/WrqBindingSetFromTableReference.html" title="class in de.businesscode.bcdui.wrs.load">WrqBindingSetFromTableReference</a></div>
11661169
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
1167-
<div class="block">Represents a virtual BindingSet resulting from the children of wrq:From, i.e. a table reference
1170+
<div class="block">This class allows using the result of JOINed table references (BindingSets, sub-selects in joins) like a BindingSet
1171+
Represents a virtual BindingSet resulting from the children of wrq:From, i.e., is a table reference
11681172
A table reference can be a plain table name or joined tables factors,
11691173
i.e. table names, derived table expressions or references to CTE
1170-
Mostly it deals with the handling of wrq:Join, but for consistency we also take care for cases without</div>
1174+
Mostly it deals with the handling of wrq:Join, but for consistency it also takes care of cases without</div>
11711175
</div>
11721176
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/WrqBindingSetRef.html" title="class in de.businesscode.bcdui.wrs.load">WrqBindingSetRef</a></div>
11731177
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -1195,7 +1199,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
11951199
</div>
11961200
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/WrqInfo.html" title="class in de.businesscode.bcdui.wrs.load">WrqInfo</a></div>
11971201
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
1198-
<div class="block">Collects knowledge about the Wrq.</div>
1202+
<div class="block">The worker companion of a SqlFromSubSelect.</div>
11991203
</div>
12001204
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/wrs/load/WrqQueryBuilder.html" title="class in de.businesscode.bcdui.wrs.load">WrqQueryBuilder</a></div>
12011205
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -1290,7 +1294,20 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
12901294
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/util/XPathUtils.html" title="class in de.businesscode.util">XPathUtils</a></div>
12911295
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
12921296
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/web/servlets/ZipDownload.html" title="class in de.businesscode.bcdui.web.servlets">ZipDownload</a></div>
1293-
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
1297+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
1298+
<div class="block">Class to provide zipping and downloading a specified number of files
1299+
which need to be accessible via ResourceServlet (which also provides the secured access)
1300+
Files are specified via a config
1301+
&lt;Vfs xmlns="http://www.businesscode.de/schema/bcdui/vfs-1.0.0">
1302+
&lt;Zip>
1303+
&lt;Folder name="folder1">
1304+
&lt;File name="/vfs/documents/ace9e8e7-548a-4410-aa52-c57fb32e34fa/xf"/>
1305+
&lt;/Folder>
1306+
&lt;Folder .... />
1307+
&lt;/Zip>
1308+
&lt;/Vfs>
1309+
As an alternative, you can also provide a scope/instance pair instead of a path name.</div>
1310+
</div>
12941311
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="de/businesscode/bcdui/web/servlets/ZipLet.html" title="class in de.businesscode.bcdui.web.servlets">ZipLet</a></div>
12951312
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
12961313
<div class="block">Servlet for compression and uncompression of XML data.</div>

‎docs/javadoc/de/businesscode/bcdui/binding/BindingUtils.html‎

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,17 @@ <h2>Method Summary</h2>
118118
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addTableAlias(java.util.List,java.util.List)" class="member-name-link">addTableAlias</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;sCE,
119119
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;tableAliases)</code></div>
120120
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
121-
<div class="block">Use output of splitColumnExpression to prepend table alias to column expressions
121+
<div class="block">Use output of splitColumnExpression to prepend table alias to column-expressions
122122
Column expressions prefixed with SimpleBindingItem.BCD_NO_TABLE_ALIAS by the user are excluded from this
123-
the user has to assure that this is only used in an unambiguous statement when using this in a join.</div>
123+
the user has to ensure that this is only used in an unambiguous statement when using this in a join.</div>
124124
</div>
125125
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
126+
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isDecimal(int)" class="member-name-link">isDecimal</a><wbr>(int&nbsp;jdbcType)</code></div>
127+
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
128+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
129+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isDecimal(java.lang.String)" class="member-name-link">isDecimal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;typeName)</code></div>
130+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
131+
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
126132
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isNumeric(int)" class="member-name-link">isNumeric</a><wbr>(int&nbsp;jdbcType)</code></div>
127133
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
128134
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
@@ -188,10 +194,10 @@ <h3>splitColumnExpression</h3>
188194
<h3>addTableAlias</h3>
189195
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">addTableAlias</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;sCE,
190196
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;tableAliases)</span></div>
191-
<div class="block">Use output of splitColumnExpression to prepend table alias to column expressions
197+
<div class="block">Use output of splitColumnExpression to prepend table alias to column-expressions
192198
Column expressions prefixed with SimpleBindingItem.BCD_NO_TABLE_ALIAS by the user are excluded from this
193-
the user has to assure that this is only used in an unambiguous statement when using this in a join.
194-
This is the case for example if the column refers to another table than the one assigned to this BindingSet
199+
the user has to ensure that this is only used in an unambiguous statement when using this in a join.
200+
This is the case, for example, if the column refers to another table than the one assigned to this BindingSet
195201
or for mySequence.nextval expressions (this, referring to a global name, needs to be prefixed with BCD_NO_TABLE_ALIAS.)</div>
196202
</section>
197203
</li>
@@ -218,7 +224,17 @@ <h3>isNumeric</h3>
218224
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isNumeric</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;typeName)</span></div>
219225
<dl class="notes">
220226
<dt>Returns:</dt>
221-
<dd>true typeName represents a numeric type</dd>
227+
<dd>true typeName represents a numeric type, including integer types</dd>
228+
</dl>
229+
</section>
230+
</li>
231+
<li>
232+
<section class="detail" id="isDecimal(java.lang.String)">
233+
<h3>isDecimal</h3>
234+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDecimal</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;typeName)</span></div>
235+
<dl class="notes">
236+
<dt>Returns:</dt>
237+
<dd>true typeName represents a decimal type, excluding integer types</dd>
222238
</dl>
223239
</section>
224240
</li>
@@ -228,7 +244,17 @@ <h3>isNumeric</h3>
228244
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isNumeric</span><wbr><span class="parameters">(int&nbsp;jdbcType)</span></div>
229245
<dl class="notes">
230246
<dt>Returns:</dt>
231-
<dd>true if jdbcType represents a numeric type</dd>
247+
<dd>true if jdbcType represents a numeric type, including integer types</dd>
248+
</dl>
249+
</section>
250+
</li>
251+
<li>
252+
<section class="detail" id="isDecimal(int)">
253+
<h3>isDecimal</h3>
254+
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isDecimal</span><wbr><span class="parameters">(int&nbsp;jdbcType)</span></div>
255+
<dl class="notes">
256+
<dt>Returns:</dt>
257+
<dd>true if jdbcType represents a decimal type, excluding integer types</dd>
232258
</dl>
233259
</section>
234260
</li>

0 commit comments

Comments
 (0)