5
\$\begingroup\$

Is there a way to do this using parameters so the value is automatically converted to whatever datatype the keyfield has in the datatable?

This code should be reusable for future bulk update applications hence the constant and the check on multiple datatypes.

private const string DBKEYFIELDNAME = "CustomerNr";

...    
for (int i = 1; i <= csvLines.Length - 1; i++) // i=1 => skip header line
{
    string[] csvFieldsArray = csvLines[i].Split(';');
    int indexKeyField = csvHeaders.IndexOf(CSVKEYFIELDNAME.ToLower());

    object csvKeyValue = csvFieldsArray[indexKeyField];

    // ... some more code here that is not relevant

    // Find the matching row for our csv keyfield value
    Type keyType = parameters.DataTableOriginal.Columns[DBKEYFIELDNAME].DataType;
    DataRow[] rowsOriginal = null;
    if (keyType.IsAssignableFrom(typeof(string)))
        rowsOriginal = parameters.DataTableOriginal.Select(DBKEYFIELDNAME + "='" + csvKeyValue.ToString() + "'");
    else if (keyType.IsAssignableFrom(typeof(Int16)) || keyType.IsAssignableFrom(typeof(Int32)) || keyType.IsAssignableFrom(typeof(Int64)) || keyType.IsAssignableFrom(typeof(bool)))
        rowsOriginal = parameters.DataTableOriginal.Select(DBKEYFIELDNAME + "=" + csvKeyValue);

    if (rowsOriginal != null && rowsOriginal.Length == 1)
    {
        // Do some processing of the row here
    }
}
\$\endgroup\$
  • \$\begingroup\$ @Peter, where did csvKeyValue come from? Who generates it? Do you have control over it? From its name, it sounds like it was read from a csv file at some point, and whoever read it also converted it to a string, int, or bool. Is that correct? And how is it passed in to this chunk of code? As an object? Is this code in a separate method? If so, consider posting the signature of this method. \$\endgroup\$ – Saeed Feb 16 '11 at 8:35
  • \$\begingroup\$ It's quite a big method so I'd rather not as it takes the focus of the code I want reviewed, I'll update my question with more info on the csvKeyValue variable. \$\endgroup\$ – Peter Feb 16 '11 at 8:50
  • \$\begingroup\$ Okay... The datatype is always going to be a string in the CSV... I still need to write some logic to get the datatype of the matching column in the DataTableOriginal. \$\endgroup\$ – Peter Feb 16 '11 at 8:55
  • \$\begingroup\$ What is DBSLEUTELVELDNAAM? \$\endgroup\$ – Michael K Feb 16 '11 at 14:06
  • 3
    \$\begingroup\$ Is i <= csvLines.Length - 1 idiomatic in this codebase? I think most people would consider i < csvLines.Length more idiomatic, and the fewer surprises the better. \$\endgroup\$ – Peter Taylor Feb 19 '11 at 12:32
6
\$\begingroup\$

A few comments:

  • This method does way too much. It is difficult to understand and will be difficult to debug and maintain. Break it down into smaller methods that each have a single responsibility.
  • Use curly braces after your if and else statements. This improves readability of the code and makes it less likely for other code to sneak in there in the future.
  • Can't your else statement just be a plain else with no if after it? It seems like you want to put quotes around a string, and use the plain value for everything else. Are there other requirements here?
  • The type of csvKeyValue could just be string, since it's pulling a value out of a string[]
  • No need for the call to .ToString() in your if branch
  • I would try to write the call to parameters.DataTableOriginal.Select only once. Consider using your if/else to set a delimeter variable to either string.Empty or ', then write your query once like so:

    DataRow[] rowsOriginal = parameters.DataTableOriginal.Select(
        DBSLEUTELVELDNAAM + "=" + delimeter + csvKeyValue + delimeter);
    
\$\endgroup\$
  • \$\begingroup\$ I agree on all point except for using brackets on the if statement. Especially when just using it to set a delimiter variable as you suggested. But that's personal opinion. Thanks for the pointers! I will split this method into different pieces as you are right, it is big and clunky. And you've only seen one 5th of it :-) \$\endgroup\$ – Peter Feb 16 '11 at 9:39
5
\$\begingroup\$

I noticed this code: parameters.DataTableOriginal.Select(DBKEYFIELDNAME + "='" + csvKeyValue.ToString() + "'"). Just putting quotes around an user-input screams SQL Injection to me.

The problem is that your code assumes that csvKeyValue has no quotes in it. That assumption is never checked anywhere, while csvKeyValue is read from an external file so cannot be trusted.

Suppose the csvKeyValue equals "a' or TRUE or 'x' ='x". Do you really want to execute that select?

Although I cannot judge whether this is a real danger, I thought I should mention it.

\$\endgroup\$
3
\$\begingroup\$

Yup, that method does definitely need breaking down into smaller pieces.

You may like to use an iterator method to loop through the lines. Something along the lines of :

IEnumerable<string> EachCSVKey(string[] csvLines)
{
    int indexKeyField = csvHeaders.IndexOf(CSVKEYFIELDNAME.ToLower());

    for (int i = 1; i <= csvLines.Length - 1; i++) // i=1 => skip header line
    {
        string[] csvFieldsArray = csvLines[i].Split(';');
        yield return csvFieldsArray[indexKeyField];
    }
}

Then in your method :

foreach ( var csvKeyValue in EachCSVKey ( csvLines) )
{ 
  ...

I find (in my opinion) that this makes the intent clearer.

Note also you should get the indexKeyField value outside of the loop. This value won't change, and so it is unnecessary to keep getting it.

\$\endgroup\$
  • \$\begingroup\$ It looks cleaner but it can't be as performant because you are looping the entire csv twice? \$\endgroup\$ – Peter Feb 17 '11 at 8:00
  • 2
    \$\begingroup\$ No, you only loop once - thats the clever part! Each time the EachCSVKey method hits the "yield return" statement it will transfer control to the calling methods foreach loop. When the calling foreach loop finishes an iteration, it returns control to the EachCSVKey method. This continues until EachCSVKey finishes its loop or the calling loop calls "break". \$\endgroup\$ – Mongus Pong Feb 17 '11 at 12:03
2
\$\begingroup\$

Just one small comment in addition to those provided by Saeed and Mongus, you have defined a constant called CSVKEYFIELDNAME but in the only place it is (shown to be) used, you call ToLower() on it. Should the constant be provided as lower case to begin with, or should you be doing a case insensitive search?

\$\endgroup\$
  • \$\begingroup\$ Well, the thing is, the csvheaders array has received a tolower upon initialisation. I do a tolower on the constant to allow someone to change the value into a readable string without having to know it needs to be in lowercase always. \$\endgroup\$ – Peter Feb 18 '11 at 7:26
  • \$\begingroup\$ @Peter, sounds like a case insensitive search is in order then :). Ultimately it's up to you, creating a new string and preforming multiple case insensitive string comparisons will both have performance impacts, though which is greater would probably depend on the number of columns you are comparing against. in any case, you might want to consider the effects of culture settings on your comparisons (stackoverflow.com/questions/2256453/…). \$\endgroup\$ – Brian Reichle Feb 18 '11 at 10:08
  • \$\begingroup\$ @Peter, this is C#, isn't it? So make the string a const and then wrap it in a property which does the ToLower() and you get the best of both worlds. \$\endgroup\$ – Peter Taylor Feb 19 '11 at 12:34
0
\$\begingroup\$

Is there a way to do this using parameters so the value is automatically converted to whatever datatype the keyfield has in the datatable?

You could use something like this:

object csvKeyValue = Convert.ChangeType(csvKeyValue, keyType);

to convert a string to the type of the datatable column.

\$\endgroup\$
0
\$\begingroup\$

Prefer var in for loop variable initializers:

for (int i = 1; i <= csvLines.Length - 1; i++)

Should be

for (var i = 1; i <= csvLines.Length - 1; i++)
\$\endgroup\$

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.