Skip to content

Commit

Permalink
GenDoc Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ljlclark committed Dec 27, 2023
1 parent 28bf08a commit 57d8072
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 55 deletions.
51 changes: 1 addition & 50 deletions CoreAssemblies/LJCDBClientLib/LJCDBClientLib/Doc/DataManager.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,61 +8,12 @@
Provides standard message data manipulation methods.
(DE)
</summary>
<link file="DataManagerDoc.html">Overview</link>
<remarks>
<para>
The Data Manager is the client code that creates a table specific
&lt;span class="userType">LJCDBMessage.DbRequest&lt;/span>
object. It then serializes the
&lt;span class="userType">DbRequest&lt;/span>
object into a Request XML message to pass to the
&lt;span class="userType">LJCDBServiceLib.DbService.Execute()&lt;/span>
method or directly to the
&lt;span class="commonType">LJCDBDataAccess.DbDataAccess.Execute()&lt;/span>
method.
</para>
<para>
The DataManager object creates the contained BaseDefinition collection
when the DataManager is created. The BaseDefinition is an
&lt;span class="commonType">LJCNetCommon.DbColumns&lt;/span>
collection which contains the column definitions for the base table. Each
element
&lt;span class="userType">DbColumn&lt;/span>
contains the table ColumnName, PropertyName, Caption, DataTypeName and
MaxLength. These column definitions are retrieved from the database.
</para>
<para>
The contained DataDefinition collection is also created at this time. This
enables adding Calculated and Join columns to a grid columns configuration.
</para>
<para>
The
&lt;span class="commonType">DbColumn.Caption&lt;/span>
is initially set to the same value as the ColumnName as that is how it is
returned from ADO.NET. The PropertyName is initially set to the same value
as the ColumnName if the
&lt;span class="userType">DbColumn&lt;/span>
is initialized with a blank PropertyName value. These values can be modified
later as required.
</para>
<para>
The BaseDefinition is used to create the
&lt;span class="userType">DbColumn&lt;/span>
objects that are defined in a
&lt;span class="userType">DbRequest&lt;/span>
object. These objects are then used to create the SQL Statements that are
executed to perform the requested data operation.
</para>
<para>
The Data methods are Add(), Delete(), ExecuteClientSql(), Load,
LoadProcedure(), Retrieve() and Update().
</para>
<para>
The Data methods create a
&lt;span class="userType">DbRequest&lt;/span>
object and pass it to the
&lt;span class="commonType">ExecuteRequest()&lt;/span>
method.
</para>
</remarks>
<example>
<para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@
<Content Include="Doc\DataManager.xml">
<SubType>Designer</SubType>
</Content>
<Content Include="Doc\DataManagerDoc.html" />
<Content Include="Doc\DbManager.xml" />
<Content Include="Doc\DbServiceProxy.xml" />
<Content Include="Doc\DbServiceRef.xml">
Expand Down
2 changes: 0 additions & 2 deletions CoreUtilities/LJCGenDoc/LJCGenDoc/LJCGenDoc.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@
</ItemGroup>
<ItemGroup>
<None Include="App.config" />
<None Include="bin\Debug\LJCCodeDoc.cmd" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\LJCDocObjLib\LJCDocObjLib.csproj">
Expand All @@ -104,7 +103,6 @@
<Content Include="bin\Debug\CodeDoc.css" />
<Content Include="bin\Debug\ConnectionTemplates.xml" />
<Content Include="bin\Debug\DataConfigs.xml" />
<Content Include="bin\Debug\LJCCodeDoc.xml" />
<Content Include="bin\Debug\RootHead.html" />
<Content Include="bin\Debug\Templates\AssemblyTemplate.html" />
<Content Include="bin\Debug\Templates\FieldTemplate.html" />
Expand Down
2 changes: 1 addition & 1 deletion CoreUtilities/LJCGenDoc/LJCGenDocLib/GenAssembly.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ CreateAssemblyXml createAssemblyXml
else
{
// Testing
//if ("LJCNetCommon" == dataAssembly.Name)
//if ("LJCDBClientLib" == dataAssembly.Name)
//{
// NetFile.CreateFolder("XMLFiles");
// File.WriteAllText(dataFileSpec, dataXml);
Expand Down
3 changes: 2 additions & 1 deletion CoreUtilities/LJCGenDoc/LJCGenDocLib/GenType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ public void GenTypePage(string[] templateLines)
else
{
// Testing
//if ("NetCommon" == DataType.Name)
//if ("DataAccess" == DataType.Name
// || "DataManager" == DataType.Name)
//{
// NetFile.CreateFolder("XMLFiles");
// File.WriteAllText(dataFileSpec, dataXml);
Expand Down

0 comments on commit 57d8072

Please sign in to comment.