Add CSV data module Implementation for Ballerina

[SasinduDilshara]

Purpose

Fixes: ballerina-platform/ballerina-library#6225
Fixes ballerina-platform/ballerina-library#6874

Following are the public apis for the module

# Converts CSV string to subtype of record array.
#
# + s - Source CSV string value
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseStringToRecord(string s, parseToRecordOption options = {}, typedesc<record{}[]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Converts byte[] to subtype of record array.
#
# + s - Source CSV byte array
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseBytesToRecord(byte[] s, parseToRecordOption options = {}, typedesc<record{}[]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Converts CSV byte-block-stream to subtype of record array.
#
# + s - Source CSV byte-block-stream
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseStreamToRecord(stream<byte[], error?> s,
            parseToRecordOption options = {}, typedesc<record{}[]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Converts CSV string to subtype of anydata[][].
#
# + s - Source CSV string value
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseStringToList(string s, ParseOption options = {}, typedesc<anydata[][]> t = <>)
       returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Converts byte[] to subtype of anydata[][].
#
# + s - Source CSV byte array
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseBytesToList(byte[] s, ParseOption options = {}, typedesc<anydata[][]> t = <>)
       returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Converts CSV byte-block-stream to subtype of anydata[][].
#
# + s - Source CSV byte-block-stream
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseStreamToList(stream<byte[], error?> s,
            ParseOption options = {}, typedesc<anydata[][]> t = <>)
       returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Convert value of type record{}[] to subtype of record{}[].
#
# + s - Source Ballerina record array value
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, returns value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseRecordAsRecordType(record{}[] s,
            RecordAsRecordOption options = {}, typedesc<record{}[]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Convert value of type record{}[] to subtype of anydata[][].
#
# + s - Source Ballerina record array value
# + headerNames - The order of the header names in the source
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, returns value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseRecordAsListType(record{}[] s, string[] headerNames,
            Options options = {}, typedesc<anydata[][]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Convert value of type string[][] to subtype of record{}[].
#
# + s - Source Ballerina string array of array value
# + customHeaders - The order of the header names in the source
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, returns value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseListAsRecordType(string[][] s, string[]? customHeaders = (),
            ListAsRecordOption options = {}, typedesc<record{}[]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

# Convert value of type string[][] to subtype of anydata[][].
#
# + s - Source Ballerina string array of array value
# + options - Options to be used for filtering in the projection
# + t - Target type
# + return - On success, returns value belonging to the given target type, else returns an `csv:Error` value.
public isolated function parseListAsListType(string[][] s, ListAsListOption options = {}, typedesc<anydata[][]> t = <>)
      returns t|Error = @java:Method {'class: "io.ballerina.stdlib.data.csvdata.csv.Native"} external;

[SasinduDilshara]

@SasinduDilshara better to update gradlePluginVersion in the gradle.properties file to 2.2.4 or higher. There was an issue in gradle clean task which resulted including -SNAPSHOT jars in published github packages. ballerina-platform/plugin-gradle#138

Updated

[SasinduDilshara]

Reply to #4 (comment)

I think it is better to have false, since other vendors also use like that

[MaryamZi]

Reply to #4 (comment)

I think it is better to have false, since other vendors also use like that

Where it makes sense, IMO, we can (and should) use the ideal way supported by Ballerina. Some other frameworks may have different types/APIs because it is not possible to do this way.

[heshanpadmasiri]

Few minor nits other than that LGTM

[github-actions]

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.