StrataFrame Forum » StrataFrame Application Framework - V1 » Business Objects and Data Access (How do I?) » Adding Custom Fields To BO Datatable

Adding Custom Fields To BO Datatable

Tim Dol — Thu, 29 Oct 2009 12:46:55 GMT

I've seen a forum post on this before but can't seem to locate it.

I want to add a few temporary fields to a business object's datatable on a row by row basis to store status information but can't seem to get it to work properly at runtime. I don't want to add the fields to the database table, just to the business object.

Any help would be appreciated.

Thanks,
Tim

RE: Adding Custom Fields To BO Datatable

Greg McGuffey — Thu, 29 Oct 2009 12:46:55 GMT

Glad you got it working!

RE: Adding Custom Fields To BO Datatable

Tim Dol — Thu, 29 Oct 2009 08:47:05 GMT

Thanks guys, your examples helped solve my problem.

RE: Adding Custom Fields To BO Datatable

Greg McGuffey — Wed, 28 Oct 2009 10:41:56 GMT

Tim,

One last thing that might make life easier. You can use your query that fills the BO to make that extra column. I.e. extending the example

SELECT
-- First three columns are all "official" columns and will be saved by the BO
cs_FirstName,
cs_LastName,
cs_ID,
-- Any number of "extra" columns can be added as needed.
FALSE AS cs_Processed, -- this adds a column to underlying datatable with a default value
0 AS cs_Status -- Example of a couple more added columns, an int and a string
'P' As cs_StatusDisplay
FROM Customers

Using this method, you can then use either of the methods Dustin described to access/change the data.

RE: Adding Custom Fields To BO Datatable

Dustin Taylor — Wed, 28 Oct 2009 09:28:04 GMT

Yep, what Edhy said :).

If you explicitly don't want a strong-typed property, then you can use the methods I described in my original post, and reference bo.CurrentRow.Item("yourcolumname") to get or set it. Since it isn't explicitely defined in the BO, it won't save back to the database. If you do want to use a strong-typed property (which is generally much cleaner), then you'll want to add it to the FieldsToExcludeFromUpdate as Edhy mentioned to prevent it from saving back to the database.

Thanks Edhy. Sadly, the Mexican Circus got another Strong Man and weren't interested in a Bearded Lady, so I had to come back ;).

RE: Adding Custom Fields To BO Datatable

Edhy Rijo — Wed, 28 Oct 2009 09:00:23 GMT

Hi Tim,

You can have your cs_Processed field in the table and it will be created in the BO, then you can add cs_Processed to the BO.FieldsToExcludeFromUpdate property so it won't be updated.

Or as Dustin suggested, you can have a Custom Field Property in your BO, then use it normaly as any other field, and no data will be save back since it is not binded to anything.

Other suggestion is that if you allow your users to set the cs_Processed flag, then you can use a ListView with its CheckBoxes property True and then this will add a checkbox on the first column where you can check and then you can use the ListView.CheckedItems.Count > 0 to see which one have been checked and process your records.

RE: Adding Custom Fields To BO Datatable

Tim Dol — Wed, 28 Oct 2009 08:44:02 GMT

Dustin,

The second option is close. I want to add the column to the datatable and be able to populate it like any other field on the business object, except it won't get saved. I don't need to populate the new field after filling the object.

Example: I want to add a boolean field to the internal datatable called 'cs_Processed'.

I want to be able to set the field cs_Processed = True as I process the rows somewhere in a update routine. After the update is done, I want to loop through the business object and check to see what rows were not processed correctly, cs_Processed = False.

Hope that helps clarify.

Thanks,
Tim

RE: Adding Custom Fields To BO Datatable

Edhy Rijo — Wed, 28 Oct 2009 08:37:23 GMT

Hi Dustin,

Very good explanation, thanks!

BTW, glad to see you back in town :P

RE: Adding Custom Fields To BO Datatable

Dustin Taylor — Wed, 28 Oct 2009 08:31:40 GMT

Sounds like you want to add a column to your BO but [i]not[/i] expose it using a strong-typed property. You have two options here:

1) Return the column in your SQL query that fills the BO

2) Stuff the values into the BO in .NET after it gets filled

[b]First Option[/b]

If those fields would be present in your query, you can just include them in it and they will be accessible on the row, but not exposed through a strong-typed property.

So, if you have a "Customer" BO with "cs_FirstName", "cs_LastName", and "cs_ID", but want to add a calculated status column of "cs_Status", then you could formulate your SQL query like this:

[code]SELECT
    cs_FirstName,
    cs_LastName,
    cs_ID,
    (your calculation query here) AS cs_Status
FROM Customers[/code]

Once you use that to fill your BO, you can access that status column by referring to the current row:

[code]CType(MyCustomerBO.CurrentRow.Item("cs_Status"), String)[/code]

Note that since it isn't strong typed, you will probably want to specify the type when you reference that column by using a CType.

[b]Second Option[/b]

For the second option, the cleanest thing would probably be to create a method to add the values for you. The method is basically going to take the internal datatable of the business object, add a column, and then populate that column for each item in the BO. Again you'll want to do this [i]after[/i] the BO gets populated:

[code]Private Sub CalculateStatus(ByRef dt As DataTable)
   '-- Establish Locals
   Dim MyStatus As String = ""

   '-- Add column
   dt.Columns.Add(New DataColumn("cs_Status))

   '-- Iterate through the rows and set the status
   For Each row As DataRow In dt.Rows
      MyStatus = [i]*Your Status Calculation Here*[/i]
      row.Item("cs_Status") = MyStatus
   Next
End Sub[/code]

You would then call that method by passing over the datatable:

[code]CalculateStatus(MyCustomersBO.CurrentDataTable)[/code]

And would reference the resulting status item in the same way as if you had passed the value back from SQL:

[code]CType(MyCustomerBO.CurrentRow.Item("cs_Status"), String)[/code]

RE: Adding Custom Fields To BO Datatable

Tim Dol — Wed, 28 Oct 2009 07:18:59 GMT

I should add that I DO NOT want these fields to show up when I bind the business object to a grid. They should stay hidden.