/usr/share/perl5/Data/Table.pm is in libdata-table-perl 1.75-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 | package Data::Table;
BEGIN { die "Your perl version is old, see README for instructions" if $] < 5.005; }
use strict;
use vars qw($VERSION %DEFAULTS);
use Carp;
#use Data::Dumper;
$VERSION = '1.75';
%DEFAULTS = (
"CSV_DELIMITER"=>',', # controls how to read/write CSV file
"CSV_QUALIFIER"=>'"',
"OS"=>0,
# operatoring system: 0 for UNIX (\n as linebreak), 1 for Windows
# (\r\n as linebreak), 2 for MAC (\r as linebreak)
# this controls how to read and write CSV/TSV file
"ENCODING"=>'UTF-8'
# default encoding for fromFile, fromCSV, fromTSV
);
%Data::Table::TSV_ESC = ( '0'=>"\0", 'n'=>"\n", 't'=>"\t", 'r'=>"\r", 'b'=>"\b",
"'"=>"'", '"'=>"\"", '\\'=>"\\" );
%Data::Table::TSV_ENC = ( "\0"=>'0', "\n"=>'n', "\t"=>'t', "\r"=>'r', "\b"=>'b',
"'"=>"'", "\""=>'"', "\\"=>'\\' );
use constant ROW_BASED => 0;
use constant COL_BASED => 1;
use constant NUMBER => 0;
use constant STRING => 1;
use constant ASC => 0;
use constant DESC => 1;
use constant INNER_JOIN => 0;
use constant LEFT_JOIN => 1;
use constant RIGHT_JOIN => 2;
use constant FULL_JOIN => 3;
use constant OS_UNIX => 0;
use constant OS_PC => 1;
use constant OS_MAC => 2;
sub new {
my ($pkg, $data, $header, $type, $enforceCheck) = @_;
my $class = ref($pkg) || $pkg;
$type = 0 unless defined($type);
$header=[] unless defined($header);
$data=[] unless defined($data);
$enforceCheck = 1 unless defined($enforceCheck);
confess "new Data::Table: Size of data does not match header\n"
if (($type && (scalar @$data) && $#{$data} != $#{$header}) ||
(!$type && (scalar @$data) && $#{$data->[0]} != $#{$header}));
my $colHash = checkHeader($header);
if ($enforceCheck && scalar @$data > 0) {
my $size=scalar @{$data->[0]};
for (my $j =1; $j<scalar @$data; $j++) {
confess "Inconsistent array size at data[$j]" unless (scalar @{$data->[$j]} == $size);
}
} elsif (scalar @$data == 0) {
$type = 0;
}
my $self={ data=>$data, header=>$header, type=>$type, colHash=>$colHash, OK=>[], MATCH=>[]};
return bless $self, $class;
}
sub checkHeader {
my $header = shift;
my $colHash = {};
for (my $i = 0; $i < scalar @$header; $i++) {
my $elm = $header->[$i];
#warn "Column name: $elm at column ".($i+1)." is an integer, using an integer column name will mask the corresponding column index!" if ($elm =~ /^\d+$/);
confess "Undefined column name (empty or all space) at column ".($i+1) unless $elm;
#confess "Header name ".$colHash->{$elm}." appears more than once" if defined($colHash->{$elm});
if (defined($colHash->{$elm})) {
confess "Header name ($elm) appears more than once: in column ".($colHash->{$elm}+1)." and column ".($i+1).".";
}
$colHash->{$elm} = $i;
}
return $colHash;
}
# translate a column name into its position in the header
# (also in column-based table)
sub colIndex {
my ($self, $colID) = @_;
return $self->{colHash}->{$colID} if exists $self->{colHash}->{$colID};
return $colID if $colID =~ /^\d+$/;
return -1;
#if ($colID =~ /\D/) {
# my $i = $self->{colHash}->{$colID};
# return -1 unless defined($i);
# return $i;
#}
#return $colID; # assume an index already
}
sub hasCol {
my ($self, $col) = @_;
return $self->colIndex($col) >= 0;
}
sub nofCol {
my $self = shift;
return scalar @{$self->{header}};
}
sub isEmpty {
my $self = shift;
return $self->nofCol == 0;
}
sub nofRow {
my $self = shift;
return 0 if (scalar @{$self->{data}} == 0);
return ($self->{type})?
scalar @{$self->{data}->[0]} : scalar @{$self->{data}};
}
sub lastRow {
my $self = shift;
return $self->nofRow - 1;
}
sub lastCol {
my $self = shift;
return $self->nofCol - 1;
}
sub colName {
my ($self, $colNumericIndex) = @_;
return ($self->header())[$colNumericIndex];
}
sub iterator {
my ($self, $arg_ref) = @_;
my %arg = defined $arg_ref ? %$arg_ref : ();
$arg{reverse} = 0 unless exists $arg{reverse};
my $current_row = $arg{reverse} ? $self->lastRow : 0;
return sub {
my $rowIdx = shift;
if (defined $rowIdx) { # return row index for previously returned record
my $prevRow = $arg{reverse} ? $current_row+1 : $current_row-1;
return ($prevRow<0 or $prevRow > $self->nofRow-1)? undef: $prevRow;
}
return undef if $current_row < 0 or $current_row > $self->nofRow - 1;
my $oldRow = $current_row;
$arg{reverse} ? $current_row-- : $current_row++;
return $self->rowHashRef($oldRow);
}
}
# still need to consider quotes and comma in string
# need to get csv specification
sub csvEscape {
my ($s, $arg_ref) = @_;
my ($delimiter, $qualifier) = ($Data::Table::DEFAULTS{CSV_DELIMITER}, $Data::Table::DEFAULTS{CSV_QUALIFIER});
$delimiter = $arg_ref->{'delimiter'} if (defined($arg_ref) && defined($arg_ref->{'delimiter'}));
$qualifier = $arg_ref->{'qualifier'} if (defined($arg_ref) && defined($arg_ref->{'qualifier'}));
return '' unless defined($s);
my $qualifier2 = $qualifier;
$qualifier2 = substr($qualifier, 1, 1) if length($qualifier)>1; # in case qualifier is a special symbol for regular expression
$s =~ s/$qualifier/$qualifier2$qualifier2/g;
if ($s =~ /[$qualifier$delimiter\r\n]/) { return "$qualifier2$s$qualifier2"; }
return $s;
}
sub tsvEscape {
my $s = shift;
#my %ESC = ( "\0"=>'0', "\n"=>'n', "\t"=>'t', "\r"=>'r', "\b"=>'b',
# "'"=>"'", "\""=>'"', "\\"=>'\\' );
## what about \f? MySQL treats \f as f.
return "\\N" unless defined($s);
$s =~ s/([\0\\\b\r\n\t"'])/\\$Data::Table::TSV_ENC{$1}/g;
return $s;
}
# output table in CSV format
sub csv {
my ($self, $header, $arg_ref)=@_;
my ($status, @t);
my $s = '';
my ($OS, $fileName_or_handler) = ($Data::Table::DEFAULTS{OS}, undef);
$OS = $arg_ref->{'OS'} if (defined($arg_ref) && defined($arg_ref->{'OS'}));
my ($delimiter, $qualifier) = ($Data::Table::DEFAULTS{CSV_DELIMITER}, $Data::Table::DEFAULTS{CSV_QUALIFIER});
if (defined($arg_ref)) {
$delimiter = $arg_ref->{'delimiter'} if defined($arg_ref->{'delimiter'});
$qualifier = $arg_ref->{'qualifier'} if defined($arg_ref->{'qualifier'});
$fileName_or_handler = $arg_ref->{'file'} if defined($arg_ref->{'file'});
}
my $delimiter2 = $delimiter; $delimiter2 = substr($delimiter, 1, 1) if length($delimiter)>1;
my $endl = ($OS==2)?"\r":(($OS==1)?"\r\n":"\n");
$header=1 unless defined($header);
$s=join($delimiter2, map {csvEscape($_, {delimiter=>$delimiter, qualifier=>$qualifier})} @{$self->{header}}) . $endl if $header;
###### $self->rotate if $self->{type};
if ($self->{data}) {
$self->rotate() if ($self->{type});
my $data=$self->{data};
for (my $i=0; $i<=$#{$data}; $i++) {
$s .= join($delimiter2, map {csvEscape($_, {delimiter=>$delimiter, qualifier=>$qualifier})} @{$data->[$i]}) . $endl;
}
}
if (defined($fileName_or_handler)) {
my $OUT;
my $isFileHandler = ref($fileName_or_handler) ne '';
if ($isFileHandler) {
$OUT = $fileName_or_handler;
} else {
open($OUT, "> $fileName_or_handler") or confess "Cannot open $fileName_or_handler to write.\n";
binmode $OUT;
}
print $OUT $s;
close($OUT) unless $isFileHandler;
}
return $s;
}
# output table in TSV format
sub tsv {
my ($self, $header, $arg_ref)=@_;
my ($status, @t);
my $s = '';
my ($OS, $fileName_or_handler, $transform_element) = ($Data::Table::DEFAULTS{OS}, undef, 1);
if (defined($arg_ref)) {
$OS = $arg_ref->{'OS'} if (defined($arg_ref->{'OS'}));
$fileName_or_handler = $arg_ref->{'file'} if (defined($arg_ref->{'file'}));
$transform_element = $arg_ref->{'transform_element'} if (defined($arg_ref->{'transform_element'}));
}
my $endl = ($OS==2)?"\r":(($OS==1)?"\r\n":"\n");
$header=1 unless defined($header);
if ($header) {
if ($transform_element) {
$s=join("\t", map {tsvEscape($_)} @{$self->{header}}) . $endl;
} else {
$s=join("\t",@{$self->{header}}) . $endl;
}
}
###### $self->rotate if $self->{type};
if ($self->{data}) {
$self->rotate() if ($self->{type});
my $data=$self->{data};
for (my $i=0; $i<=$#{$data}; $i++) {
if ($transform_element) {
$s .= join("\t", map {tsvEscape($_)} @{$data->[$i]}) . $endl;
} else {
$s .= join("\t", @{$data->[$i]}) . $endl;
}
}
}
if (defined($fileName_or_handler)) {
my $OUT;
my $isFileHandler = ref($fileName_or_handler) ne '';
if ($isFileHandler) {
$OUT = $fileName_or_handler;
} else {
open($OUT, "> $fileName_or_handler") or confess "Cannot open $fileName_or_handler to write.\n";
binmode $OUT;
}
print $OUT $s;
close($OUT) unless $isFileHandler;;
}
return $s;
}
# output table in HTML format
sub html {
my ($self, $colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, $portrait, $callback) = @_;
my ($s, $s_tr, $s_td, $s_th) = ("", "tr", "", "th");
my $key;
$tag_tbl = { class => "data_table" } unless (ref $tag_tbl eq 'HASH');
$tag_tr = {} unless (ref $tag_tr eq 'HASH');
$tag_th = {} unless (ref $tag_th eq 'HASH');
$tag_td = {} unless (ref $tag_td eq 'HASH');
$portrait = 1 unless defined($portrait);
my $cb=0;
if (defined($callback)) {
confess "wiki: Expecting subroutine for callback parameter!" if ref($callback) ne 'CODE';
$cb=1;
}
my $tag2str = sub {
my $tag = shift;
my $s="";
foreach my $key (keys %$tag) {
next unless $tag->{$key};
if ($key eq '') {
$s .=" ".$tag->{$key};
#for backward compatibility, in case the tag is a str
# '' => 'align="right" valign="bottom"'
} else {
$s .= " $key=\"$tag->{$key}\"";
}
}
return $s;
};
$s = "<table".$tag2str->($tag_tbl).">\n";
my $header=$self->{header};
my $l_colorByClass = 0;
my @BG_COLOR=("#D4D4BF","#ECECE4","#CCCC99");
my @CELL_CLASSES=("data_table_odd","data_table_even","data_table_header");
if (ref($colorArrayRef_or_classHashRef) eq "HASH") {
$l_colorByClass = 1;
$CELL_CLASSES[1]=$colorArrayRef_or_classHashRef->{even} if defined($colorArrayRef_or_classHashRef->{even});
$CELL_CLASSES[0]=$colorArrayRef_or_classHashRef->{odd} if defined($colorArrayRef_or_classHashRef->{odd});
$CELL_CLASSES[2]=$colorArrayRef_or_classHashRef->{header} if defined($colorArrayRef_or_classHashRef->{header});
} elsif ((ref($colorArrayRef_or_classHashRef) eq "ARRAY") && (scalar @$colorArrayRef_or_classHashRef==3)) {
@BG_COLOR=@$colorArrayRef_or_classHashRef;
}
$s_tr = $tag2str->($tag_tr);
$s_th = $tag2str->($tag_th);
if ($portrait) {
$s .= "<thead>\n";
my $clr="";
if ($l_colorByClass) {
$clr=" class=\"".$CELL_CLASSES[2]."\"" if ($CELL_CLASSES[2]);
} else {
$clr=" style=\"background-color:".$BG_COLOR[2].";\"" if ($BG_COLOR[2]);
}
$s .= "<tr$s_tr$clr>\n";
for (my $i=0; $i<=$#{$header}; $i++) {
$s .="<th". ($cb ? $tag2str->($callback->({%$tag_th}, -1, $i, $header->[$i], $self)) : $s_th) .">".$header->[$i]."</th>\n";
}
$s .="</tr>\n";
$s .= "</thead>\n";
$self->rotate() if $self->{type};
my $data=$self->{data};
$s .= "<tbody>\n";
for (my $i=0; $i<=$#{$data}; $i++) {
$clr="";
if ($l_colorByClass) {
$clr=" class=\"".$CELL_CLASSES[$i%2]."\"" if ($CELL_CLASSES[$i%2]);
} else {
$clr=" style=\"background-color:".$BG_COLOR[$i%2].";\"" if ($BG_COLOR[$i%2]);
}
$s .= "<tr$s_tr$clr>\n";
for (my $j=0; $j<=$#{$header}; $j++) {
my $td = $tag_td->{$j} || $tag_td->{$header->[$j]} || {};
my $s_td=$tag2str->($cb ? $callback->({%$td}, $i, $j, $header->[$j], $self) : $td) || "";
$s .= ($s_td)? "<td$s_td>":"<td>";
$s .= (defined($data->[$i][$j]) && $data->[$i][$j] ne '')?$data->[$i][$j]:" ";
$s .= "</td>\n";
}
$s .= "</tr>\n";
}
$s .= "</tbody>\n";
} else {
$self->rotate() unless $self->{type};
my $tag_th_def={};
if ($l_colorByClass) {
$tag_th_def->{"class"}=$CELL_CLASSES[2] if $CELL_CLASSES[2];
} else {
$tag_th_def->{"style"}="background-color:".$BG_COLOR[2].";" if $BG_COLOR[2];
}
my $merge_tag = sub {
my ($old, $usr)=@_;
foreach my $k(keys %$usr) {
if (exists $old->{$k}) {
if (!defined($usr->{k}) or $usr->{k} eq '') {
undef $old->{k};
} elsif ($k eq 'style' and (index($usr->{k}, 'background-color:')!=-1)) {
$old->{$k}=$usr->{$k};
} else {
$old->{$k}.= " "+$usr->{$k};
}
} else {
$old->{$k}=$usr->{$k} if $usr->{$k};
}
}
};
$merge_tag->($tag_th_def, $tag_th) if defined($tag_th);
$s_th=$tag2str->($tag_th_def);
my $data=$self->{data};
$s .="<tbody>\n";
for (my $i = 0; $i <= $#{$header}; $i++) {
$s .= "<tr>\n";
$s .= "<td". ($cb ? $tag2str->($callback->({%$tag_th_def}, -1, $i, $header->[$i], $self)) : $s_th) .">". $header->[$i] . "</td>\n";
my $td_def = $tag_td->{$i} || $tag_td->{$header->[$i]} || {};
$td_def = {'' => $td_def} unless ref $td_def;
for (my $j=0; $j<=$#{$data->[0]}; $j++) {
my $td = {};
if ($l_colorByClass) {
$td->{"class"}=$CELL_CLASSES[$j%2] if $CELL_CLASSES[$j%2];
} else {
$td->{"style"}="background-color:".$BG_COLOR[$j%2].";" if $BG_COLOR[$j%2];
}
$merge_tag->($td, $td_def);
my $s_td=$tag2str->($cb ? $callback->({%$td}, $j, $i, $header->[$i], $self) : $td) || "";
$s .= ($s_td)? "<td$s_td>":"<td>";
$s .= (defined($data->[$i][$j]) && $data->[$i][$j] ne '')?$data->[$i][$j]:' ';
$s .= "</td>\n";
}
$s .= "</tr>\n";
}
$s .="</tbody>\n";
}
$s .= "</table>\n";
return $s;
}
# output table in wikitable
# this method accepts the same parameters as the html() method
sub wiki {
my ($self, $colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, $portrait, $callback) = @_;
my ($s, $s_tr, $s_td, $s_th) = ("", "", "", "");
my $key;
$tag_tbl = { class => "wikitable" } unless (ref $tag_tbl eq 'HASH');
$tag_tr = {} unless (ref $tag_tr eq 'HASH');
$tag_th = {} unless (ref $tag_th eq 'HASH');
$tag_td = {} unless (ref $tag_td eq 'HASH');
$portrait = 1 unless defined($portrait);
my $cb=0;
if (defined($callback)) {
confess "wiki: Expecting subroutine for callback parameter!" if ref($callback) ne 'CODE';
$cb=1;
}
my $tag2str = sub {
my $tag = shift;
my $s="";
foreach my $key (keys %$tag) {
next unless $tag->{$key};
if ($key eq '') {
$s .=" ".$tag->{$key};
#for backward compatibility, in case the tag is a str
# '' => 'align="right" valign="bottom"'
} else {
$s .= " $key=\"$tag->{$key}\"";
}
}
return $s;
};
$s = "{|".$tag2str->($tag_tbl)."\n";
my $header=$self->{header};
my $l_colorByClass = 0;
my @BG_COLOR=("#D4D4BF","#ECECE4","#CCCC99");
my @CELL_CLASSES=("wikitable_odd","wikitable_even","wikitable_header");
if (ref($colorArrayRef_or_classHashRef) eq "HASH") {
$l_colorByClass = 1;
$CELL_CLASSES[1]=$colorArrayRef_or_classHashRef->{even} if defined($colorArrayRef_or_classHashRef->{even});
$CELL_CLASSES[0]=$colorArrayRef_or_classHashRef->{odd} if defined($colorArrayRef_or_classHashRef->{odd});
$CELL_CLASSES[2]=$colorArrayRef_or_classHashRef->{header} if defined($colorArrayRef_or_classHashRef->{header});
} elsif ((ref($colorArrayRef_or_classHashRef) eq "ARRAY") && (scalar @$colorArrayRef_or_classHashRef==3)) {
@BG_COLOR=@$colorArrayRef_or_classHashRef;
}
$s_tr = $tag2str->($tag_tr);
$s_th = $tag2str->($tag_th);
if ($portrait) {
for (my $i=0; $i<=$#{$header}; $i++) {
my $clr="";
if ($l_colorByClass) {
$clr=" class=\"".$CELL_CLASSES[2]."\"" if $CELL_CLASSES[2];
} else {
$clr=" style=\"background-color:".$BG_COLOR[2].";\"" if $BG_COLOR[2];
}
$s .= "!$s_tr$clr";
# make a copy of $tag_th to pass as a parameter
$s .= $cb ? $tag2str->($callback->({%$tag_th}, -1, $i, $header->[$i], $self)) : $s_th;
$s .= " | ".$header->[$i]."\n"; # $join(" || ", @$header)."\n";
}
$self->rotate() if $self->{type};
my $data=$self->{data};
for (my $i=0; $i<=$#{$data}; $i++) {
my $clr="";
if ($l_colorByClass) {
$clr=" class=\"".$CELL_CLASSES[$i%2]."\"" if $CELL_CLASSES[$i%2];
} else {
$clr=" style=\"background-color:".$BG_COLOR[$i%2].";\"" if $BG_COLOR[$i%2];
}
$s .= "|-$clr\n";
for (my $j=0; $j<=$#{$header}; $j++) {
my $td = $tag_td->{$j} || $tag_td->{$header->[$j]} || {};
# backward compatibility, when str is used instead of hash for $tag_td->{'col'}
$td = {'' => $td} unless ref $td;
my $s_td=$tag2str->($cb ? $callback->({%$td}, $i, $j, $header->[$j], $self) : $td) || "";
$s .= ($s_td)? "|$s_td | ":"| ";
$s .= (defined($data->[$i][$j]) && $data->[$i][$j] ne '')?$data->[$i][$j]:" ";
$s .= "\n";
}
}
} else {
$self->rotate() unless $self->{type};
my $tag_th_def={};
if ($l_colorByClass) {
$tag_th_def->{"class"}=$CELL_CLASSES[2] if $CELL_CLASSES[2];
} else {
$tag_th_def->{"style"}="background-color:".$BG_COLOR[2].";" if $BG_COLOR[2];
}
my $merge_tag = sub {
my ($old, $usr)=@_;
foreach my $k(keys %$usr) {
if (exists $old->{$k}) {
if (!defined($usr->{k}) or $usr->{k} eq '') {
undef $old->{k};
} elsif ($k eq 'style' and (index($usr->{k}, 'background-color:')!=-1)) {
$old->{$k}=$usr->{$k};
} else {
$old->{$k}.= " "+$usr->{$k};
}
} else {
$old->{$k}=$usr->{$k};
}
}
};
$merge_tag->($tag_th_def, $tag_th) if defined($tag_th);
$s_th=$tag2str->($tag_th_def);
my $data=$self->{data};
for (my $i = 0; $i <= $#{$header}; $i++) {
$s .= "|-\n";
$s .= "!";
$s .= $cb ? $tag2str->($callback->({%$tag_th_def}, -1, $i, $header->[$i], $self)) : $s_th;
$s .= " | ".$header->[$i]."\n";
my $td = $tag_td->{$i} || $tag_td->{$header->[$i]} || {};
$td = {'' => $td} unless ref $td;
for (my $j=0; $j<=$#{$data->[0]}; $j++) {
my $td_def={};
if ($l_colorByClass) {
$td_def->{"class"}=$CELL_CLASSES[$j%2] if $CELL_CLASSES[$j%2];
} else {
$td_def->{"style"}="background-color:".$BG_COLOR[$j%2].";" if $BG_COLOR[$j%2];
}
$merge_tag->($td_def, $td);
my $s_td=$tag2str->($cb ? $callback->({%$td_def}, $j, $i, $header->[$i], $self) : $td_def) || "";
$s .= ($s_td)? "|$s_td | ":"| ";
$s .= (defined($data->[$i][$j]) && $data->[$i][$j] ne '')?$data->[$i][$j]:' ';
$s .= "\n";
}
}
}
$s .= "|}\n";
return $s;
}
# output table in wikitable format, with table orientation rotated,
# so that each wikitable row is a column in the table
# This is useful for a slim table (few columns but many rows)
# The method accepts the same parameters as html2() method
sub wiki2 {
my ($self, $colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, $callback) = @_;
return $self->wiki($colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, 0, $callback);
}
# output table in HTML format, with table orientation rotated,
# so that each HTML table row is a column in the table
# This is useful for a slim table (few columns but many rows)
sub html2 {
my ($self, $colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, $callback) = @_;
return $self->html($colorArrayRef_or_classHashRef, $tag_tbl, $tag_tr, $tag_th, $tag_td, 0, $callback);
}
# apply a $fun to each elm in a col
# function only has access to one element per row
sub colMap {
my ($self, $colID, $fun) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
$self->rotate() unless $self->{type};
my $ref = $self->{data}->[$c];
my @tmp = map {scalar $fun->($_)} @$ref;
$self->{data}->[$c] = \@tmp;
return 1;
}
# apply a $fun to each row in the table
# function has access to all elements in that row
sub colsMap {
my ($self, $fun) = @_;
$self->rotate() if $self->{type};
map {&$fun} @{$self->{data}};
return 1;
}
sub addRow {
my ($self, $rowRef, $rowIdx, $arg_ref) = @_;
my %arg = defined $arg_ref ? %$arg_ref : ();
$arg{addNewCol} = 0 unless exists $arg{addNewCol};
my $numRow=$self->nofRow();
my @t;
my $myRowRef = $rowRef;
if ($arg{addNewCol}) {
if (ref $myRowRef eq 'HASH') {
foreach my $key (keys %$myRowRef) {
next if $self->colIndex($key) >= 0;
my @col = (undef) x $self->nofRow;
$self->addCol(\@col, $key);
}
} elsif (ref $myRowRef eq 'ARRAY') {
for (my $i=$self->nofCol; $i< scalar @$myRowRef; $i++) {
my @col = (undef) x $self->nofRow;
$self->addCol(\@col, "col".($i+1));
}
}
}
if (ref $myRowRef eq 'HASH') {
if ($self->isEmpty) {
my $i = 0;
foreach my $s (keys %$myRowRef) {
push @{$self->{header}}, $s;
$self->{colHash}->{$s} = $i++;
}
}
my @one = ();
my @header = $self->header;
for (my $i=0; $i< scalar @header; $i++) {
$one[$i] = $myRowRef->{$header[$i]};
}
$myRowRef = \@one;
} elsif (ref $myRowRef eq 'ARRAY') {
confess "addRow: size of added row does not match those in the table\n"
if scalar @$myRowRef != $self->nofCol();
} else {
confess "addRow: parameter rowRef has to be either an array_ref or a hash_ref\n";
}
$rowIdx=$numRow unless defined($rowIdx);
return undef unless defined $self->checkNewRow($rowIdx);
$self->rotate() if $self->{type};
my $data=$self->{data};
if ($rowIdx == 0) {
unshift @$data, $myRowRef;
} elsif ($rowIdx == $numRow) {
push @$data, $myRowRef;
} else {
@t = splice @$data, $rowIdx;
push @$data, $myRowRef, @t;
}
return 1;
}
sub delRow {
my ($self, $rowIdx ) = @_;
return undef unless defined $self->checkOldRow($rowIdx);
$self->rotate() if $self->{type};
my $data=$self->{data};
my @dels=splice(@$data, $rowIdx, 1);
return shift @dels;
}
sub delRows {
my ($self, $rowIdcsRef) = @_;
my $rowIdx;
$self->rotate() if $self->{type};
my @dels = @{$self->{data}}[@$rowIdcsRef];
my @indices = sort { $b <=> $a } @$rowIdcsRef;
#my @dels=();
foreach $rowIdx (@indices) {
#push @dels, $self->delRow($rowIdx);
$self->delRow($rowIdx);
}
return @dels;
}
# append a column to the table, input is a referenceof_array
sub addCol {
my ($self, $colRef, $colName, $colIdx) = @_;
my $numCol=$self->nofCol();
my @t;
if (!defined($colRef) || ref($colRef) eq '') {
# fill the new column with $colRef as the default value
my @col = ($colRef) x $self->nofRow;
$colRef = \@col;
} else {
confess "addCol: size of added col does not match rows in the table\n"
if @$colRef != $self->nofRow() and $numCol > 0;
}
$colIdx=$numCol unless defined($colIdx);
return undef unless defined $self->checkNewCol($colIdx, $colName);
$self->rotate() unless $self->{type};
my $data=$self->{data};
my $header=$self->{header};
if ($colIdx == 0) {
unshift @$header, $colName;
} elsif ($colIdx == $numCol) {
push @$header, $colName;
} else {
@t = splice @$header, $colIdx;
push @$header, $colName, @t;
}
if ($colIdx == 0) {
unshift @$data, $colRef;
} elsif ($colIdx == $numCol) {
push @$data, $colRef;
} else {
@t = splice @$data, $colIdx;
push @$data, $colRef, @t;
}
for (my $i = 0; $i < scalar @$header; $i++) {
my $elm = $header->[$i];
$self->{colHash}->{$elm} = $i;
}
return 1;
}
sub delCol {
my ($self, $colID) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
$self->rotate() unless $self->{type};
my $header=$self->{header};
my $name=$self->{header}->[$c];
splice @$header, $c, 1;
my $data=$self->{data};
my @dels=splice @$data, $c, 1;
delete $self->{colHash}->{$name};
for (my $i = $c; $i < scalar @$header; $i++) {
my $elm = $header->[$i];
$self->{colHash}->{$elm} = $i;
}
return shift @dels;
}
sub delCols {
my ($self, $colIDsRef) = @_;
my $idx;
my @indices = map { $self->colIndex($_) } @$colIDsRef;
$self->rotate() unless $self->{type};
my @dels = @{$self->{data}}[@indices];
@indices = sort { $b <=> $a } @indices;
#my @dels=();
foreach my $colIdx (@indices) {
$self->delCol($colIdx);
}
return @dels;
}
sub rowRef {
my ($self, $rowIdx) = @_;
return undef unless defined $self->checkOldRow($rowIdx);
$self->rotate if $self->{type};
return $self->{data}->[$rowIdx];
}
sub rowRefs {
my ($self, $rowIdcsRef) = @_;
$self->rotate if $self->{type};
return $self->{data} unless defined $rowIdcsRef;
my @ones = ();
my $rowIdx;
foreach $rowIdx (@$rowIdcsRef) {
push @ones, $self->rowRef($rowIdx);
}
return \@ones;
}
sub row {
my ($self, $rowIdx) = @_;
my $data = $self->{data};
return undef unless defined $self->checkOldRow($rowIdx);
if ($self->{type}) {
my @one=();
for (my $i = 0; $i < scalar @$data; $i++) {
push @one, $data->[$i]->[$rowIdx];
}
return @one;
} else {
return @{$data->[$rowIdx]};
}
}
sub rowHashRef {
my ($self, $rowIdx) = @_;
my $data = $self->{data};
return undef unless defined $self->checkOldRow($rowIdx);
my $header=$self->{header};
my $one = {};
for (my $i = 0; $i < scalar @$header; $i++) {
$one->{$header->[$i]} = ($self->{type})?
$self->{data}->[$i]->[$rowIdx]:$self->{data}->[$rowIdx]->[$i];
}
return $one;
}
sub colRef {
my ($self, $colID) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
$self->rotate() unless $self->{type};
return $self->{data}->[$c];
}
sub colRefs {
my ($self, $colIDsRef) = @_;
$self->rotate unless $self->{type};
return $self->{data} unless defined $colIDsRef;
my @ones = ();
my $colID;
foreach $colID (@$colIDsRef) {
push @ones, $self->colRef($colID);
}
return \@ones;
}
sub col {
my ($self, $colID) = @_;
my $data = $self->{data};
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
if (!$self->{type}) {
my @one=();
for (my $i = 0; $i < scalar @$data; $i++) {
push @one, $data->[$i]->[$c];
}
return @one;
} else {
return () unless ref($data->[$c]) eq "ARRAY";
return @{$data->[$c]};
}
}
sub rename {
my ($self, $colID, $name) = @_;
my $oldName;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
$oldName=$self->{header}->[$c];
return if ($oldName eq $name);
return undef unless defined $self->checkNewCol($c, $name);
$self->{header}->[$c]=$name;
# $self->{colHash}->{$oldName}=undef; # undef still keeps the entry, use delete instead!
delete $self->{colHash}->{$oldName};
$self->{colHash}->{$name}=$c;
return 1;
}
sub replace{
my ($self, $oldColID, $newColRef, $newName) = @_;
my $oldName;
my $c=$self->checkOldCol($oldColID);
return undef unless defined $c;
$oldName=$self->{header}->[$c];
$newName=$oldName unless defined($newName);
unless ($oldName eq $newName) {
return undef unless defined $self->checkNewCol($c, $newName);
}
confess "New column size ".(scalar @$newColRef)." must be ".$self->nofRow() unless (scalar @$newColRef==$self->nofRow());
$self->rename($c, $newName);
$self->rotate() unless $self->{type};
my $old=$self->{data}->[$c];
$self->{data}->[$c]=$newColRef;
return $old;
}
sub swap{
my ($self, $colID1, $colID2) = @_;
my $c1=$self->checkOldCol($colID1);
return undef unless defined $c1;
my $c2=$self->checkOldCol($colID2);
return undef unless defined $c2;
my $name1=$self->{header}->[$c1];
my $name2=$self->{header}->[$c2];
$self->{header}->[$c1]=$name2;
$self->{header}->[$c2]=$name1;
$self->{colHash}->{$name1}=$c2;
$self->{colHash}->{$name2}=$c1;
$self->rotate() unless $self->{type};
my $data1=$self->{data}->[$c1];
my $data2=$self->{data}->[$c2];
$self->{data}->[$c1]=$data2;
$self->{data}->[$c2]=$data1;
return 1;
}
sub moveCol {
my ($self, $colID, $colIdx, $newColName) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
confess "New column location out of bound!" unless ($colIdx >= 0 && $colIdx < $self->nofCol);
return if $c == $colIdx;
my $colName = $self->{header}->[$c];
my $col = $self->delCol($colID);
$self->addCol($col, $colName, $colIdx);
$self->rename($colIdx, $newColName) if defined $newColName;
return 1;
}
sub checkOldRow {
my ($self, $rowIdx) = @_;
my $maxIdx=$self->nofRow()-1;
unless (defined $rowIdx) {
print STDERR " Invalid row index in call to checkOldRow\n";
return undef;
}
if ($rowIdx<0 || $rowIdx>$maxIdx) {
print STDERR "Row index out of range [0..$maxIdx]" ;
return undef;
}
return $rowIdx;
}
sub checkNewRow {
my ($self, $rowIdx) = @_;
my $maxIdx=$self->nofRow()-1;
unless (defined $rowIdx) {
print STDERR "Invalid row index: $rowIdx \n";
return undef;
}
$maxIdx+=1;
if ($rowIdx<0 || $rowIdx>$maxIdx) {
print STDERR "Row index out of range [0..$maxIdx]" ;
return undef;
}
return $rowIdx;
}
sub checkOldCol {
my ($self, $colID) = @_;
my $c=$self->colIndex($colID);
if ($c < 0) {
print STDERR "Invalid column $colID";
return undef;
}
return $c;
}
sub checkNewCol {
my ($self, $colIdx, $colName) = @_;
my $numCol=$self->nofCol();
unless (defined $colIdx) {
print STDERR "Invalid column index $colIdx";
return undef;
}
if ($colIdx<0 || $colIdx>$numCol) {
print STDERR "Column index $colIdx out of range [0..$numCol]";
return undef;
}
if (defined $self->{colHash}->{$colName} ) {
print STDERR "Column name $colName already exists" ;
return undef;
}
unless ($colName =~ /\D/) {
print STDERR "Invalid column name $colName" ;
return undef;
}
return $colIdx;
}
sub elm {
my ($self, $rowIdx, $colID) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
return undef unless defined $self->checkOldRow($rowIdx);
return ($self->{type})?
$self->{data}->[$c]->[$rowIdx]:
$self->{data}->[$rowIdx]->[$c];
}
sub elmRef {
my ($self, $rowIdx, $colID) = @_;
my $c=$self->checkOldCol($colID);
return undef unless defined $c;
return undef unless defined $self->checkOldRow($rowIdx);
return ($self->{type})?
\$self->{data}->[$c]->[$rowIdx]:
\$self->{data}->[$rowIdx]->[$c];
}
sub setElm {
my ($self, $rowIdx, $colID, $val) = @_;
$rowIdx = [$rowIdx] if ref($rowIdx) eq '';
$colID = [$colID] if ref($colID) eq '';
foreach my $col (@$colID) {
my $c=$self->checkOldCol($col);
return undef unless defined $c;
foreach my $row (@$rowIdx) {
return undef unless defined $self->checkOldRow($row);
if ($self->{type}) {
$self->{data}->[$c]->[$row]=$val;
} else {
$self->{data}->[$row]->[$c]=$val;
}
}
}
return 1;
}
# convert the internal structure of a table between row-based and column-based
sub rotate {
my $self=shift;
my $newdata=[];
my $data=$self->{data};
$self->{type} = ($self->{type})?0:1;
if ($self->{type} && scalar @$data == 0) {
for (my $i=0; $i < $self->nofCol; $i++) {
$newdata->[$i] = [];
}
} else {
for (my $i=$#{$data->[0]}; $i>=0; $i--) {
for (my $j=$#{$data}; $j>=0; $j--) {
$newdata->[$i][$j]=$data->[$j][$i];
}
}
}
$self->{data}=$newdata;
return 1;
}
sub header {
my ($self, $header) = @_;
unless (defined($header)) {
return @{$self->{header}};
} else {
if (scalar @$header != scalar @{$self->{header}}) {
confess "Header array should have size ".(scalar @{$self->{header}});
} else {
my $colHash = checkHeader($header);
$self->{header} = $header;
$self->{colHash} = $colHash;
}
}
}
sub type {
my $self=shift;
return $self->{type};
}
sub data {
my $self=shift;
return $self->{data};
}
# $t->sort(colID1, type1, order1, colID2, type2, order2, ... );
# where
# colID is a column index (integer) or name (string),
# type is 0 for numerical and 1 for others
# order is 0 for ascending and 1 for descending
# Sorting is done with priority of colname1, colname2, ...
sub sort_v0 {
my $self = shift;
my ($str, $i) = ("", 0);
my @cols = ();
while (scalar @_) {
my $c = shift;
my $col = $self->checkOldCol($c);
return undef unless defined $col;
push @cols, $col;
my $op = '<=>';
$op = 'cmp' if shift; # string
$str .=(shift)? "(\$b->[$i] $op \$a->[$i]) || " :
"(\$a->[$i] $op \$b->[$i]) || " ;
$i++;
}
substr($str, -3) = ""; # removes || from the end of $str
$self->rotate() if $self->{type};
# construct a pre-ordered array
my $fun = sub { my ($cols, $data) = @_;
my @ext;
@ext = map {$data->[$_]} @$cols;
push @ext, $data;
return \@ext;
};
my @preordered = map {&$fun(\@cols, $_)} @{$self->{data}};
$self->{data} = [ map {$_->[$i]} eval "sort {$str} \@preordered;" ];
return 1;
}
sub sort {
my $self = shift;
my @cols = @_;
confess "Parameters be in groups of three!\n" if ($#cols % 3 != 2);
foreach (0 .. ($#cols/3)) {
my $col = $self->checkOldCol($cols[$_*3]);
return undef unless defined $col;
$cols[$_*3]=$col;
}
my @subs=();
for (my $i=0; $i<=$#cols; $i+=3) {
my $mysub;
if ($cols[$i+1] == 0) {
$mysub = ($cols[$i+2]? sub {defined($_[1])?(defined($_[0])? $_[1] <=> $_[0]:1):(defined($_[0])?-1:0)} : sub {defined($_[1])?(defined($_[0])? $_[0] <=> $_[1]:-1):(defined($_[0])?1:0)});
} elsif ($cols[$i+1] == 1) {
$mysub = ($cols[$i+2]? sub {defined($_[1])?(defined($_[0])? $_[1] cmp $_[0]:1):(defined($_[0])?-1:0)} : sub {defined($_[1])?(defined($_[0])? $_[0] cmp $_[1]:-1):(defined($_[0])?1:0)});
} elsif (ref $cols[$i+1] eq 'CODE') {
my $predicate=$cols[$i+1];
$mysub = ($cols[$i+2]? sub {defined($_[1])?(defined($_[0])? $predicate->($_[1],$_[0]) : 1): (defined($_[0])?-1:0)} :
sub {defined($_[1])?(defined($_[0])? $predicate->($_[0],$_[1]) : -1): (defined($_[0])?1:0)} );
} else {
confess "Sort method should be 0 (numerical), 1 (other type), or a subroutine reference!\n";
}
push @subs, $mysub;
}
my $func = sub {
my $res = 0;
foreach (0 .. ($#cols/3)) {
$res ||= $subs[$_]->($a->[$cols[$_*3]], $b->[$cols[$_*3]]);
return $res unless $res==0;
}
return $res;
};
$self->rotate() if $self->{type};
$self->{data} = [sort $func @{$self->{data}}];
return 1;
}
# return rows as sub table in which
# a pattern $pattern is matched
sub match_pattern {
my ($self, $pattern, $countOnly) = @_;
my @data=();
$countOnly=0 unless defined($countOnly);
my $cnt=0;
$self->rotate() if $self->{type};
@Data::Table::OK= eval "map { $pattern?1:0; } \@{\$self->{data}};";
my @ok = @Data::Table::OK;
$self->{OK} = \@ok;
for (my $i=0; $i<$self->nofRow(); $i++) {
if ($self->{OK}->[$i]) {
push @data, $self->{data}->[$i] unless $countOnly;
$cnt++;
$self->{OK}->[$i] = 1;
$Data::Table::OK[$i] = 1;
} else {
# in case sometimes eval results is '' instead of 0
$self->{OK}->[$i] = 0;
$Data::Table::OK[$i] = 0;
}
}
$self->{MATCH} = [];
map { push @{$self->{MATCH}}, $_ if $self->{OK}->[$_] } 0 .. $#ok;
return $cnt if $countOnly;
my @header=@{$self->{header}};
return new Data::Table(\@data, \@header, 0);
}
# return rows as sub table in which
# a pattern $pattern is matched
# each row is passed to the patern as a hash, where column names are keys
sub match_pattern_hash {
my ($self, $pattern, $countOnly) = @_;
my @data=();
$countOnly=0 unless defined($countOnly);
my $cnt=0;
$self->rotate() if $self->{type};
@Data::Table::OK = ();
for (my $i=0; $i<$self->nofRow(); $i++) {
local %_ = %{$self->rowHashRef($i)};
$Data::Table::OK[$i] = eval "$pattern?1:0";
}
#@Data::Table::OK= eval "map { $pattern?1:0; } \@{\$self->{data}};";
my @ok = @Data::Table::OK;
$self->{OK} = \@ok;
for (my $i=0; $i<$self->nofRow(); $i++) {
if ($self->{OK}->[$i]) {
push @data, $self->{data}->[$i] unless $countOnly;
$cnt++;
$self->{OK}->[$i] = 1;
$Data::Table::OK[$i] = 1;
} else {
# in case sometimes eval results is '' instead of 0
$self->{OK}->[$i] = 0;
$Data::Table::OK[$i] = 0;
}
}
$self->{MATCH} = [];
map { push @{$self->{MATCH}}, $_ if $self->{OK}->[$_] } 0 .. $#ok;
return $cnt if $countOnly;
my @header=@{$self->{header}};
return new Data::Table(\@data, \@header, 0);
}
# return rows as sub table in which
# a string elm in an array @$s is matched
sub match_string {
my ($self, $s, $caseIgn, $countOnly) = @_;
confess unless defined($s);
$countOnly=0 unless defined($countOnly);
my @data=();
my $r;
$self->rotate() if $self->{type};
@Data::Table::OK=();
$self->{OK} = [];
$caseIgn=0 unless defined($caseIgn);
### comment out next line if your perl version < 5.005 ###
$r = ($caseIgn)?qr/$s/i : qr/$s/;
my $cnt=0;
foreach my $row_ref (@{$self->data}) {
push @Data::Table::OK, 0;
push @{$self->{OK}}, 0;
foreach my $elm (@$row_ref) {
next unless defined($elm);
### comment out the next line if your perl version < 5.005
if ($elm =~ /$r/) {
### uncomment the next line if your perl version < 5.005
# if ($elm =~ /$s/ || ($elm=~ /$s/i && $caseIgn)) {
push @data, $row_ref unless $countOnly;
$Data::Table::OK[$#Data::Table::OK]=1;
$self->{OK}->[$#{$self->{OK}}]=1;
$cnt++;
last;
}
}
}
$self->{MATCH} = [];
map { push @{$self->{MATCH}}, $_ if $self->{OK}->[$_] } 0 .. $#{$self->{OK}};
return $cnt if $countOnly;
my @header=@{$self->{header}};
return new Data::Table(\@data, \@header, 0);
}
sub rowMask {
my ($self, $OK, $c) = @_;
confess unless defined($OK);
$c = 0 unless defined ($c);
my @data=();
$self->rotate() if $self->{type};
my $data0=$self->data;
for (my $i=0; $i<$self->nofRow(); $i++) {
if ($c) {
push @data, $data0->[$i] unless $OK->[$i];
} else {
push @data, $data0->[$i] if $OK->[$i];
}
}
my @header=@{$self->{header}};
return new Data::Table(\@data, \@header, 0);
}
sub rowMerge {
my ($self, $tbl, $arg_ref) = @_;
my %arg = defined $arg_ref ? %$arg_ref : ();
$arg{byName} =0 unless exists $arg{byName};
$arg{addNewCol} = 0 unless exists $arg{addNewCol};
if ($self->isEmpty && !$tbl->isEmpty) {
my @header = $tbl->header;
my $i = 0;
foreach my $s (@header) {
push @{$self->{header}}, $s;
$self->{colHash}->{$s} = $i++;
}
}
if ($arg{byName} == 0 && $arg{addNewCol} == 0) {
confess "Tables must have the same number of columns" unless ($self->nofCol()==$tbl->nofCol());
} else {
if ($arg{addNewCol}) {
unless ($arg{byName}) { # add extra column by index
if ($self->nofCol < $tbl->nofCol) {
my @header = $tbl->header;
my $nCols = $self->nofCol();
my $nRows = $self->nofRow();
for (my $i = $nCols; $i<@header; $i++) {
my @one = (undef) x $nRows;
$self->addCol(\@one, $header[$i]);
}
} elsif ($self->nofCol > $tbl->nofCol) {
my @header = $self->header;
my %h = ();
my @header2 = $tbl->header;
map {$h{$_} = 1} @header2;
my $nCols = $tbl->nofCol();
my $nRows = $tbl->nofRow();
for (my $i = $nCols; $i<$self->nofCol; $i++) {
my @one = (undef) x $nRows;
# make sure new col name is unique
my $s = $header[$i];
my $cnt = 2;
while (exists $h{$s}) {
$s = $header[$i]."_".$cnt ++;
}
$tbl->addCol(\@one, $s);
$h{$s} = 1;
}
}
} else {
my @header = $tbl->header;
my $nRows = $self->nofRow();
foreach my $col (@header) {
if ($self->colIndex($col) < 0) {
my @one = (undef) x $nRows;
$self->addCol(\@one, $col);
}
}
}
}
}
$self->rotate() if $self->{type};
$tbl->rotate() if $tbl->{type};
my $data=$self->{data};
if ($arg{byName} == 0) {
push @$data, @{$tbl->{data}};
} else {
my @header = $self->header;
my $nCols = scalar @header;
my @colIndex = map { $tbl->colIndex($_) } @header;
foreach my $rowRef (@{$tbl->{data}}) {
my @one = ();
for (my $j=0; $j< $nCols; $j++) {
$one[$j] = $colIndex[$j]>=0 ? $rowRef->[$colIndex[$j]]:undef;
}
push @$data, \@one;
}
}
return 1;
}
sub colMerge {
my ($self, $tbl, $arg_ref) = @_;
my %arg = defined $arg_ref ? %$arg_ref : ();
$arg{renameCol} =0 unless exists $arg{renameCol};
confess "Tables must have the same number of rows" unless ($self->isEmpty || $self->nofRow()==$tbl->nofRow());
my $col;
my %h = ();
map {$h{$_} = 1} @{$self->{header}};
my @header2 = ();
foreach $col ($tbl->header) {
my $s = $col;
if (exists $h{$s}) {
confess "Duplicate column $col in two tables" unless $arg{renameCol};
my $cnt = 2;
while (exists $h{$s}) {
$s = $col ."_". $cnt++;
}
}
$h{$s} = 1;
push @header2, $s;
}
$self->rotate() unless $self->{type};
$tbl->rotate() unless $tbl->{type};
my $i = $self->nofCol();
for my $s (@header2) {
push @{$self->{header}}, $s;
$self->{colHash}->{$s} = $i++;
}
my $data=$self->{data};
for ($i=0; $i<$tbl->nofCol(); $i++) {
push @$data, $tbl->{data}->[$i];
}
return 1;
}
sub subTable {
my ($self, $rowIdcsRef, $colIDsRef, $arg_ref) = @_;
my @newdata=();
my @newheader=();
# to avoid the side effect of modifying $colIDsRef, 4/30/2012
my $useRowMask = 0;
$useRowMask = $arg_ref->{useRowMask} if defined $arg_ref->{useRowMask};
my @rowIdcs = ();
@rowIdcs = defined $rowIdcsRef ? @$rowIdcsRef : 0..($self->nofRow()-1) unless $useRowMask;
my @colIDs = defined $colIDsRef ? @$colIDsRef : 0..($self->nofCol()-1);
##$rowIdcsRef = [0..($self->nofRow()-1)] unless defined $rowIdcsRef;
#$colIDsRef = [0..($self->nofCol()-1)] unless defined $colIDsRef;
for (my $i = 0; $i < scalar @colIDs; $i++) {
$colIDs[$i]=$self->checkOldCol($colIDs[$i]);
#return undef unless defined $colIDsRef;
push @newheader, $self->{header}->[$colIDs[$i]];
}
if ($useRowMask) {
my @OK = @$rowIdcsRef;
my $n = $self->nofRow;
for (my $i = 0; $i < $n; $i++) {
push @rowIdcs, $i if $OK[$i];
}
}
if ($self->{type}) {
for (my $i = 0; $i < scalar @colIDs; $i++) {
my @one=();
for (my $j = 0; $j < scalar @rowIdcs; $j++) {
return undef unless defined $self->checkOldRow($rowIdcs[$j]);
push @one, $self->{data}->[$colIDs[$i]]->[$rowIdcs[$j]];
}
push @newdata, \@one;
}
} else {
for (my $i = 0; $i < scalar @rowIdcs; $i++) {
return undef unless defined $self->checkOldRow($rowIdcs[$i]);
my @one=();
for (my $j = 0; $j < scalar @colIDs; $j++) {
push @one, $self->{data}->[$rowIdcs[$i]]->[$colIDs[$j]];
}
push @newdata, \@one;
}
}
return new Data::Table(\@newdata, \@newheader, $self->{type});
}
sub reorder {
my ($self, $colIDsRef, $arg_ref) = @_;
return unless defined $colIDsRef;
$arg_ref = {keepRest => 1} unless defined $arg_ref;
my @newdata=();
my @newheader=();
my @colIDs = ();
my %inNew = ();
for (my $i = 0; $i < scalar @$colIDsRef; $i++) {
my $idx = $self->checkOldCol($colIDsRef->[$i]);
confess "Invalide column $colIDsRef->[$i]" unless defined $idx;
$colIDs[$i] = $idx;
$inNew{$idx} = 1;
#return undef unless defined $colIDsRef;
push @newheader, $self->{header}->[$idx];
}
if ($arg_ref->{keepRest}) {
for (my $i = 0; $i<$self->nofCol; $i++) {
unless (exists $inNew{$i}) {
push @colIDs, $i;
push @newheader, $self->{header}->[$i];
}
}
}
if ($self->{type}) {
for (my $i = 0; $i < scalar @colIDs; $i++) {
push @newdata, $self->{data}->[$colIDs[$i]];
}
} else {
my $n = $self->nofRow;
for (my $i = 0; $i < $n; $i++) {
my @one=();
for (my $j = 0; $j < scalar @colIDs; $j++) {
push @one, $self->{data}->[$i]->[$colIDs[$j]];
}
push @newdata, \@one;
}
}
$self->{header} = \@newheader;
$self->{colHash} = ();
for (my $i = 0; $i < scalar @colIDs; $i++) {
$self->{colHash}->{$newheader[$i]} = $i;
}
$self->{data} = \@newdata;
}
sub clone {
my $self = shift;
my $data = $self->{data};
my @newheader = @{$self->{header}};
my @newdata = ();
for (my $i = 0; $i < scalar @{$data}; $i++) {
my @one=();
for (my $j = 0; $j < scalar @{$data->[$i]}; $j++) {
push @one, $data->[$i]->[$j];
}
push @newdata, \@one;
}
return new Data::Table(\@newdata, \@newheader, $self->{type});
}
sub fromCSVi {
my $self = shift;
return fromCSV(@_);
}
sub getOneLine {
my ($fh, $linebreak, $qualifier) = @_;
my $s = '';
$qualifier = '' unless defined $qualifier;
local($/) = $linebreak;
return <$fh> unless $qualifier;
while (my $s2 = <$fh>) {
$s .= $s2;
my @S = ($s =~ /$qualifier/g);
return $s if (scalar @S % 2 == 0);
}
return $s;
}
sub fromCSV {
my ($name_or_handler, $includeHeader, $header, $arg_ref) = @_;
$includeHeader = 1 unless defined($includeHeader);
my ($OS, $delimiter, $qualifier, $skip_lines, $skip_pattern, $encoding) = ($Data::Table::DEFAULTS{OS}, $Data::Table::DEFAULTS{CSV_DELIMITER}, $Data::Table::DEFAULTS{CSV_QUALIFIER}, 0, undef, $Data::Table::DEFAULTS{ENCODING});
$OS = $arg_ref->{'OS'} if (defined($arg_ref) && defined($arg_ref->{'OS'}));
# OS: 0 for UNIX (\n as linebreak), 1 for Windows (\r\n as linebreak)
### 2 for MAC (\r as linebreak)
if (defined($arg_ref)) {
$delimiter = $arg_ref->{'delimiter'} if defined($arg_ref->{'delimiter'});
$qualifier = $arg_ref->{'qualifier'} if defined($arg_ref->{'qualifier'});
$skip_lines = $arg_ref->{'skip_lines'} if (defined($arg_ref->{'skip_lines'}) && $arg_ref->{'skip_lines'}>0);
$skip_pattern = $arg_ref->{'skip_pattern'} if defined($arg_ref->{'skip_pattern'});
$encoding = $arg_ref->{'encoding'} if defined($arg_ref->{'encoding'});
}
my @header;
my $givenHeader = 0;
if (defined($header) && ref($header) eq 'ARRAY') {
$givenHeader = 1;
@header= @$header;
}
my $SRC=openFileWithEncoding($name_or_handler, $encoding);
my @data = ();
my $oldRowDelimiter=$/;
my $newRowDelimiter=($OS==2)?"\r":(($OS==1)?"\r\n":"\n");
my $n_endl = length($newRowDelimiter);
$/=$newRowDelimiter;
my $s;
for (my $i=0; $i<$skip_lines; $i++) {
#$s=<$SRC>;
$s = getOneLine($SRC, $newRowDelimiter, $qualifier);
}
#$s=<$SRC>;
$s = getOneLine($SRC, $newRowDelimiter, $qualifier);
if (defined($skip_pattern)) { while (defined($s) && $s =~ /$skip_pattern/) { $s = getOneLine($SRC, $newRowDelimiter, $qualifier); }}
#{ $s = <$SRC> }; }
if (substr($s, -$n_endl, $n_endl) eq $newRowDelimiter) { for (1..$n_endl) { chop $s }}
# $_=~ s/$newRowDelimiter$//;
unless ($s) {
#confess "Empty data file" unless $givenHeader;
return undef unless $givenHeader;
$/=$oldRowDelimiter;
return new Data::Table(\@data, \@header, 0);
}
my $one;
if ($s =~ /$delimiter$/) { # if the line ends by ',', the size of @one will be incorrect
# due to the tailing of split function in perl
$s .= ' '; # e.g., split $s="a," will only return a list of size 1.
$one = parseCSV($s, undef, {delimiter=>$delimiter, qualifier=>$qualifier});
$one->[$#{@$one}]=undef;
} else {
$one = parseCSV($s, undef, {delimiter=>$delimiter, qualifier=>$qualifier});
}
#print join("|", @$one), scalar @$one, "\n";
my $size = scalar @$one;
unless ($givenHeader) {
if ($includeHeader) {
@header = @$one;
} else {
@header = map {"col$_"} (1..$size); # name each column as col1, col2, .. etc
}
}
push @data, $one unless ($includeHeader);
#while($s = <$SRC>) {
while($s = getOneLine($SRC, $newRowDelimiter, $qualifier)) {
next if (defined($skip_pattern) && $s =~ /$skip_pattern/);
if (substr($s, -$n_endl, $n_endl) eq $newRowDelimiter) { for (1..$n_endl) { chop $s }}
# $_=~ s/$newDelimiter$//;
my $one = parseCSV($s, $size, {delimiter=>$delimiter, qualifier=>$qualifier});
confess "Inconsistent column number at data entry: ".($#data+1) unless ($size==scalar @$one);
push @data, $one;
}
close($SRC);
$/=$oldRowDelimiter;
return new Data::Table(\@data, \@header, 0);
}
# Idea: use \ as the escape char to encode a CSV string,
# replace \ by \\ and comma inside a field by \c.
# A comma inside a field must have odd number of " in front of it,
# therefore it can be distinguished from comma used as the deliminator.
# After escape, and split by comma, we unescape each field string.
#
# This parser will never be crashed by any illegal CSV format,
# it always return an array!
sub parseCSV {
my ($s, $size, $arg_ref)=@_;
$size = 0 unless defined $size;
my ($delimiter, $qualifier) = ($Data::Table::DEFAULTS{CSV_DELIMITER}, $Data::Table::DEFAULTS{CSV_QUALIFIER});
$delimiter = $arg_ref->{'delimiter'} if (defined($arg_ref) && defined($arg_ref->{'delimiter'}));
$qualifier = $arg_ref->{'qualifier'} if (defined($arg_ref) && defined($arg_ref->{'qualifier'}));
my $delimiter2 = $delimiter; $delimiter2 = substr($delimiter, 1, 1) if length($delimiter)>1;
my $qualifier2 = $qualifier; $qualifier2 = substr($qualifier, 1, 1) if length($qualifier)>1;
# $s =~ s/\n$//; # chop" # assume extra characters has been cleaned before
if (-1==index $s, $qualifier) {
if ($size == 0) {
my $s2 = $s;
$s2 =~ s/$delimiter//g;
$size = length($s)-length($s2)+1;
}
return [split /$delimiter/, $s , $size];
}
$s =~ s/\\/\\\\/g; # escape \ => \\
my $n = length($s);
my ($q, $i)=(0, 0);
while ($i < $n) {
my $ch=substr($s, $i, 1);
$i++;
if ($ch eq $delimiter2 && ($q%2)) {
substr($s, $i-1, 1)='\\c'; # escape , => \c if it's not a deliminator
$i++;
$n++;
} elsif ($ch eq $qualifier2) {
$q++;
}
}
# add look-ahead avoid the speical case where $delimiter is a tab
$s =~ s/(^$qualifier)|($qualifier((?!$delimiter)\s)*$)//g; # get rid of boundary ", then restore "" => "
$s =~ s/$qualifier((?!$delimiter)\s)*$delimiter/$delimiter2/g;
$s =~ s/$delimiter((?!$delimiter)\s)*$qualifier/$delimiter2/g;
$s =~ s/$qualifier$qualifier/$qualifier2/g;
if ($size == 0) {
my $s2 = $s;
$s2 =~ s/$delimiter//g;
$size = length($s)-length($s2)+1;
}
my @parts=split(/$delimiter/, $s, $size);
@parts = map {$_ =~ s/(\\c|\\\\)/$1 eq '\c'?$delimiter2:'\\'/eg; $_ } @parts;
# my @parts2=();
# foreach $s2 (@parts) {
# $s2 =~ s/\\c/,/g; # restore \c => ,
# $s2 =~ s/\\\\/\\/g; # restore \\ => \
# push @parts2, $s2;
# }
return \@parts;
}
sub transformElement {
my $one = shift;
for (my $i=0; $i < scalar @$one; $i++) {
next unless defined($one->[$i]);
if ($one->[$i] eq "\\N") {
$one->[$i]=undef;
} else {
$one->[$i] =~ s/\\([0ntrb'"\\])/$Data::Table::TSV_ESC{$1}/g;
}
}
return $one;
}
sub fromTSVi {
my $self = shift;
return fromTSV(@_);
}
sub fromTSV {
my ($name_or_handler, $includeHeader, $header, $arg_ref) = @_;
my ($OS, $skip_lines, $skip_pattern, $transform_element, $encoding) = ($Data::Table::DEFAULTS{OS}, 0, undef, 1, $Data::Table::DEFAULTS{ENCODING});
$OS = $arg_ref->{'OS'} if (defined($arg_ref) && defined($arg_ref->{'OS'}));
# OS: 0 for UNIX (\n as linebreak), 1 for Windows (\r\n as linebreak)
### 2 for MAC (\r as linebreak)
$skip_lines = $arg_ref->{'skip_lines'} if (defined($arg_ref) && defined($arg_ref->{'skip_lines'}) && $arg_ref->{'skip_lines'}>0);
$skip_pattern = $arg_ref->{'skip_pattern'} if defined($arg_ref->{'skip_pattern'});
$transform_element = $arg_ref->{'transform_element'} if (defined($arg_ref->{'transform_element'}));
$encoding = $arg_ref->{'encoding'} if (defined($arg_ref->{'encoding'}));
#my %ESC = ( '0'=>"\0", 'n'=>"\n", 't'=>"\t", 'r'=>"\r", 'b'=>"\b",
# "'"=>"'", '"'=>"\"", '\\'=>"\\" );
## what about \f? MySQL treats \f as f.
$includeHeader = 1 unless defined($includeHeader);
$OS=0 unless defined($OS);
my @header;
my $givenHeader = 0;
if (defined($header) && ref($header) eq 'ARRAY') {
$givenHeader = 1;
@header= @$header;
}
my $SRC=openFileWithEncoding($name_or_handler, $encoding);
my @data = ();
my $oldRowDelimiter=$/;
my $newRowDelimiter=($OS==2)?"\r":(($OS==1)?"\r\n":"\n");
my $n_endl = length($newRowDelimiter);
$/=$newRowDelimiter;
my $s;
for (my $i=0; $i<$skip_lines; $i++) {
$s=<$SRC>;
}
$s=<$SRC>;
if (defined($skip_pattern)) { while (defined($s) && $s =~ /$skip_pattern/) { $s = <$SRC> }; }
if (substr($s, -$n_endl, $n_endl) eq $newRowDelimiter) { for (1..$n_endl) { chop $s }}
# $_=~ s/$newRowDelimiter$//;
unless ($s) {
confess "Empty data file" unless $givenHeader;
$/=$oldRowDelimiter;
return new Data::Table(\@data, \@header, 0);
}
#chop;
my $one;
if ($s =~ /\t$/) { # if the line ends by ',', the size of @$one will be incorrect
# due to the tailing of split function in perl
$s .= ' '; # e.g., split $s="a," will only return a list of size 1.
@$one = split(/\t/, $s);
$one->[$#{@$one}]='';
} else {
@$one = split(/\t/, $s);
}
# print join("|", @$one), scalar @$one, "\n";
my $size = scalar @$one;
unless ($givenHeader) {
if ($includeHeader) {
if ($transform_element) {
@header = map { $_ =~ s/\\([0ntrb'"\\])/$Data::Table::TSV_ESC{$1}/g; $_ } @$one;
} else {
@header = @$one;
}
} else {
@header = map {"col$_"} (1..$size); # name each column as col1, col2, .. etc
}
}
unless ($includeHeader) {
transformElement($one) if $transform_element;
push @data, $one;
}
while($s = <$SRC>) {
#chop;
# $_=~ s/$newRowDelimiter$//;
next if (defined($skip_pattern) && $s =~ /$skip_pattern/);
if (substr($s, -$n_endl, $n_endl) eq $newRowDelimiter) { for (1..$n_endl) { chop $s }}
my @one = split(/\t/, $s, $size);
transformElement(\@one) if $transform_element;
#for (my $i=0; $i < $size; $i++) {
# next unless defined($one[$i]);
# if ($one[$i] eq "\\N") {
# $one[$i]=undef;
# } else {
# $one[$i] =~ s/\\([0ntrb'"\\])/$Data::Table::TSV_ESC{$1}/g;
# }
#}
confess "Inconsistent column number at data entry: ".($#data+1) unless ($size==scalar @one);
push @data, \@one;
}
close($SRC);
$/=$oldRowDelimiter;
return new Data::Table(\@data, \@header, 0);
}
sub fromSQLi {
my $self = shift;
return fromSQL(@_);
}
sub fromSQL {
my ($dbh, $sql, $vars) = @_;
my ($sth, $header, $t);
if (ref $sql eq 'DBI::st') {
$sth = $sql;
} else {
$sth = $dbh->prepare($sql) or confess "Preparing: , ".$dbh->errstr;
}
my @vars=() unless defined $vars;
$sth->execute(@$vars) or confess "Executing: ".$dbh->errstr;
# $Data::Table::ID = undef;
# $Data::Table::ID = $sth->{'mysql_insertid'};
if ($sth->{NUM_OF_FIELDS}) {
$header=$sth->{'NAME'};
$t = new Data::Table($sth->fetchall_arrayref(), $header, 0);
} else {
$t = undef;
}
$sth->finish;
return $t;
}
sub join {
my ($self, $tbl, $type, $cols1, $cols2, $arg_ref) = @_;
my $n1 = scalar @$cols1;
my %arg= ( renameCol => 0, matchNULL => 0, NULLasEmpty => 0);
$arg{renameCol} = $arg_ref->{renameCol} if exists $arg_ref->{renameCol};
$arg{matchNULL} = $arg_ref->{matchNULL} if exists $arg_ref->{matchNULL};
$arg{NULLasEmpty} = $arg_ref->{NULLasEmpty} if exists $arg_ref->{NULLasEmpty};
#%arg = %$arg_ref if defined $arg_ref;
# default cols2 to cols1 if not specified
if (!defined($cols2) && $n1>0) {
$cols2 = [];
foreach my $c (@$cols1) {
push @$cols2, $c;
}
}
my $n2 = scalar @$cols2;
confess "The number of join columns must be the same: $n1 != $n2" unless $n1==$n2;
confess "At least one join column must be specified" unless $n1;
my ($i, $j, $k);
my @cols3 = ();
for ($i = 0; $i < $n1; $i++) {
$cols1->[$i]=$self->checkOldCol($cols1->[$i]);
confess "Unknown column ". $cols1->[$i] unless defined($cols1->[$i]);
$cols2->[$i]=$tbl->checkOldCol($cols2->[$i]);
confess "Unknown column ". $cols2->[$i] unless defined($cols2->[$i]);
$cols3[$cols2->[$i]]=1;
}
my @cols4 = (); # the list of remaining columns
my @header2 = ();
for ($i = 0; $i < $tbl->nofCol; $i++) {
unless (defined($cols3[$i])) {
push @cols4, $i;
push @header2, $tbl->{header}->[$i];
}
}
$self->rotate() if $self->{type};
$tbl->rotate() if $tbl->{type};
my $data1 = $self->{data};
my $data2 = $tbl->{data};
my %H=();
my $key;
my @subRow;
for ($i = 0; $i < $self->nofRow; $i++) {
@subRow = @{$data1->[$i]}[@$cols1];
my @S = map {tsvEscape($_)} @subRow;
map { $_ = '' if $_ eq '\\N' } @S if $arg{NULLasEmpty};
$key = join("\t", @S);
unless (defined($H{$key})) {
$H{$key} = [[$i], []];
} else {
push @{$H{$key}->[0]}, $i;
}
}
for ($i = 0; $i < $tbl->nofRow; $i++) {
@subRow = @{$data2->[$i]}[@$cols2];
# we intentionally make the second table undef keys to be '\\N\\N',
# so that they are different from the first table undef keys
# avoid NULL == NULL in the join
my @S = map {tsvEscape($_)} @subRow;
map { $_ = ($arg{NULLasEmpty})? '':($arg{matchNULL} ? $_ : '\\N\\N') if $_ eq '\\N' } @S;
#if ($j>= @S) {
$key = join("\t", @S);
#} else {
# $key = $arg{matchNULL} ? '\\N' : '\\N\\N';
#}
unless (defined($H{$key})) {
$H{$key} = [[], [$i]];
} else {
push @{$H{$key}->[1]}, $i;
}
}
# $type
# 0: inner join
# 1: left outer join
# 2: right outer join
# 3: full outer join
my @ones = ();
my @null1 = ();
my @null2 = ();
my @null3 = ();
$null1[$self->nofCol-1]=undef;
$null3[$self->nofCol-1]=undef;
if ($#cols4>=0) { $null2[$#cols4]=undef; }
foreach $key (keys %H) {
my ($rows1, $rows2) = @{$H{$key}};
my $nr1 = scalar @$rows1;
my $nr2 = scalar @$rows2;
next if ($nr1 == 0 && ($type == 0 || $type == 1));
next if ($nr2 == 0 && ($type == 0 || $type == 2));
if ($nr2 == 0 && ($type == 1 || $type == 3)) {
for ($i = 0; $i < $nr1; $i++) {
push @ones, [$self->row($rows1->[$i]), @null2];
}
next;
}
if ($nr1 == 0 && ($type == 2 || $type == 3)) {
for ($j = 0; $j < $nr2; $j++) {
my @row2 = $tbl->row($rows2->[$j]);
for ($k = 0; $k< scalar @$cols1; $k++) {
$null3[$cols1->[$k]] = $row2[$cols2->[$k]];
}
if ($#cols4>=0) {
push @ones, [@null3, @row2[@cols4]];
} else {
push @ones, [@null3];
}
}
next;
}
for ($i = 0; $i < $nr1; $i++) {
for ($j = 0; $j < $nr2; $j++) {
my @row2 = $tbl->row($rows2->[$j]);
push @ones, [$self->row($rows1->[$i]), @row2[@cols4]];
}
}
}
if ($arg{renameCol}) {
my %h = ();
map {$h{$_} = 1} @{$self->{header}};
for (my $i=0; $i<@header2; $i++) {
my $s = $header2[$i];
my $cnt = 2;
while (exists $h{$s}) {
$s = $header2[$i] ."_". $cnt++;
}
$header2[$i] = $s;
$h{$s} = 1;
}
}
my $header = [@{$self->{header}}, @header2];
return new Data::Table(\@ones, $header, 0);
}
sub melt {
my ($self, $keyCols, $variableCols, $arg_ref) = @_;
confess "key columns have to be specified!" unless defined($keyCols) && ref($keyCols) eq "ARRAY";
my $variableColName = 'variable';
my $valueColName = 'value';
my $skip_NULL = 1;
my $skip_empty = 0;
$variableColName = $arg_ref->{'variableColName'} if (defined($arg_ref) && defined($arg_ref->{'variableColName'}));
$valueColName = $arg_ref->{'valueColName'} if (defined($arg_ref) && defined($arg_ref->{'valueColName'}));
$skip_NULL = $arg_ref->{'skip_NULL'} if (defined($arg_ref) && defined($arg_ref->{'skip_NULL'}));
$skip_empty= $arg_ref->{'skip_empty'} if (defined($arg_ref) && defined($arg_ref->{'skip_empty'}));
my @X = ();
my %X = ();
foreach my $x (@$keyCols) {
my $x_idx = $self->checkOldCol($x);
confess "Unknown column ". $x unless defined($x_idx);
push @X, $x_idx;
$X{$x_idx} = 1;
}
my @Y = ();
my %Y = ();
unless (defined($variableCols)) {
$variableCols = [];
foreach my $x (0 .. $self->nofCol-1) {
next if $X{$x};
push @$variableCols, $x;
}
}
unless (scalar @$variableCols) {
confess "Variable columns have to be specified!";
}
foreach my $y (@$variableCols) {
my $y_idx = $self->checkOldCol($y);
confess "Unknown column ". $y unless defined($y_idx);
push @Y, $y_idx;
$Y{$y_idx} = 1;
}
my @newHeader = ();
my @header = $self->header;
for (my $i=0; $i<= $#X; $i++) {
push @newHeader, $header[$X[$i]];
}
push @newHeader, $variableColName;
push @newHeader, $valueColName;
my @newRows = ();
for (my $i=0; $i<$self->nofRow; $i++) {
my $row = $self->rowRef($i);
my @key = @$row[@X];
foreach my $y (@Y) {
next if (!defined($row->[$y]) && $skip_NULL);
next if ($row->[$y] eq '' && $skip_empty);
my @one = @key;
push @one, $header[$y], $row->[$y];
push @newRows, \@one;
}
}
return new Data::Table(\@newRows, \@newHeader, 0);
}
sub cast {
my ($self, $colsToGroupBy, $colToSplit, $colToSplitIsStringOrNumeric, $colToCalculate, $funToApply) = @_;
#$colToSplit = 'variable' unless defined $colToSplit;
#$colToCalculate = 'value' unless defined $colToCalculate;
$colsToGroupBy = [] unless defined $colsToGroupBy;
my $tmpColName = '_calcColumn';
my $cnt = 2;
my $s = $tmpColName;
while ($self->hasCol($s)) {
$s = $tmpColName."_".$cnt++;
}
$tmpColName = $s;
my %grpBy = ();
map {$grpBy{$_} = 1} @$colsToGroupBy;
my @grpBy = @$colsToGroupBy;
confess "colToSplit cannot be contained in the list of colsToGroupBy!" if defined $colToSplit and $grpBy{$colToSplit};
push @grpBy, $colToSplit if defined $colToSplit;
my $t = $self->group(\@grpBy, [$colToCalculate], [$funToApply], [$tmpColName], 0);
$t = $t->pivot($colToSplit, $colToSplitIsStringOrNumeric, $tmpColName, $colsToGroupBy);
return $t;
}
sub each_group {
my ($self, $colsToGroupBy, $funToApply) = @_;
$colsToGroupBy = [] unless defined $colsToGroupBy;
confess "colsToGroupBy has to be specified!" unless defined($colsToGroupBy) && ref($colsToGroupBy) eq "ARRAY";
confess "funToApply has to be a reference to CODE!" unless ref($funToApply) eq "CODE";
unless (scalar @$colsToGroupBy) { # all rows are treated as one group
$funToApply->($self->clone, 0 .. $self->nofRow - 1);
return;
}
my @X = ();
my %grpBy = ();
foreach my $x (@$colsToGroupBy) {
my $x_idx = $self->checkOldCol($x);
confess "Unknown column ". $x unless defined($x_idx);
push @X, $x_idx;
$grpBy{$x_idx} = 1;
}
my %X = ();
for (my $i=0; $i<$self->nofRow; $i++) {
my $myRow = $self->rowRef($i);
#my @val = ();
#foreach my $x (@X) {
# push @val, defined($myRow->[$x])?$myRow->[$x]:"";
#}
my @val = map {tsvEscape($_)} @{$myRow}[@X];
my $myKey = CORE::join("\t", @val);
push @{$X{$myKey}}, $i;
}
foreach my $myKey ( sort {$a cmp $b} keys %X) {
$funToApply->($self->subTable($X{$myKey}, undef), $X{$myKey});
}
}
sub group {
my ($self, $colsToGroupBy, $colsToCalculate, $funsToApply, $newColNames, $keepRestCols) = @_;
$keepRestCols = 1 unless defined($keepRestCols);
$colsToGroupBy = [] unless defined $colsToGroupBy;
confess "colsToGroupBy has to be specified!" unless defined($colsToGroupBy) && ref($colsToGroupBy) eq "ARRAY";
my @X = ();
my %grpBy = ();
foreach my $x (@$colsToGroupBy) {
my $x_idx = $self->checkOldCol($x);
confess "Unknown column ". $x unless defined($x_idx);
push @X, $x_idx;
$grpBy{$x_idx} = 1;
}
my @Y = ();
my %Y= ();
if (defined($colsToCalculate)) {
foreach my $y (@$colsToCalculate) {
my $y_idx = $self->checkOldCol($y);
confess "Unknown column ". $y unless defined($y_idx);
push @Y, $y_idx;
$Y{$y_idx} = 1;
}
}
if (scalar @Y) {
confess "The size of colsToCalculate, funcsToApply and newColNames should be the same!\n"
unless (scalar @Y == scalar @$funsToApply && scalar @Y == scalar @$newColNames);
}
my @header = ();
my @X_name = ();
my $cnt = 0;
my $i;
for ($i=0; $i<$self->nofCol; $i++) {
if ($grpBy{$i} || ($keepRestCols && !defined($Y{$i}))) {
push @X_name, $i;
push @header, $self->{header}->[$i];
$cnt += 1;
}
}
if (defined($newColNames)) {
foreach my $y (@$newColNames) {
push @header, $y;
$cnt += 1;
}
}
my @ones = ();
my %X = ();
my %val = ();
my %rowIdx = ();
my $idx = 0;
for ($i=0; $i<$self->nofRow; $i++) {
my @row = ();
my $myRow = $self->rowRef($i);
my $myKey = '(all)';
if (@X) {
# if colsToGroupBy is not specified, all rows has myKey = '(all)', therefore treated as one group
my @val = map {tsvEscape($_)} @{$myRow}[@X];
#foreach my $x (@X) {
# push @val, defined($myRow->[$x])?$myRow->[$x]:"";
#}
$myKey = CORE::join("\t", @val);
}
if (scalar @Y) {
my %Y = ();
foreach my $y (@Y) {
next if defined($Y{$y});
$Y{$y} = 1;
if (defined($val{$y}->{$myKey})) {
push @{$val{$y}->{$myKey}}, $myRow->[$y];
} else {
$val{$y}->{$myKey} = [$myRow->[$y]];
}
}
}
next if defined($X{$myKey});
$X{$myKey} = 1;
foreach my $j (@X_name) {
push @row, $myRow->[$j];
}
$row[$cnt-1] = undef if (scalar @row < $cnt);
push @ones, \@row;
$rowIdx{$myKey} = $idx++;
}
if (scalar @Y) {
$cnt -= scalar @Y;
for($i=0; $i<scalar @Y; $i++) {
foreach my $s (keys %X) {
if (ref($funsToApply->[$i]) eq "CODE") {
$ones[$rowIdx{$s}]->[$cnt+$i] = $funsToApply->[$i]->(@{$val{$Y[$i]}->{$s}});
} else {
$ones[$rowIdx{$s}]->[$cnt+$i] = scalar @{$val{$Y[$i]}->{$s}};
#confess "The ${i}th element in the function array is not a valid reference!\n";
}
}
}
}
return new Data::Table(\@ones, \@header, 0);
}
sub pivot {
my ($self, $colToSplit, $colToSplitIsStringOrNumeric, $colToFill, $colsToGroupBy, $keepRestCols) = @_;
$keepRestCols = 0 unless defined($keepRestCols);
$colToSplitIsStringOrNumeric = 0 unless defined($colToSplitIsStringOrNumeric);
$colsToGroupBy = [] unless defined $colsToGroupBy;
my $y = undef;
$y = $self->checkOldCol($colToSplit) if defined $colToSplit;
my $y_name = defined($y)?$self->{header}->[$y]:undef;
confess "Unknown column ". $colToSplit if (!defined($y) && defined($colToSplit));
my $z = undef;
$z = $self->checkOldCol($colToFill) if defined($colToFill);
my $z_name = defined($z)?$self->{header}->[$z]:undef;
confess "Unknown column ". $colToFill if (!defined($z) && defined($colToFill));
#confess "Cannot take colToFill, if colToSplit is 'undef'" if (defined($z) && !defined($y));
my @X = ();
if (defined($colsToGroupBy)) {
foreach my $x (@$colsToGroupBy) {
my $x_idx = $self->checkOldCol($x);
confess "Unknown column ". $x unless defined($x_idx);
push @X, $self->{header}->[$x_idx];
}
}
my (@Y, %Y);
if (defined($colToSplit)) {
@Y = $self->col($y);
%Y = ();
foreach my $val (@Y) {
$val = "NULL" unless defined($val);
$Y{$val} = 1;
}
} else {
@Y = ('(all)') x $self->nofCol;
%Y = ('(all)' => 1);
$colToSplitIsStringOrNumeric = 1;
}
if ($colToSplitIsStringOrNumeric == 0) {
foreach my $y (keys %Y) {
if ($y =~ /\D/) {
$colToSplitIsStringOrNumeric = 1;
last;
}
}
}
if ($colToSplitIsStringOrNumeric) {
@Y = sort { $a cmp $b } (keys %Y);
} else {
@Y = sort { $a <=> $b } (keys %Y);
}
my @header = ();
my $i;
my @X_name = ();
if (!$keepRestCols) {
foreach my $x (@X) {
push @X_name, $x;
}
} else {
for ($i=0; $i<$self->nofCol; $i++) {
next if ((defined($y) && $i==$y) || (defined($z) && $i==$z));
push @X_name, $self->{header}->[$i];
}
}
my $cnt = 0;
for ($i=0; $i < @X_name; $i++) {
my $s = $X_name[$i];
while (defined($Y{$s})) {
$s = "_".$s;
}
push @header, $s;
$Y{$s} = $cnt++;
}
#if (defined($y)) {
foreach my $val (@Y) {
push @header, ($colToSplitIsStringOrNumeric?"":"$y_name=") . $val;
$Y{$val} = $cnt++;
}
#}
my @ones = ();
my %X = ();
my $rowIdx = 0;
for ($i=0; $i<$self->nofRow; $i++) {
my @row = ();
my $myRow = $self->rowHashRef($i);
my $myKey = '(all)'; # set to '' to work with total agreegation (group all rows into one)
if (scalar @X) {
my @val = ();
foreach my $x (@X) {
push @val, tsvEscape($myRow->{$x});
}
$myKey = CORE::join("\t", @val);
}
unless (defined($X{$myKey})) {
foreach my $s (@X_name) {
push @row, $myRow->{$s};
}
for (my $j = scalar @row; $j<$cnt; $j++) {
$row[$j] = undef;
}
#$row[$cnt-1] = undef if (scalar @row < $cnt);
}
#if (defined($y)) {
my $val = defined($y) ? $myRow->{$y_name} : "(all)";
$val = "NULL" unless defined($val);
if (!defined($X{$myKey})) {
$row[$Y{$val}] = defined($z)?$myRow->{$z_name}: $row[$Y{$val}]+1;
} else {
$ones[$X{$myKey}][$Y{$val}] = defined($z)?$myRow->{$z_name}: $ones[$X{$myKey}][$Y{$val}]+1;
}
#}
unless (defined($X{$myKey})) {
push @ones, \@row;
$X{$myKey} = $rowIdx++;
}
}
return new Data::Table(\@ones, \@header, 0);
}
sub fromFileGuessOS {
my ($name, $arg_ref) = @_;
my @OS=("\n", "\r\n", "\r");
# operatoring system: 0 for UNIX (\n as linebreak), 1 for Windows
# (\r\n as linebreak), 2 for MAC (\r as linebreak)
my $qualifier = '';
my $encoding = $Data::Table::DEFAULTS{ENCODING};
$qualifier = $arg_ref->{qualifier} if (defined($arg_ref) && exists $arg_ref->{qualifier});
$encoding = $arg_ref->{encoding} if (defined($arg_ref) && exists $arg_ref->{encoding});
my ($len, $os)=(-1, -1);
my $SRC=openFileWithEncoding($name, $encoding);
#local($/)="\n";
my $s = getOneLine($SRC, "\n", $qualifier); #<$SRC>;
close($SRC);
#$s =~ s/\n$//;
#my $myLen=length($s);
#$s =~ s/\r$//;
if ($s =~ /\r\n$/) {
return 1;
} elsif ($s =~ /\n$/) {
return 0;
} elsif ($s =~ /\r/) {
return 2;
}
return 0;
#if (length($s) == $myLen) {
# return 0;
#} elsif (length($s) == $myLen - 1) {
# return 1;
#} else {
# return 2;
#}
# for (my $i=0; $i<@OS; $i++) {
# open($SRC, $name) or confess "Cannot open $name to read";
# binmode $SRC;
# local($/)=$OS[$i];
# my $s = <$SRC>;
# #print ">> $i => ". (length($s)-length($OS[$i]))."\n";
# my $myLen=length($s)-length($OS[$i]);
# if ($len<0 || ($myLen>0 && $myLen<$len)) {
# $len=length($s)-length($OS[$i]);
# $os=$i;
# }
# close($SRC);
# }
# # find the OS linebreak that gives the shortest first line
# return $os;
}
sub openFileWithEncoding {
my ($name_or_handler, $encoding) = @_;
my $isFileHandler=ref($name_or_handler) ne "";
my $SRC;
if ($isFileHandler) {
$SRC = $name_or_handler; # a file handler
} else {
open($SRC, $name_or_handler) or confess "Cannot open $name_or_handler to read";
}
# check if Perl version is recent enough to support encoding
$encoding ='' if (!$^V or $^V lt v5.8.1);
if ($encoding) {
$encoding='UTF-8' if ($encoding =~ /^utf-?8$/i);
binmode($SRC, ":encoding($encoding)");
} else {
binmode $SRC;
}
return $SRC;
}
sub fromFileGetTopLines {
my ($name, $os, $numLines, $arg_ref) = @_;
$os = fromFileGuessOS($name) unless defined($os);
$numLines = 2 unless defined($numLines);
my @OS=("\n", "\r\n", "\r");
# operatoring system: 0 for UNIX (\n as linebreak), 1 for Windows
# (\r\n as linebreak), 2 for MAC (\r as linebreak)
my $encoding = $Data::Table::DEFAULTS{ENCODING};
$encoding = $arg_ref->{encoding} if (defined($arg_ref) && exists $arg_ref->{encoding});
my @lines=();
my $SRC = openFileWithEncoding($name, $encoding);
local($/)=$OS[$os];
my $n_endl = length($OS[$os]);
my $cnt=0;
while(my $line = <$SRC>) {
$cnt++;
for (1..$n_endl) { chop($line); }
push @lines, $line;
last if ($numLines>0 && $cnt>=$numLines);
}
close($SRC);
return @lines;
}
sub fromFileIsHeader {
my ($s, $delimiter, $allowNumericHeader) = @_;
$delimiter=$Data::Table::DEFAULTS{'CSV_DELIMITER'} unless defined($delimiter);
return 0 if (!defined($s) || $s eq "" || $s=~ /$delimiter$/);
my $fields=parseCSV($s, 0, {delimiter=>$delimiter});
my $allNumbers = 1;
foreach my $name (@$fields) {
return 0 unless $name;
#next if $name=~/[^0-9.eE\-+]/;
return 0 if $name=~/^[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?$/ && !$allowNumericHeader;
# modified, so that we allow some columns to be numeric, but not all columns
$allNumbers = 0 unless $name =~ /^[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?$/;
}
#return 0 if $allNumbers;
return 1;
}
sub fromFileGuessDelimiter {
my $s_line= shift;
my @DELIMITER=(",","\t",":");
my $numCol=-1; my $i=-1;
return $Data::Table::DEFAULTS{CSV_DELIMITER} unless @$s_line;
for (my $d=0; $d<@DELIMITER; $d++) {
my $colFound=-1;
foreach my $line (@$s_line) {
unless (defined($line)) {
return $Data::Table::DEFAULTS{CSV_DELIMITER};
} else {
my $header = parseCSV($line, 0, {delimiter=>$DELIMITER[$d]});
if ($colFound<0) {
$colFound = scalar @$header;
} elsif ($colFound != scalar @$header) {
$colFound = -1;
last;
}
}
}
next if $colFound<0;
if ($colFound>$numCol) {
$numCol=$colFound; $i=$d;
}
}
return ($i<0)?$Data::Table::DEFAULTS{CSV_DELIMITER}:$DELIMITER[$i];
}
sub fromFile {
my ($name, $arg_ref) = @_;
my $linesChecked = 2;
my $os = undef;
my $hasHeader = undef;
my $delimiter = undef;
my $format = undef;
my $qualifier = $Data::Table::DEFAULTS{CSV_QUALIFIER};
my $allowNumericHeader = 0;
my $encoding=$Data::Table::DEFAULTS{ENCODING};
if (defined($arg_ref)) {
$linesChecked = $arg_ref->{'linesChecked'} if defined($arg_ref->{'linesChecked'});
$os = $arg_ref->{'OS'};
$hasHeader = $arg_ref->{'has_header'};
$delimiter = $arg_ref->{'delimiter'};
$format = $arg_ref->{'format'};
$qualifier = $arg_ref->{'qualifier'} if defined($arg_ref->{'qualifier'});
$allowNumericHeader = $arg_ref->{'allowNumericHeader'};
$encoding = $arg_ref->{'encoding'};
}
$qualifier = '' if ($format and uc($format) eq 'TSV');
unless (defined($os)) {
$os = fromFileGuessOS($name, {qualifier=>$qualifier, encoding=>$encoding});
$arg_ref->{'OS'}=$os;
}
my @S = fromFileGetTopLines($name, $os, $linesChecked, {encoding=>$encoding});
return undef unless scalar @S;
unless (defined($delimiter)) {
$delimiter = fromFileGuessDelimiter(\@S);
$arg_ref->{'delimiter'} = $delimiter;
}
unless (defined($hasHeader)) {
$hasHeader = fromFileIsHeader($S[0], $delimiter, $allowNumericHeader);
}
my $t = undef;
#print ">>>". join("\n", @S)."\n";
#print "OS=$os, hasHeader=$hasHeader, delimiter=$delimiter\n";
if ($delimiter eq "\t") {
$t=fromTSV($name, $hasHeader, undef, $arg_ref);
} else {
$t=fromCSV($name, $hasHeader, undef, $arg_ref);
}
return $t;
}
## interface to GD::Graph
# use GD::Graph::points;
# $graph = GD::Graph::points->new(400, 300);
# $graph->plot([$t->colRef(1), $t->colRef(2)]);
1;
__END__
=head1 NAME
Data::Table - Data type related to database tables, spreadsheets, CSV/TSV files, HTML table displays, etc.
=head1 SYNOPSIS
News: The package now includes "Perl Data::Table Cookbook" (PDF), which may serve as a better learning material.
To download the free Cookbook, visit https://sites.google.com/site/easydatabase/
# some cool ways to use Table.pm
use Data::Table;
$header = ["name", "age"];
$data = [
["John", 20],
["Kate", 18],
["Mike", 23]
];
$t = Data::Table->new($data, $header, 0); # Construct a table object with
# $data, $header, $type=0 (consider
# $data as the rows of the table).
print $t->csv; # Print out the table as a csv file.
$t = Data::Table::fromCSV("aaa.csv"); # Read a csv file into a table object
### Since version 1.51, a new method fromFile can automatically guess the correct file format
# either CSV or TSV file, file with or without a column header line
# e.g.
# $t = Data::Table::fromFile("aaa.csv");
# is equivalent.
print $t->html; # Display a 'portrait' HTML TABLE on web.
use DBI;
$dbh= DBI->connect("DBI:mysql:test", "test", "") or die $DBI::errstr;
my $minAge = 10;
$t = Data::Table::fromSQL($dbh, "select * from mytable where age >= ?", [$minAge]);
# Construct a table form an SQL
# database query.
$t->sort("age", 0, 0); # Sort by col 'age',numerical,ascending
print $t->html2; # Print out a 'landscape' HTML Table.
$row = $t->delRow(2); # Delete the third row (index=2).
$t->addRow($row, 4); # Add the deleted row back as fifth row.
@rows = $t->delRows([0..2]); # Delete three rows (row 0 to 2).
$col = $t->delCol("age"); # Delete column 'age'.
$t->addCol($col, "age",2); # Add column 'age' as the third column
@cols = $t->delCols(["name","phone","ssn"]);
# Delete 3 columns at the same time.
$name = $t->elm(2,"name"); # Element access
$t2=$t->subTable([1, 3..4],['age', 'name']);
# Extract a sub-table
$t->rename("Entry", "New Entry"); # Rename column 'Entry' by 'New Entry'
$t->replace("Entry", [1..$t->nofRow()], "New Entry");
# Replace column 'Entry' by an array of
# numbers and rename it as 'New Entry'
$t->swap("age","ssn"); # Swap the positions of column 'age'
# with column 'ssn' in the table.
$t->colMap('name', sub {return uc}); # Map a function to a column
$t->sort('age',0,0,'name',1,0); # Sort table first by the numerical
# column 'age' and then by the
# string column 'name' in ascending
# order
$t2=$t->match_pattern('$_->[0] =~ /^L/ && $_->[3]<0.2');
# Select the rows that matched the
# pattern specified
$t2=$t->match_pattern_hash('$_{"Amino acid"} =~ /^L-a/ && $_{"Grams \"(a.a.)\""}<0.2'));
# use column name in the pattern, method added in 1.62
$t2=$t->match_string('John'); # Select the rows that matches 'John'
# in any column
$t2=$t->clone(); # Make a copy of the table.
$t->rowMerge($t2); # Merge two tables
$t->colMerge($t2);
$t = Data::Table->new( # create an employ salary table
[
['Tom', 'male', 'IT', 65000],
['John', 'male', 'IT', 75000],
['Tom', 'male', 'IT', 65000],
['John', 'male', 'IT', 75000],
['Peter', 'male', 'HR', 85000],
['Mary', 'female', 'HR', 80000],
['Nancy', 'female', 'IT', 55000],
['Jack', 'male', 'IT', 88000],
['Susan', 'female', 'HR', 92000]
],
['Name', 'Sex', 'Department', 'Salary'], 0);
sub average { # this is an subroutine calculate mathematical average, ignore NULL
my @data = @_;
my ($sum, $n) = (0, 0);
foreach $x (@data) {
next unless $x;
$sum += $x; $n++;
}
return ($n>0)?$sum/$n:undef;
}
$t2 = $t->group(["Department","Sex"],["Name", "Salary"], [sub {scalar @_}, \&average], ["Nof Employee", "Average Salary"]);
# For each (Department,Sex) pair, calculate the number of employees and average salary
$t2 = $t2->pivot("Sex", 0, "Average Salary", ["Department"]);
# Show average salary information in a Department by Sex spreadsheet
=head1 ABSTRACT
This perl package uses perl5 objects to make it easy for
manipulating spreadsheet data among disk files, database, and Web
publishing.
A table object contains a header and a two-dimensional array of scalars.
Four class methods Data::fromFile, Data::Table::fromCSV, Data::Table::fromTSV, and Data::Table::fromSQL allow users
to create a table object from a CSV/TSV file or a database SQL selection in a snap.
Table methods provide basic access, add, delete row(s) or column(s) operations, as well as more advanced sub-table extraction, table sorting,
record matching via keywords or patterns, table merging, and web publishing.
Data::Table class also provides a straightforward interface to other
popular Perl modules such as DBI and GD::Graph.
The most updated version of the Perl Data::Table Cookbook is available at
https://sites.google.com/site/easydatabase/
We use Data::Table instead of Table, because Table.pm has already been used inside PerlQt module in CPAN.
=head1 INTRODUCTION
A table object has three data members:
=over 4
=item 1. $data:
a reference to an array of array-references.
It's basically a reference to a two-dimensional array.
=item 2. $header:
a reference to a string array. The array contains all the column names.
=item 3. $type = 1 or 0.
1 means that @$data is an array of table columns (fields) (column-based);
0 means that @$data is an array of table rows (records) (row-based);
=back
Row-based/Column-based are two internal implementations for a table object.
E.g., if a spreadsheet consists of two columns lastname and age.
In a row-based table, $data = [ ['Smith', 29], ['Dole', 32] ].
In a column-based table, $data = [ ['Smith', 'Dole'], [29, 32] ].
Two implementations have their pros and cons for different operations.
Row-based implementation is better for sorting and pattern matching,
while column-based one is better for adding/deleting/swapping columns.
Users only need to specify the implementation type of the table upon its
creation via Data::Table::new, and can forget about it afterwards.
Implementation type of a table should be considered volatile, because
methods switch table objects from one type into another internally.
Be advised that row/column/element references gained via table::rowRef,
table::rowRefs, table::colRef, table::colRefs, or table::elmRef may
become stale after other method calls afterwards.
For those who want to inherit from the Data::Table class, internal method
table::rotate is used to switch from one implementation type into another.
There is an additional internal assistant data structure called
colHash in our current implementation. This hash
table stores all column names and their corresponding column index number as
key-value pairs for fast conversion. This gives users an option to use
column name wherever a column ID is expected, so that user don't have to use
table::colIndex all the time. E.g., you may say
$t->rename('oldColName', 'newColName')
instead of $t->rename($t->colIndex('oldColName'), 'newColIdx').
=head1 DESCRIPTION
=head2 Field Summary
=over 4
=item data refto_arrayof_refto_array
contains a two-dimensional spreadsheet data.
=item header refto_array
contains all column names.
=item type 0/1
0 is row-based, 1 is column-based, describe the orientation of @$data.
=back
=head2 Package Variables
=over 4
=item $Data::Table::VERSION
=item @Data::Table::OK
see table::match_string, table::match_pattern, and table::match_pattern_hash
Since 1.62, we recommend you to use $table->{OK} instead, which is a local array reference.
=item @Data::Table::MATCH
see table::match_string, table::match_pattern, and table::match_pattern_hash
Since 1.67, we return the matched row indices in an array. Data::Table::MATCH is this array reference.
Here is an example of setting a max price of 20 to all items with UnitPrice > 20.
$t_product->match_pattern_hash('$_{UnitPrice} > 20');
$t_product->setElm($t_product->{MATCH}, 'UnitPrice', 20);
=item %Data::Table::DEFAULTS
Store default settings, currently it contains CSV_DELIMITER (set to ','), CSV_QUALIFER (set to '"'), and OS (set to 0).
see table::fromCSV, table::csv, table::fromTSV, table::tsv for details.
=back
=head2 Class Methods
Syntax: return_type method_name ( [ parameter [ = default_value ]] [, parameter [ = default_value ]] )
If method_name starts with table::, this is an instance method, it can be used as $t->method( parameters ), where $t is a table reference.
If method_name starts with Data::Table::, this is a class method, it should be called as
Data::Table::method, e.g., $t = Data::Table::fromCSV("filename.csv").
Conventions for local variables:
colID: either a numerical column index or a column name;
rowIdx: numerical row index;
rowIDsRef: reference to an array of column IDs;
rowIdcsRef: reference to an array of row indices;
rowRef, colRef: reference to an array of scalars;
data: ref_to_array_of_ref_to_array of data values;
header: ref to array of column headers;
table: a table object, a blessed reference.
=head2 Table Creation
=over 4
=item table Data::Table::new ( $data = [], $header = [], $type = 0, $enforceCheck = 1)
create a new table.
It returns a table object upon success, undef otherwise.
$data: points to the spreadsheet data.
$header: points to an array of column names. Before version 1.69, a column name must have at least one non-digit character. Since version 1
.69, this is relaxed. Although integer and numeric column names can now be accepted, when accessing a column by integer, it is first interpr
eted as a column name.
$type: 0 or 1 for row-based/column-based spreadsheet.
$enforceCheck: 1/0 to turn on/off initial checking on the size of each row/column to make sure the data argument indeed points to a valid s
tructure.
In 1.63, we introduce constants Data::Table::ROW_BASED and Data::Table::COL_BASED as synonyms for $type. To create an empty Data::Table, use new Data::Table([], [], Data::Table::ROW_BASED);
=item table table::subTable ($rowIdcsRef, $colIDsRef, $arg_ref)
create a new table, which is a subset of the original.
It returns a table object.
$rowIdcsRef: points to an array of row indices (or a true/false row mask array).
$colIDsRef: points to an array of column IDs.
The function make a copy of selected elements from the original table.
Undefined $rowIdcsRef or $colIDsRef is interpreted as all rows or all columns.
The elements in $colIDsRef may be modified as a side effect before version 1.62, fixed in 1.62.
If $arg_ref->{useRowMask} is set to 1, $rowIdcsRef is a true/false row mask array, where rows marked as TRUE will be returned. Row mask array is typically the Data::Table::OK set by match_string/match_pattern/match_pattern_hash methods.
=item table table::clone
make a clone of the original.
It return a table object, equivalent to table::subTable(undef,undef).
=item table Data::Table::fromCSV ($name_or_handler, $includeHeader = 1, $header = ["col1", ... ], {OS=>$Data::Table::DEFAULTS{'OS'}, delimiter=>$Data::Table::DEFAULTS{'CSV_DELIMITER'}, qualifier=>$Data::Table::DEFAULTS{'CSV_QUALIFIER'}, skip_lines=>0, skip_pattern=>undef, encoding=>$Data::Table::DEFAULTS{'ENCODING'}})
create a table from a CSV file.
return a table object.
$name_or_handler: the CSV file name or an already opened file handler. If a handler is used, it's not closed upon return. To read from STDIN, use Data::Table::fromCSV(\*STDIN, 1).
$includeHeader: 0 or 1 to ignore/interpret the first line in the file as column names,
If it is set to 0, the array in $header is used. If $header is not supplied, the default column names are "col1", "col2", ...
optional named argument OS specifies under which operating system the CSV file was generated. 0 for UNIX, 1 for PC and 2 for MAC. If not specified, $Data::Table::DEFAULTS{'OS'} is used, which defaults to UNIX. Basically linebreak is defined as "\n", "\r\n" and "\r" for three systems, respectively.
optional name argument delimiter and qualifier let user replace comma and double-quote by other meaningful single characters. <b>Exception</b>: if the delimiter or the qualifier is a special symbol in regular expression, you must escape it by '\'. For example, in order to use pipe symbol as the delimiter, you must specify the delimiter as '\|'.
optional name argument skip_lines let you specify how many lines in the csv file should be skipped, before the data are interpretted.
optional name argument skip_pattern let you specify a regular expression. Lines that match the regular expression will be skipped.
optional name argument encoding let you specify an encoding method of the csv file. This option is added to fromCSV, fromTSV, fromFile since version 1.69.
The following example reads a DOS format CSV file and writes a MAC format:
$t = Data::Table:fromCSV('A_DOS_CSV_FILE.csv', 1, undef, {OS=>1});
$t->csv(1, {OS=>2, file=>'A_MAC_CSV_FILE.csv'});
open(SRC, 'A_DOS_CSV_FILE.csv') or die "Cannot open A_DOS_CSV_FILE.csv to read!";
$t = Data::Table::fromCSV(\*SRC, 1);
close(SRC);
The following example reads a non-standard CSV file with : as the delimiter, ' as the qaulifier
my $s="col_A:col_B:col_C\n1:2, 3 or 5:3.5\none:'one:two':'double\", single'''";
open my $fh, "<", \$s or die "Cannot open in-memory file\n";
my $t_fh=Data::Table::fromCSV($fh, 1, undef, {delimiter=>':', qualifier=>"'"});
close($fh);
print $t_fh->csv;
# convert to the standard CSV (comma as the delimiter, double quote as the qualifier)
# col_A,col_B,col_C
# 1,"2, 3 or 5",3.5
# one,one:two,"double"", single'"
print $t->csv(1, {delimiter=>':', qualifier=>"'"}); # prints the csv file use the original definition
The following example reads bbb.csv file (included in the package) by skipping the first line (skip_lines=>1), then treats any line that starts with '#' (or space comma) as comments (skip_pattern=>'^\s*#'), use ':' as the delimiter.
$t = Data::Table::fromCSV("bbb.csv", 1, undef, {skip_lines=>1, delimiter=>':', skip_pattern=>'^\s*#'});
Use the optional name argument encoding to specify file encoding method.
$t = Data::Table::fromCSV("bbb.csv", 1, undef, {encoding=>'UTF-8'});
=item table table::fromCSVi ($name, $includeHeader = 1, $header = ["col1", ... ])
Same as Data::Table::fromCSV. However, this is an instant method (that's what 'i' stands for), which can be inherited.
=item table Data::Table::fromTSV ($name, $includeHeader = 1, $header = ["col1", ... ], {OS=>$Data::Table::DEFAULTS{'OS'}, skip_lines=>0, skip_pattern=>undef, transform_element=>1, encoding=>$Data::Table::DEFAULTS{'ENCODING'}})
create a table from a TSV file.
return a table object.
$name: the TSV file name or an already opened file handler. If a handler is used, it's not closed upon return. To read from STDIN, use Data::Table::fromTSV(\*STDIN, 1).
$includeHeader: 0 or 1 to ignore/interpret the first line in the file as column names,
If it is set to 0, the array in $header is used. If $header is not supplied, the default column names are "col1", "col2", ...
optional named argument OS specifies under which operating system the TSV file was generated. 0 for UNIX, 1 for P
C and 2 for MAC. If not specified, $Data::Table::DEFAULTS{'OS'} is used, which defaults to UNIX. Basically linebreak is defined as "\n", "\r\n" and "\r" for three systems, respectively. <b>Exception</b>: if the delimiter or the qualifier is a special symbol in regular expression, you must escape it by '\'. For example, in order to use pipe symbol as the delimiter, you must specify the delimiter as '\|'.
optional name argument skip_lines let you specify how many lines in the csv file should be skipped, before the data are interpretted.
optional name argument skip_pattern let you specify a regular expression. Lines that match the regular expression will be skipped.
optional name argument transform_element let you switch on/off \t to tab, \N to undef (etc.) transformation. See TSV FORMAT for details. However, elements are always transformed when export table to tsv format, because not escaping an element containing a tab will be disasterous.
optional name argument encoding enables one to provide an encoding method when open the tsv file.
See similar examples under Data::Table::fromCSV;
Note: read "TSV FORMAT" section for details.
=item table table::fromTSVi ($name, $includeHeader = 1, $header = ["col1", ... ])
Same as Data::Table::fromTSV. However, this is an instant method (that's what 'i' stands for), which can be inherited.
=item table Data::Table::fromFile ($file_name, $arg_ref = {linesChecked=>2, allowNumericHeader=>0, encoding=>$Data::Table::DEFAULTS{'ENCODING'}})
create a table from a text file.
return a table object.
$file_name: the file name (cannot take a file handler).
linesChecked: the first number of lines used for guessing the input format. The delimiter will have to produce the same number of columns for these lines. By default only check the first 2 lines, 0 means all lines in the file.
$arg_ref can take additional parameters, such as OS, has_header, delimiter, transform_element, etc. Encoding allows one to specify encoding methods used to open the file, which defaults to UTF-8.
fromFile is added after version 1.51. It relies on the following new methods to automatically figure out the correct file format in order to call fromCSV or fromTSV internally:
fromFileGuessOS($file_name, {encoding=>'UTF-8'})
returns integer, 0 for UNIX, 1 for PC, 2 for MAC
fromFileGetTopLines($file_name, $os, $lineNumber, {encoding=>'UTF-8'}) # $os defaults to fromFileGuessOS($file_name), if not specified
returns an array of strings, each string represents each row with linebreak removed.
fromFileGuessDelimiter($lineArrayRef) # guess delimiter from ",", "\t", ":";
returns the guessed delimiter string.
fromFileIsHeader($line_concent, $delimiter, $allowNumericHeader) # $delimiter defaults to $Data::Table::DEFAULTS{'CSV_DELIMITER'}
returns 1 or 0.
It first ask fromFileGuessOS to figure out which OS (UNIX, PC or MAC) generated the input file. The fetch the first linesChecked lines using fromFileGetTopLines. It then guesses the best delimiter using fromFileGuessDelimiter, then it checks if the first line looks like a column header row using fromFileIsHeader. Since fromFileGuessOS and fromFileGetTopLines needs to open/close the input file, these methods can only take file name, not file handler. If user specify formatting parameters in $arg_ref, the routine will skip the corresponding guess work. At the end, fromFile simply calls either fromCSV or fromTSV with $arg_ref forwarded. So if you call fromFile({transform_element=>0}) on a TSV file, transform_elment will be passed onto fromTSV calls internally.
fromFileGuessOS finds the linebreak that gives shortest first line (in the priority of UNIX, PC, MAC upon tie).
fromFileGuessDelimiter works based on the assumption that the correct delimiter will produce equal number of columns for the given rows. If multiple matches, it chooses the delimiter that gives maximum number of columns. If none matches, it returns the default delimiter.
fromFileIsHeader works based on the assumption that no column header can be empty or numeric values. However, if we allow numeric column names (especially integer column names), set {allowNumericHeader => 1}
=item table Data::Table::fromSQL ($dbh, $sql, $vars)
create a table from the result of an SQL selection query.
It returns a table object upon success or undef otherwise.
$dbh: a valid database handler.
Typically $dbh is obtained from DBI->connect, see "Interface to Database" or DBI.pm.
$sql: an SQL query string or a DBI::st object (starting in version 1.61).
$vars: optional reference to an array of variable values,
required if $sql contains '?'s which need to be replaced
by the corresponding variable values upon execution, see DBI.pm for details.
Hint: in MySQL, Data::Table::fromSQL($dbh, 'show tables from test') will also create a valid table object.
Data::Table::fromSQL now can take DBI::st instead of a SQL string. This is introduced, so that variable binding (such as CLOB/BLOB) can be done outside the method, for example:
$sql = 'insert into test_table (id, blob_data) values (1, :val)';
$sth = $dbh->prepare($sql);
$sth->bind_param(':val', $blob, {ora_type => SQLT_BIN});
Data::Table::fromSQL($dbh, $sth);
=item table Data::Table::fromSQLi ($dbh, $sql, $vars)
Same as Data::Table::fromSQL. However, this is an instant method (that's what 'i' stands for), whic
h can be inherited.
=back
=head2 Table Access and Properties
=over 4
=item int table::colIndex ($colID)
translate a column name into its numerical position, the first column has index 0 as in as any perl array.
return -1 for invalid column names.
Since 1.69, we allow integer to be used as a column header. The integer $colID will first be checked against column names, if matched, the corresponding column index is returned. E.g., if column name for the 3rd column is "1", colIndex(1) will return 2 instead of 1! In such case, if one need to access the second column, one has to access it by column name, i.e., $t->col(($t->header)[1]).
=item int table::nofCol
return number of columns.
=item int table::nofRow
return number of rows.
=item int table::lastCol
return the index of the last columns, i.e., nofCol - 1.
=item int table::lastRow
return the index of the last rows, i.e., nofRow - 1; This is syntax sugar.
# these two are equivalent
foreach my $i (0 .. $t->lastRow)
foreach my $i (0 .. $t->nofRow - 1)
=item bool table::isEmpty
return whether the table has any column, introduced in 1.63.
=item bool table::hasCol($colID)
returns whether the colID is a table column, introduced in 1.63.
=item bool table::colName($colNumericIndex)
returns the column name for a numeric column index, notice the first column has an index of 0. Introduced in 1.68.
=item scalar table::elm ($rowIdx, $colID)
return the value of a table element at [$rowIdx, $colID],
undef if $rowIdx or $colID is invalid.
=item refto_scalar table::elmRef ($rowIdx, $colID)
return the reference to a table element at [$rowIdx, $colID], to allow possible modification.
It returns undef for invalid $rowIdx or $colID.
=item array table::header ($header)
Without argument, it returns an array of column names.
Otherwise, use the new header.
=item int table::type
return the implementation type of the table (row-based/column-based) at the time,
be aware that the type of a table should be considered as volatile during method calls.
=back
=head2 Table Formatting
=over 4
=item string table::csv ($header, {OS=>$Data::Table::DEFAULTS{'OS'}, file=>undef, delimiter=>$Data::Table::DEFAULTS{'CSV_DELIMITER'}, qualifier=>$Data::Table::DEFAULTS{'CSV_QAULIFIER'}})
return a string corresponding to the CSV representation of the table.
$header controls whether to print the header line, 1 for yes, 0 for no.
optional named argument OS specifies for which operating system the CSV file is generated. 0 for UNIX, 1 for P
C and 2 for MAC. If not specified, $Data::Table::DEFAULTS{'OS'} is used. Basically linebreak is defined as "\n", "\r\n" and "\r" for three systems, respectively.
if 'file' is given, the csv content will be written into it, besides returning the string.
One may specify custom delimiter and qualifier if the other than default are desired.
=item string table::tsv
return a string corresponding to the TSV representation of the table.
$header controls whether to print the header line, 1 for yes, 0 for no.
optional named argument OS specifies for which operating system the TSV file is generated. 0 for UNIX, 1 for P
C and 2 for MAC. If not specified, $Data::Table::DEFAULTS{'OS'} is used. Basically linebreak is defined as "\n", "\r\n" and "\r" for three systems, respectively.
if 'file' is given, the tsv content will be written into it, besides returning the string.
Note: read "TSV FORMAT" section for details.
=item string table::html ($colorArrayRef_or_colorHashRef = ["#D4D4BF","#ECECE4","#CCCC99"],
$tag_tbl = {border => '1'},
$tag_tr = {align => 'left'},
$tag_th = {align => 'center'},
$tag_td = {col3 => 'align="right" valign="bottom"', 4 => 'align="left"'},
$l_portrait = 1,
$callback = undef
)
return a string corresponding to a 'Portrait/Landscape'-style html-tagged table.
$colorArrayRef_or_colorHashRef: If a hash reference is provided, it will take three CSS class names for odd data rows, even data rows and for the header row. The default hash is {even=>"data_table_even", odd=>"data_table_odd", header=>"data_table_header").
If a hash reference is not found, a reference to an array of three color strings is expected to provided for backgrounds for even-row records, odd-row records, and -der row, respectively. A default color array ("#D4D4BF","#ECECE4","#CCCC99") will be used if $colors isn't defined.
Since version 1.74, users can prevent default coloring by passing in a color array reference ["", "", ""].
Before version 1.59, the parameter can only accept an array reference.
$tag_tbl: a reference to a hash that specifies any legal attributes such as name, border,
id, class, etc. for the TABLE tag.
$tag_tr: a reference to a hash that specifies any legal attributes for the TR tag.
$tag_th: a reference to a hash that specifies any legal attributes for the TH tag.
$tag_td: a reference to a hash that specifies any legal attributes for the TD tag.
Notice $tag_tr and $tag_th controls all the rows and columns of the whole table. The keys of the hash are the attribute names in these cases. However, $tag_td is column specific, i.e., you should specify TD attributes for every column separately.
The key of %$tag_td are either column names or column indices, the value is a reference to a hash. E.g., $tag_td = {col3 => {'style'=>'background-color:#cccc99;'}}. However, before version 1.74, the value is the full string to be inserted into the TD tag. E.g., $tag_td = {col3 => 'align=right valign=bottom} only change the TD tag in "col3" to be <TD align=right valign=bottom>;. This format is still supported for backward compatibility.
$portrait controls the layout of the table. The default is 1, i.e., the table is shown in the
"Portrait" style, like in Excel. 0 means "Landscape". Since version 1.59, tbody and thead tags are added to the portrait mode output.
Since version 1.74, $callback is introduced to give users fine control on the tag for each cell, i.e., for each th/td cells. $callback is a subroutine reference, where the sub is expected to take parameters ($tag, $row_index, $col_index, $col_name, $table), $tag is reference to a hash containing existing TH/TD tags, the sub will return a new tag. The rest of the parameters give sub access to the identity of the table cell, as well as the table itself.
If the following example, the callback function colors each UnitPrice cell based on whether its value is >=20 or <20. It colors each Discontinued cell based on whether its value is TRUE or FALSE. One can also control the column header cells, which has row index of -1. That is the reason we use "$row >=0 " within callback to make sure it cell is not a column header.
$t=Data::Table::fromCSV("Data-Table-1.74/Product.csv",1,undef, {'OS'=>1});
my $callback = sub {
my ($tag, $row, $col, $colName, $table) = @_;
if ($row >=0 && $colName eq 'UnitPrice') {
$tag->{'style'} = 'background-color:'. (($table->elm($row, $col)>=20) ? '#fc8d59':'#91bfdb') . ';';
}
if ($row >=0 && $colName eq 'Discontinued') {
$tag->{'style'} = 'background-color:'. (($table->elm($row, $col) eq 'TRUE') ? '#999999':'#af8dc3') .';';
}
return $tag;
};
print $t->html(undef, undef, undef, undef, undef, undef, $callback);
Attention: You will have to escape HTML-Entities yourself (for example '<' as '<'), if you have characters in you table which need to be escaped. You can do this for example with the escapeHTML-function from CGI.pm (or the HTML::Entities module).
use CGI qw(escapeHTML);
[...]
$t->colMap($columnname, sub{escapeHTML($_)}); # for every column, where HTML-Entities occur.
=item string table::html2 ($colors = ["#D4D4BF","#ECECE4","#CCCC99"],
$specs = {'name' => '', 'border' => '1', ...})
This method is deprecated. It's here for compatibility. It now simple call html method with $portrait = 0, see previous description.
return a string corresponding to a "Landscape" html-tagged table.
This is useful to present a table with many columns, but very few entries.
Check the above table::html for parameter descriptions.
=item string table::wiki(...)
This method accepts the same parameters as table::html, returns a wikitable instead.
=item string table::wiki2(...)
This method accepts the same parameters as table::html2, returns a wikitable instead in landscape orientation.
=back
=head2 Table Operations
=over 4
=item int table::setElm ($rowIdx, $colID, $val)
modify the value of a table element at [$rowIdx, $colID] to a new value $val.
It returns 1 upon success, undef otherwise.
In 1.68, setElm can manipulate multiple elements, i.e., $rowIdx and $colIdx can be references to an index array, and setElm() will modifies all cells defined by the grid.
$t->setElm([0..2], ['ColA', 'ColB'], 'new value');
$t->setElm(0, [1..2], 'new value');
# puts a limit on the price of all expensive items
$t_product->match_pattern_hash('$_{UnitPrice} > 20');
$t_product->setElm($t_product->{MATCH}, 'UnitPrice', 20);
=item int table::addRow ($rowRef, $rowIdx = table::nofRow, $arg_ref = {addNewCol => 0})
add a new row ($rowRef may point to the actual list of scalars, or it can be a hash_ref (supported since version 1.60)). If $rowRef points to a hash, the method will lookup the value of a field by ts column name: $rowRef->{colName}, if not found, undef is used for that field.
The new row will be referred as $rowIdx as the result. E.g., addRow($aRow, 0) will put the new row as the very first row. By default, it appends a row to the end.
In 1.67, we support {addNewCol => 1}, if specified, a new column will be automatically created for each new element encountered in the $rowRef.
# automatically add a new column "aNewColumn" to $t, in order to hold the new value
$t->addRow({anExistingColumn => 123, aNewColumn => "XYZ"}, undef, {addNewCol => 1});
# $t only had one column, after this call, it will contain a new column 'col2', in order to hold the new value
$t->addRow([123, "XYZ"], undef, {addNewCol => 1});
It returns 1 upon success, undef otherwise.
=item refto_array table::delRow ( $rowIdx )
delete a row at $rowIdx. It will the reference to the deleted row.
=item refto_array table::delRows ( $rowIdcsRef )
delete rows in @$rowIdcsRef. It will return an array of deleted rows in the same order of $rowIdcsRef upon success.
upon success.
=item int table::addCol ($colRef, $colName, $colIdx = numCol)
add a new column ($colRef points to the actual data), the new column will be referred as $colName or $colIdx as the result. E.g., addCol($aCol, 'newCol', 0) will put the new column as the very first column.
By default, append a column to the end.
It will return 1 upon success or undef otherwise.
In 1.68, $colRef can be a scalar, which is the default value that can be used to create the new column. E.g., to create a new column with default value of undef, 0, 'default', respectively, one can do:
$t->addCol(undef, 'NewCol');
$t->addCol(0, 'NewIntCol');
$t->addCol('default', 'NewStringCol');
=item refto_array table::delCol ($colID)
delete a column at $colID
return the reference to the deleted column.
=item arrayof_refto_array table::delCols ($colIDsRef)
delete a list of columns, pointed by $colIDsRef. It will
return an array of deleted columns in the same order of $colIDsRef upon success.
=item refto_array table::rowRef ($rowIdx)
return a reference to the row at $rowIdx
upon success or undef otherwise.
=item refto_arrayof_refto_array table::rowRefs ($rowIdcsRef)
return a reference to array of row references upon success, undef otherwise.
=item array table::row ($rowIdx)
return a copy of the row at $rowIdx
upon success or undef otherwise.
=item refto_hash table::rowHashRef ($rowIdx)
return a reference to a hash, which contains a copy of the row at $rowIdx,
upon success or undef otherwise. The keys in the hash are column names, and
the values are corresponding elements in that row. The hash is a copy, therefore modifying the hash values doesn't change the original table.
=item refto_array table::colRef ($colID)
return a reference to the column at $colID
upon success.
=item refto_arrayof_refto_array table::colRefs ($colIDsRef)
return a reference to array of column references upon success.
=item array table::col ($colID)
return a copy to the column at $colID
upon success or undef otherwise.
=item int table::rename ($colID, $newName)
rename the column at $colID to a $newName
(the newName must be valid,
and should not be identical to any other existing column names).
It returns 1 upon success
or undef otherwise.
=item refto_array table::replace ($oldColID, $newColRef, $newName)
replace the column at $oldColID by the array pointed by $newColRef, and renamed it to $newName. $newName is optional if you don't want to rename the column.
It returns 1 upon success or undef otherwise.
=item int table::swap ($colID1, $colID2)
swap two columns referred by $colID1 and $colID2.
It returns 1 upon success or undef otherwise.
=item int table::moveCol($colID, $colIdx, $newColName)
move column referred by $colID to a new location $colIdx.
If $newColName is specified, the column will be renamed as well.
It returns 1 upon success or undef otherwise.
=item int table::reorder($colIDRefs, $arg_ref)
Rearrange the columns according to the order specified in $colIDRef. Columns not specified in the reference array will be appended to the end!
If one would like to drop columns not specified, set $arg_ref to {keepRest => 0}.
reorder() changes the table itself, while subTable(undef, $colIDRefs) will return a new table. reorder() might also runs faster than subTable, as elements may not need to be copied.
=item int table::colMap ($colID, $fun)
foreach element in column $colID, map a function $fun to it.
It returns 1 upon success or undef otherwise.
This is a handy way to format a column. E.g. if a column named URL contains URL strings, colMap("URL", sub {"<a href='$_'>$_</a>"}) before html() will change each URL into a clickable hyper link while displayed in a web browser.
=item int table::colsMap ($fun)
foreach row in the table, map a function $fun to it.
It can do whatever colMap can do and more.
It returns 1 upon success or undef otherwise.
colMap function only give $fun access to the particular element per row, while colsMap give $fun full access to all elements per row. E.g. if two columns named duration and unit (["2", "hrs"], ["30", "sec"]). colsMap(sub {$_->[0] .= " (".$_->[1].")"; } will change each row into (["2 hrs", "hrs"], ["30 sec", "sec"]).
As show, in the $func, a column element should be referred as $_->[$colIndex].
=item int table::sort($colID1, $type1, $order1, $colID2, $type2, $order2, ... )
sort a table in place.
First sort by column $colID1 in $order1 as $type1, then sort by $colID2 in $order2 as $type2, ...
$type is 0 for numerical and 1 for others;
$order is 0 for ascending and 1 for descending;
In 1.62, instead of memorize these numbers, you can use constants instead (notice constants do not start with '$').
Data::Table::NUMBER
Data::Table::STRING
Data::Table::ASC
Data::Table::DESC
Sorting is done in the priority of colID1, colID2, ...
It returns 1 upon success or undef otherwise.
Notice the table is rearranged as a result! This is different from perl's list sort, which returns a sorted copy while leave the original list untouched,
the authors feel inplace sorting is more natural.
table::sort can take a user supplied operator, this is useful when neither numerical nor alphabetic order is correct.
$Well=["A_1", "A_2", "A_11", "A_12", "B_1", "B_2", "B_11", "B_12"];
$t = Data::Table->new([$Well], ["PlateWell"], 1);
$t->sort("PlateWell", 1, 0);
print join(" ", $t->col("PlateWell"));
# prints: A_1 A_11 A_12 A_2 B_1 B_11 B_12 B_2
# in string sorting, "A_11" and "A_12" appears before "A_2";
my $my_sort_func = sub {
my @a = split /_/, $_[0];
my @b = split /_/, $_[1];
my $res = ($a[0] cmp $b[0]) || (int($a[1]) <=> int($b[1]));
};
$t->sort("PlateWell", $my_sort_func, 0);
print join(" ", $t->col("PlateWell"));
# prints the correct order: A_1 A_2 A_11 A_12 B_1 B_2 B_11 B_12
=item table table::match_pattern ($pattern, $countOnly)
return a new table consisting those rows evaluated to be true by $pattern
upon success or undef otherwise. If $countOnly is set to 1, it simply returns the number of rows that matches the string without making a new copy of table. $countOnly is 0 by default.
Side effect: @Data::Table::OK (should use $t->{OK} after 1.62) stores a true/false array for the original table rows. Using it, users can find out what are the rows being selected/unselected.
Side effect: @Data::Table::MATCH stores a reference to an array containing all row indices for matched rows.
In the $pattern string, a column element should be referred as $_->[$colIndex]. E.g., match_pattern('$_->[0]>3 && $_->[1]=~/^L') retrieve all the rows where its first column is greater than 3 and second column starts with letter 'L'. Notice it only takes colIndex, column names are not acceptable here!
=item table table::match_pattern_hash ($pattern, $countOnly)
return a new table consisting those rows evaluated to be true by $pattern
upon success or undef otherwise. If $countOnly is set to 1, it simply returns the number of rows that matches the string without making a new copy of table. $countOnly is 0 by default.
Side effect: @Data::Table::OK stores a reference to a true/false array for the original table rows. Using it, users can find out what are the rows being selected/unselected.
Side effect: @Data::Table::MATCH stores a reference to an array containing all row indices for matched rows.
In the $pattern string, a column element should be referred as ${column_name}.
match_pattern_hash() is added in 1.62. The difference between this method and match_pattern is each row is fed to the pattern as a hash %_.
In the case of match_pattern, each row is fed as an array ref $_. The pattern for match_pattern_hash() becomes much cleaner.
If a table has two columns: Col_A as the 1st column and Col_B as the 2nd column, a filter "Col_A>2 AND Col_B<2" is written before as
$t->match_pattern('$_->[0] > 2 && $_->[1] <2');
where we need to figure out $t->colIndex('Col_A') is 0 and $t->colIndex('Col_B') is 1, in order to build the pattern.
Now you can use column name directly in the pattern:
$t->match_pattern_hash('$_{Col_A} >2 && $_{Col_B} <2');
This method creates $t->{OK}, as well as @Data::Table::OK, same as match_pattern().
=item table table::match_string ($s, $caseIgnore, $countOnly)
return a new table consisting those rows contains string $s in any of its fields upon success, undef otherwise. if $caseIgnore evaluated to true, case will is be ignored (s/$s/i). If $countOnly is set to 1, it simply returns the number of rows that matches the string without making a new copy of table. $countOnly is 0 by default.
Side effect: @Data::Table::OK stores a reference to a true/false array for the original table rows.
Side effect: @Data::Table::MATCH stores a reference to an array containing all row indices for matched rows.
Using it, users can find out what are the rows being selected/unselected.
The $s string is actually treated as a regular expression and
applied to each row element, therefore one can actually specify several keywords
by saying, for instance, match_string('One|Other').
=item table table::rowMask($mask, $complement)
mask is reference to an array, where elements are evaluated to be true or false. The size of the mask must be equal to the nofRow of the table. return a new table consisting those rows where the corresponding mask element is true (or false, when complement is set to true).
E.g., $t1=$tbl->match_string('keyword'); $t2=$tbl->rowMask(\@Data::Table::OK, 1) creates two new tables. $t1 contains all rows match 'keyword', while $t2 contains all other rows.
mask is reference to an array, where elements are evaluated to be true or false. The size of the mask must be equal to the nofRow of the table. return
a new table consisting those rows where the corresponding mask element is true (or false, when complement is set to true).
E.g., $t1=$tbl->match_string('keyword'); $t2=$tbl->rowMask(\@Data::Table::OK, 1) creates two new tables. $t1 contains all rows match 'keyword', while
$t2 contains all other rows.
=item table table::iterator({$reverse => 0})
Returns a reference to a enumerator routine, which enables one to loop through each table row. If $reverse is set to 1, it will enumerate backward. The convenience here is each row is fetch as a rowHashRef, so one can easily access row elements by name.
my $next = $t_product->iterator();
while (my $row = $next->()) {
# have access to a row as a hash reference, access row number by &$next(1);
$t_product->setElm($next->(1), 'ProductName', 'New! '.$row->{ProductName});
}
In this example, each $row is fetched as a hash reference, so one can access the elements by $row->{colName}.
Be aware that the elements in the hash is a copy of the original table elements, so modifying $row->{colName} does not modify the original table. If table modification is intended, one needs to obtain the row index of the returned row. $next->(1) call with a non-empty argument returns the row index of the record that was previously fetched with $next->(). In this example, one uses the row index to modify the original table.
=item table table::each_group($colsToGroupBy, $funsToApply)
Primary key columns are specified in $colsToGroupBy. All rows are grouped by primary keys first (keys sorted as string). Then for each group, subroutines $funToAppy is applied to corresponding rows.
$funToApply are passed with two parameters ($tableRef, $rowIDsRef). All rows sharing the key are passed in as a Data::Table object (with all columns and in the order of ascending row index) in the first parameter.
The second optional parameter contains an array of row indices of the group members. Since all rows in the passed-in table contains the same keys, the key value can be obtained from its first table row.
=item table table::group($colsToGroupBy, $colsToCalculate, $funsToApply, $newColNames, $keepRestCols)
Primary key columns are specified in $colsToGroupBy. All rows are grouped by primary keys first. Then for each group, an array of subroutines (in $funsToAppy) are applied to corresponding columns and yield a list of new columns (specified in $newColNames).
$colsToGroupBy, $colsToCalculate are references to array of colIDs. $funsToApply is a reference to array of subroutine references. $newColNames are a
reference to array of new column name strings. If specified, the size of arrays pointed by $colsToCalculate, $funsToApply and $newColNames should be i
dentical. A column may be used more than once in $colsToCalculate.
$keepRestCols is default to 1 (was introduced as 0 in 1.64, changed to 1 in 1.66 for backward compatibility) introduced in 1.64), otherwise, the remaining columns are returned with the first encountered value of that group.
E.g., an employee salary table $t contains the following columns: Name, Sex, Department, Salary. (see examples in the SYNOPSIS)
$t2 = $t->group(["Department","Sex"],["Name", "Salary"], [sub {scalar @_}, \&average], ["Nof Employee", "Average Salary"], 0);
Department, Sex are used together as the primary key columns, a new column "Nof Employee" is created by counting the number of employee names in each group, a new column "Average Salary" is created by averaging the Salary data falled into each group. As the result, we have the head count and average salary information for each (Department, Sex) pair. With your own functions (such as sum, product, average, standard deviation, etc), group method is very handy for accounting purpose.
If primary key columns are not defined, all records will be treated as one group.
$t2 = $t->group(undef,["Name", "Salary"], [sub {scalar @_}, \&average], ["Nof Employee", "Average Salary"], 0);
The above statement will output the total number of employees and their average salary as one line.
=item table table::pivot($colToSplit, $colToSplitIsStringOrNumeric, $colToFill, $colsToGroupBy, $keepRestCols)
Every unique values in a column (specified by $colToSplit) become a new column. undef value become "NULL". $colToSplitIsStringOrNumeric is set to numeric (0 or Data::Table:NUMBER), the new column names are prefixed by "oldColumnName=". The new cell element is filled by the value specified by $colToFill (was 1/0 before version 1.63).
Note: yes, it seems I made an incompatible change in version 1.64, where $colToSplitIsStringOrNumber used to be $colToSplitIsNumeric, where 0 meant STRING and 1 meant NUMBER. Now it is opposite. However, I also added auto-type detection code, that this parameter essentially is auto-guessed and most old code should behave the same as before.
When primary key columns are specified by $colsToGroupBy, all records sharing the same primary key collapse into one row, with values in $colToFill filling the corresponding new columns. If $colToFill is not specified, a cell is filled with the number of records fall into that cell.
$colToSplit and $colToFill are colIDs. $colToSplitIsNumeric is 1/0. $colsToGroupBy is a reference to array of colIDs. $keepRestCols is 1/0, by default is 0. If $keepRestCols is off, only primary key columns and new columns are exported, otherwise, all the rest columns are exported as well.
E.g., applying pivot method to the resultant table of the example of the group method.
$t2->pivot("Sex", 0, "Average Salary",["Department"]);
This creates a 2x3 table, where Departments are use as row keys, Sex (female and male) become two new columns. "Average Salary" values are used to fill the new table elements. Used together with group method, pivot method is very handy for accounting type of analysis.
If $colsToGroupBy is left as undef, all rows are treated as one group. If $colToSplit is left as undef, the method will generate a column named "(all)" that matches all records share the corresponding primary key.
=item table table::melt($keyCols, $variableCols, $arg_ref)
The idea of melt() and cast() are taken from Hadley Wickham's Reshape package in R language.
A table is first melt() into a tall-skiny format, where measurements are stored in the format of a variable-value pair per row.
Such a format can then be easily cast() into various contingency tables.
One needs to specify the columns consisting of primary keys, columns that are consider as variable columns. The output variable column is named 'variable' unless specified by $arg_ref{variableColName}. The output value column is named 'value', unless specified in $arg_ref{valueColName}. By default NULL values are not output, unless $arg_ref{skip_NULL} is set to false. By default empty string values are kept, unless one sets skip_empty to `.
For each object (id), we measure variable x1 and x2 at two time points
$t = new Data::Table([[1,1,5,6], [1,2,3,5], [2,1,6,1], [2,2,2,4]], ['id','time','x1','x2'], Data::Table::ROW_BASED);
# id time x1 x2
# 1 1 5 6
# 1 2 3 5
# 2 1 6 1
# 2 2 2 4
# melting a table into a tall-and-skinny table
$t2 = $t->melt(['id','time']);
#id time variable value
# 1 1 x1 5
# 1 1 x2 6
# 1 2 x1 3
# 1 2 x2 5
# 2 1 x1 6
# 2 1 x2 1
# 2 2 x1 2
# 2 2 x2 4
# casting the table, &average is a method to calculate mean
# for each object (id), we calculate average value of x1 and x2 over time
$t3 = $t2->cast(['id'],'variable',Data::Table::STRING,'value', \&average);
# id x1 x2
# 1 4 5.5
# 2 4 2.5
=item table table::cast($colsToGroupBy, $colToSplit, $colToSplitIsStringOrNumeric, $colToCalculate, $funToApply)
see melt(), as melt() and cast() are meant to use together.
The table has been melten before. cast() group the table according to primary keys specified in $colsToGroupBy. For each group of objects sharing the same id,
it further groups values (specified by $colToCalculate) according to unique variable names (specified by $colToSplit). Then it applies subroutine $funToApply to obtain an aggregate value.
For the output, each unique primary key will be a row, each unique variable name will become a column, the cells are the calculated aggregated value.
If $colsToGroupBy is undef, all rows are treated as within the same group. If $colToSplit is undef, a new column "(all)" is used to hold the results.
$t = Data::Table->new( # create an employ salary table
[
['Tom', 'male', 'IT', 65000],
['John', 'male', 'IT', 75000],
['Tom', 'male', 'IT', 65000],
['John', 'male', 'IT', 75000],
['Peter', 'male', 'HR', 85000],
['Mary', 'female', 'HR', 80000],
['Nancy', 'female', 'IT', 55000],
['Jack', 'male', 'IT', 88000],
['Susan', 'female', 'HR', 92000]
],
['Name', 'Sex', 'Department', 'Salary'], Data::Table::ROW_BASED);
# get a Department x Sex contingency table, get average salary across all four groups
print $t->cast(['Department'], 'Sex', Data::Table::STRING, 'Salary', \&average)->csv(1);
Department,female,male
IT,55000,73600
HR,86000,85000
# get average salary for each department
print $t->cast(['Department'], undef, Data::Table::STRING, 'Salary', \&average)->csv(1);
Department,(all)
IT,70500
HR,85666.6666666667
# get average salary for each gender
print $t->cast(['Sex'], undef, Data::Table::STRING, 'Salary', \&average)->csv(1);
Sex,(all)
male,75500
female,75666.6666666667
# get average salary for all records
print $t->cast(undef, undef, Data::Table::STRING, 'Salary', \&average)->csv(1);
(all)
75555.5555555556
=back
=head2 Table-Table Manipulations
=over 4
=item int table::rowMerge ($tbl, $argRef)
Append all the rows in the table object $tbl to the original rows.
Before 1.62, the merging table $tbl must have the same number of columns as the original, as well as the columns are in exactly the same order.
It returns 1 upon success, undef otherwise.
The table object $tbl should not be used afterwards, since it becomes part of
the new table.
Since 1.62, you may provide {byName =>1, addNewCol=>1} as $argRef. If byName is set to 1, the columns in in $tbl do not need to be in the same order as they are in the first table, instead the column name is used for the matching. If addNewCol is set to 1, if $tbl contains a new column name that does not already exist in the first table, this new column will be automatically added to the resultant table. Typically, you want to specify there two options simultaneously.
=item int table::colMerge ($tbl, $argRef)
Append all the columns in table object $tbl to the original columns.
Table $tbl must have the same number of rows as the original.
It returns 1 upon success, undef otherwise.
Table $tbl should not be used afterwards, since it becomes part of
the new table.
Since 1.62, you can specify {renameCol => 1} as $argRef. This is to auto fix any column name collision. If $tbl contains a column that already exists in the first table, it will be renamed (by a suffix _2) to avoid the collision.
=item table table::join ($tbl, $type, $cols1, $cols2, $argRef)
Join two tables. The following join types are supported (defined by $type):
0: inner join
1: left outer join
2: right outer join
3: full outer join
In 1.62, instead of memorize these numbers, you can use constants instead (notice constants do not start with '$').
Data::Table::INNER_JOIN
Data::Table::LEFT_JOIN
Data::Table::RIGHT_JOIN
Data::Table::FULL_JOIN
$cols1 and $cols2 are references to array of colIDs, where rows with the same elements in all listed columns are merged. As the result table, columns listed in $cols2 are deleted, before a new table is returned.
The implementation is hash-join, the running time should be linear with respect to the sum of number of rows in the two tables (assume both tables fit in memory).
If the non-key columns of the two tables share the same name, the routine will fail, as the result table cannot contain two columns of the same name. In 1.62, one can specify {renameCol=>1} as $argRef, so that the second column will be automatically renamed (with suffix _2) to avoid collision.
If you would like to treat the NULLs in the key columns as empty string, set {NULLasEmpty => 1}. If you do not want to treat NULLs as empty strings, but you still like the NULLs in two tables to be considered as equal (but not equal to ''), set {matchNULL => 1}. Obviously if NULLasEmpty is set to 1, matchNULL will have no effect.
=back
=head2 Internal Methods
All internal methods are mainly implemented for used by
other methods in the Table class. Users should avoid using them.
Nevertheless, they are listed here for developers who
would like to understand the code and may derive a new class from Data::Table.
=over 4
=item int table::rotate
convert the internal structure of a table between row-based and column-based.
return 1 upon success, undef otherwise.
=item string csvEscape($string, {delimiter=>, qualifier})
Encode a scalar into a CSV-formatted field.
optional named arguments: delimiter and qualifier, in case user wants to use characters other than the defaults.
The default delimiter and qualifier is taken from $Data::Table::DEFAULTS{'CSV_DELIMITER'} (defaults to ',') and $Data::Table::DEFAULTS{'CSV_QUALIFIER'} (defaults to '"'), respectively.
Please note that this function only escape one element in a table. To escape the whole table row, you need to
join($delimiter, map {csvEscape($_)} @row . $endl;
$endl refers to End-of-Line, which you may or may not want to add, and it is OS-dependent. Therefore, csvEscape method is kept to the simplest form as an element transformer.
=item refto_array parseCSV($string)
Break a CSV encoded string to an array of scalars (check it out, we did it the cool way).
optional argument size: specify the expected number of fields after csv-split.
optional named arguments: delimiter and qualifier, in case user wants to use characters other than the defaults.
respectively. The default delimiter and qualifier is taken from $Data::Table::DEFAULTS{'CSV_DELIMITER'} (defaults to ',') and $Data::Table::DEFAULTS{'CSV_QUALIFIER'} (defaults to '"'), respectively.
=item string tsvEscape($rowRef)
Encode a scalar into a TSV-formatted string.
=back
=head1 TSV FORMAT
There is no standard for TSV format as far as we know. CSV format can't handle binary data very well, therefore, we choose the TSV format to overcome this limitation.
We define TSV based on MySQL convention.
"\0", "\n", "\t", "\r", "\b", "'", "\"", and "\\" are all escaped by '\' in the TSV file.
(Warning: MySQL treats '\f' as 'f', and it's not escaped here)
Undefined values are represented as '\N'.
However, you can switch off this transformation by setting {transform_element => 0} in the fromTSV or tsv method.
Before if a cell reads 'A line break is \n', it is read in as 'A link break is [return]' in memory. When use tsv method to export, it is transformed back to 'A line break is \n'. However, if it is exported as a csv, the [return] will break the format. Now if transform_element is set to 0, the cell is stored as 'A line break is \n' in memory, so that csv export will be correct. However, do remember to set {transform_element => 0} in tsv export method, otherwise, the cell will become 'A line break is \\n'. Be aware that trasform_element controls column headers as well.
=head1 INTERFACE TO OTHER SOFTWARES
Spreadsheet is a very generic type, therefore Data::Table class provides an easy
interface between databases, web pages, CSV/TSV files, graphics packages, etc.
Here is a summary (partially repeat) of some classic usages of Data::Table.
=head2 Interface to Database and Web
use DBI;
$dbh= DBI->connect("DBI:mysql:test", "test", "") or die $DBI::errstr;
my $minAge = 10;
$t = Data::Table::fromSQL($dbh, "select * from mytable where age >= ?", [$minAge]);
print $t->html;
=head2 Interface to CSV/TSV
$t = fromFile("mydata.csv"); # after version 1.51
$t = fromFile("mydata.tsv"); # after version 1.51
$t = fromCSV("mydata.csv");
$t->sort(1,1,0);
print $t->csv;
Same for TSV
=head2 Interface to Excel XLS/XLSX
Read in two tables from NorthWind.xls file, writes them out to XLSX format. See Data::Table::Excel module for details.
use Data::Table::Excel;
my ($tableObjects, $tableNames)=xls2tables("NorthWind.xls");
$t_category = $tableObjects[0];
$t_product = $tableObjects[1];
tables2xlsx("NorthWind.xlsx", [$t_category, $t_product]);
=head2 Interface to Graphics Package
use GD::Graph::points;
$graph = GD::Graph::points->new(400, 300);
$t2 = $t->match('$_->[1] > 20 && $_->[3] < 35.7');
my $gd = $graph->plot($t->colRefs([0,2]));
open(IMG, '>mygraph.png') or die $!;
binmode IMG;
print IMG $gd->png;
close IMG;
=head1 AUTHOR
Copyright 1998-2008, Yingyao Zhou & Guangzhou Zou. All rights reserved.
It was first written by Zhou in 1998, significantly improved and maintained by Zou since 1999. The authors thank Tong Peng and Yongchuang Tao for valuable suggestions. We also thank those who kindly reported bugs, some of them are acknowledged in the "Changes" file.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
Please send bug reports and comments to: easydatabase at gmail dot com. When sending
bug reports, please provide the version of Table.pm, the version of
Perl.
=head1 SEE ALSO
DBI, GD::Graph, Data::Table::Excel.
=cut
|