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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Velocity kyttjn opas</title>
<author email="jvanzyl@zenplex.com">Velocity Documentation Team</author>
<author email="jcastura@kw.igs.net">John Castura</author>
<author email="juha@dwebs.com">Juha Kilpi</author>
</properties>
<body>
<section name="Sisllys">
<ol>
<li><a href="#Tietoja tst oppaasta">Tietoja tst oppaasta</a></li>
<li><a href="#Mik on Velocity?">Mik on Velocity?</a></li>
<li><a href="#Miten voin kytt Velocity?">Miten voin kytt Velocity?</a>
<ol>
<li><a href="#Kurakauppa esimerkki">Kurakauppa esimerkki</a></li>
</ol>
</li>
<li><a href="#Velocity Template Language (VTL): Johdanto">Velocity
Template Language (VTL): Johdanto</a></li>
<li><a href="#Hei Velocity Maailma!">Hei Velocity Maailma!</a></li>
<li><a href="#Kommentit">Kommentit</a></li>
<li><a href="#Viittaukset">Viittaukset</a>
<ol>
<li><a href="#Muuttujat">Muuttujat</a></li>
<li><a href="#Ominaisuudet">Ominaisuudet</a></li>
<li><a href="#Metodit">Metodit</a></li>
</ol>
</li>
<li><a href="#Muodollinen merkint">Muodollinen viittausten merkint</a></li>
<li><a href="#Hiljainen viittausten merkint">Hiljainen viittausten merkint</a></li>
<li><a href="#Kirjaimellisesti">Kirjaimellisesti</a>
<ol>
<li><a href="#Dollari">Dollari</a></li>
<li><a href="#VTL viittausten suojaaminen">VTL viittausten suojaaminen</a></li>
</ol>
</li>
<li><a href="#Kirjainkoon muutos">Kirjainkoon muutos</a></li>
<li><a href="#Ohjeet">Ohjeet</a>
<ol>
<li><a href="#Set">Set</a></li>
<li><a href="#Tekstivakiot">Tekstivakiot</a></li>
<li><a href="#If-Else ehtolauseet">If-Else ehtolauseet</a>
<ol>
<li><a href="#Relaatio- ja loogiset operaattorit">Relaatio- ja loogiset
operaattorit</a></li>
</ol>
</li>
<li><a href="#Silmukat">Foreach silmukat</a></li>
<li><a href="#Include">Include</a></li>
<li><a href="#Parse">Parse</a></li>
<li><a href="#Stop">Stop</a></li>
<li><a href="#Velocimakrot">Velocimakrot</a></li>
</ol>
</li>
<li><a href="#VTL ohjeiden suojaaminen">VTL ohjeiden suojaaminen</a></li>
<li><a href="#VTL: Muotoilu">VTL: Muotoilu</a></li>
<li><a href="#Muita ominaisuuksia ja sekalaista">Muita ominaisuuksia ja sekalaista</a>
<ol>
<li><a href="#Matematiikka">Matematiikka</a></li>
<li><a href="#Vaihteluvli (Range Operator)">Vaihteluvli (Range Operator)</a></li>
<li><a href="#Edistyneet kysymykset: Suojaaminen ja
!">Edistyneet kysymykset: Suojaaminen ja !</a></li>
<li><a href="#Yleist Velocimakroista">Yleist Velocimakroista</a></li>
<li><a href="#Merkkijonojen yhdistminen">Merkkijonojen yhdistminen</a></li>
</ol>
</li>
<li><a href="#Palaute">Palaute</a></li>
</ol>
</section>
<section name="Tietoja tst oppaasta">
<p>
Velocity kyttjn opas on tarkoitettu sivusuunnittelijoille ja
sisllntuottajille avuksi tutustuttaessa Velocityyn ja sen
yksinkertaiseen mutta tehokkaaseen skriptikieleen, Velocity
Template Language:en (VTL). Useat tmn oppaan esimerkeist
ksittelevt Velocityn kyttmist dynaamisen sislln
lismiseksi web sivuille, mutta kaikki VTL esimerkit toimivat
HTML sivujen lisksi yht hyvin mys muiden sivujen ja sivupohjien
kanssa.
</p>
<p>
Kiitos ett valitsit Velocityn!
</p>
</section>
<section name="Mik on Velocity?">
<p>
Velocity on javapohjainen sivumoottori (template engine). Sen
avulla sivusuunnittelijat voivat viitata java -koodissa
mriteltyihin metodeihin. Sivusuunnittelijat voivat tyskennell
java ohjelmoijien kanssa samanaikaisesti kytten
Malli-Nkym-Ohjain (Model-View-Controller, MVC)
suunnittelumallia. MVC mallissa sivusuunnittelijat voivat
keskitty tysin luomaan hyvin suunniteltua sivustoa, ja
ohjelmoijat voivat keskitty koodaamaan ykksluokan
koodia. Velocity erottaa java -koodin web sivuista, tehden
sivustosta pitkll aikavlill helpommin yllpidettvn ja
antamalla varteenotettavan vaihtoehdon <a
href="http://java.sun.com/products/jsp/">JSP</a>:lle (Java Server
Pages) ja <a href="http://www.php.net/">PHP</a>:lle.
</p>
<p>
Velocity voidaan kytt web sivujen, SQL:n, PostScriptin ja
muunlaisten tulosteiden tuottamiseen sivupohjista (template). Sit
voidaan kytt joko itsenisen tykaluna lhdekoodin ja
raporttien luomiseen, tai muihin jrjestelmiin integroituna
komponenttina. Velocity tarjoaa sivupohjaratkaisun <a
href="http://java.apache.org/turbine/">Turbine</a> web
sovelluskehykselle. Yhdess Velocity ja Turbine tarjoavat
sivupohjaratkaisun jonka avulla web sovelluksia voidaan kehitt
todellisen MVC -mallin mukaisesti.
</p>
</section>
<section name="Miten voin kytt Velocity?">
<subsection name="Kurakauppa esimerkki">
<p>
Oletetaan ett olet kuraa myyvn onlinekaupan
sivusuunnittelija. Kutsumme kauppaa "Kurakauppa
Online":ksi. Kauppa ky hyvin. Asiakkaat tilaavat vaihtelevia
mri eri kuratyyppej. He psevt tutkimaan tekemin tilauksia
sek tekemn uusia ostoja kirjautumalla sivullesi kytten
kyttjtunnustaan ja salasanaansa. Tll hetkell suosittu
Terracotta -kura on alennusmyynniss. Pieni osa asiakkaistasi
ostaa snnllisesti Kirkkaanpunaista Kuraa, joka mys on
alennusmyynniss, mutta pienemmn suosionsa vuoksi yleens
mainittu sivulla hieman syrjss. Tiedot kustakin asiakkaasta
talletetaan tietokantaan, joten ern pivn her kysymys;
Miksip emme kyttisi Velocity kohdentamaan erikoistarjouksia
kurasta asiakkaille jotka ovat kiinnostuneita juuri tuosta
kuratyypist?
</p>
<p>
Velocityn avulla verkkosivut on helppo personoida kvijidesi
mukaan. Kurakauppa Onlinen sivusuunnittelijana haluat tehd sivun
jonka asiakas nkee kirjauduttuaan jrjestelmn.
</p>
<p>
Tapaat yrityksesi ohjelmoijat ja sovitte, ett muuttuja
<em>$asiakas</em> pit sislln tiedot parhaillaan kirjautuneena
olevasta asiakkaasta. Muuttujassa <em>$kuratTarjouksessa</em> ovat
tiedot kuratyypeist jotka ovat parhaillaan
erikoistarjouksessa. <em>$tarjous</em> objektissa on metodeja
jotka auttavat mainostamisessa. Tll kertaa keskitymme vain
nihin kolmeen viittaukseen. Muista, ett sinun ei tarvitse
huolehtia siit kuinka ohjelmoijat hakevat tarvittavat tiedot
tietokannasta, sinun tarvitsee tiet vain ett se toimii. Nin
pset tekemn omaa tytsi ja ohjelmoijat psevt tekemn
omaansa.
</p>
<p>
Voisit list seuraavat VTL lauseen sivulle:
</p>
<source><![CDATA[
<HTML>
<BODY>
Hei $asiakas.Nimi!
<table>
#foreach( $kura in $kuratTarjouksessa )
#if ( $asiakas.onOstanut($kura) )
<tr>
<td>
$tarjous.haePromo( $kura )
</td>
</tr>
#end
#end
</table>
]]></source>
<p>
<em>foreach</em> lauseen toiminta kuvataan yksityiskohtaisemmin
jljempn; trke tss on tmn lyhyen skriptin tekem vaikutus
sivullesi. Kun Kirkkaanpunainen Kura on alennusmyynniss ja sit
joskus aiemmin ostanut asiakas kirjautuu sisn, asiakas nkee
ilmoituksen alennuksesta parhaalla mahdollisella paikalla. Jos
toinen, Terracottakuraa ostanut asiakas kirjautuu jrjestelmn,
ilmoitus Terracottakuran alennusmyynnist nkyy hnelle
ensimmisen. Velocity on joustava ja sen kytss vain
mielikuvituksesi on rajana.
</p>
<p>
VTL hakemistossa on kuvattu Velocityn kaikki elementit jotka
yhdess antavat kyttsi tehokkaan ja joustavan tykalun jota
tarvitset luodaksesi web sivuistasi dynaamisen. Pset
hydyntmn Velocityn voimaa jatkuvasti paremmin sit mukaa kun
opit kyttmn nit elementtej.
</p>
</subsection>
</section>
<section name="Velocity Template Language (VTL): Johdanto">
<p>
Velocityn sivunkuvauskieli (Velocity Template Language, VTL)
tarjoaa helpon ja yksinkertaisen keinon liitt dynaamista
sislt web sivulle. Dynaamisen sislln kyttminen pitisi
onnistua nopeasti jopa sellaiselta sivusuunnittelijalta jolla on
ohjelmointikokemusta vain vhn, tai ei ollenkaan.
</p>
<p>
VTL kytt <em>viittauksia</em> dynaamisen aineiston lismiseen
verkkosivulle. Muuttujat ovat yhdentyyppisi
viittauksia. Muuttujat voivat viitata johonkin java -koodissa
mriteltyyn, tai niiden arvo voidaan mritt web -sivulla
annetun VTL <em>lauseen</em> avulla. Seuraavassa on esimerkki VTL
lauseesta joka voidaan list HTML -dokumenttiin:
</p>
<source><![CDATA[
#set( $a = "Velocity" )
]]></source>
<p>
Kuten kaikki VTL lauseet (statement), tmkin lause alkaa <em>#</em>
merkill ja sislt ohjeen (directive): <em>set</em>. Kun verkkosivun
kyttj hakee sivun Velocity etsii sivupohjastasi kaikki
<em>#</em> -merkit. Sitten se tulkitsee mitk niist merkitsevt
VTL lausetta, ja mitk <em>#</em> merkeist ovat osa sivujesi
normaalia HTML -koodia, eivtk kuulu VTL -koodiin.
</p>
<p>
<em>#</em> merkki seuraa ohje, <em>set</em>. <em>set</em> ohjeen
jlkeen tulee suluissa ilmaus (expression), -- yhtl joka mritt
<em>arvon</em> <em>muuttujalle</em>. Muuttuja on ilmaistu
vasemmalla ja arvo oikealla puolella. Nm on erotettu <em>=</em>
merkill.
</p>
<p>
Yll olevassa esimerkiss muuttuja on <em>$a</em> ja arvo on
<em>Velocity</em>. Kaikkien viittausten tapaan tmkin muuttuja
alkaa <em>$</em> merkill. Arvot ovat aina lainausmerkkien
sisll; Velocityss muuttujien datatyypeist ei tule
sekaannuksia, koska vain merkkijonoja (string) voi antaa
muuttujien arvoksi.
</p>
<p>
Seuraava nyrkkisnt voi auttaa ymmrtmn Velocityn toimintaa:
<strong>Viittaukset alkavat <em>$</em> merkill ja niit kytetn
jonkin hakemiseen. Ohjeet alkavat <em>#</em> merkill ja niit
kytetn jonkin suorittamiseen.</strong>
</p>
<p>
Yll olevassa esimerkiss <em>#set</em> -ohjetta kytetn arvon
mrittmiseksi muuttujaan. Muuttujaa <em>$a</em> voidaan tmn
jlkeen kytt sivupohjassa tulostamaan "Velocity".
</p>
</section>
<section name="Hei Velocity Maailma!">
<p>
Kun muuttujalle on mritelty arvo, voidaan siihen viitata miss
tahansa paikassa HTML dokumenttia. Seuraavassa esimerkiss
muuttujalle <em>$foo</em> mritelln arvo. Myhemmin muuttujaan
viitataan.
</p>
<source><![CDATA[
<html>
<body>
#set( $foo = "Velocity" )
Hei $foo Maailma!
</body>
<html>
]]></source>
<p>
Tuloksena on web sivu jossa lukee "Hei Velocity Maailma!".
</p>
<p>
Jotta VTL lauseet olisivat helpommin luettavissa on suositeltavaa
aloittaa jokainen lause uudelta rivilt, vaikkakaan tm ei ole
pakollista. <em>set</em> ohjeeseen palaamme tarkemmin myhemmin.
</p>
</section>
<section name="Kommentit">
<p>
Kommenttien avulla sivulle voidaan list aputekstej jotka eivt
tule nkymn sivun tulosteessa. Voit kytt kommentteja
muistuttaaksesi itsesi jostakin tai selittksesi muille mit VTL
komennot tekevt, tai mihin tahansa muuhun tarkoitukseen. Alla on
esimerkki kommentin kytst.
</p>
<source><![CDATA[
## Tm on rivin pituinen kommentti.
]]></source>
<p>
Yhden rivin pituinen kommentti alkaa <em>##</em> merkeill ja
loppuu kyseisen rivin lopussa. Jos aiot kirjoittaa usean rivin
mittaisen kommentin, ei sinun tarvitse kirjoittaa useita yhden
rivin kommentteja. Usean rivin kommentit alkavat <em>#*</em>
merkeill ja loppuvat <em>*#</em> merkkeihin.
</p>
<source><![CDATA[
Tm teksti on kommenttimerkkien ulkopuolella.
Kyttjt nkevt tmn tekstin.
#*
Monirivinen kommentti alkaa tst. Kyttjt eivt ne tt teksti
koska Velocityn sivumoottori ei nyt kommenttimerkkien sisll
olevaa teksti tulosteessaan.
*#
Tm teksti on jlleen kommenttimerkkien ulkopuolella; se on
nkyviss.
]]></source>
<p>
Tss on muutamia esimerkkej yksi- ja monirivisten kommenttien
toiminnan selvittmiseksi:
</p>
<source><![CDATA[
Tm teksti on nkyviss. ## Tm teksti ei ole.
Tm teksti on nkyviss.
Tm teksti on nkyviss. #* Tm teksti on osa monirivist kommenttia
eik siksi ole nkyviss. Tm teksti ei edelleenkn ole nkyviss
koska se on kommenttimerkkien sisll. *# Tm teksti on
kommenttimerkkien ulkopuolella, joten se on nkyviss.
## Tm teksti ei ole nkyviss.
]]></source>
<p>
On olemassa viel kolmaskin kommenttityyppi; VTL kommenttilohko,
jota voidaan kytt mm. dokumentin tekij- ja versiotietojen
tallettamiseen
</p>
<source><![CDATA[
#**
Tm on VTL kommenttilohko. Lohkoa
voidaan kytt esimerkiksi dokumentin
tekij- ja versiotietojen
tallettamiseen:
@author
@version 5
*#
]]></source>
</section>
<section name="Viittaukset">
<p>
VTL:ss on kolme erityyppist viittausta: muuttujat, ominaisuudet
ja metodit. VTL: kyttvn sivusuunnittelijana sinun, ja
javapuolta koodaavien ohjelmoijien on sovittava viittausten
nimist, jotta voit kytt niit sivupohjissasi.
</p>
<p>
Kaikkea viittauksissa olevaa ja niihin mriteltv tietoa
ksitelln tekstityyppisen. Jos on esimerkiksi mritelty
objekti <em>$foo</em> (Integer objekti), Velocity kutsuu objektin
<code>.toString()</code> metodia objektin arvon muuntamiseksi
tekstityyppiseksi.
</p>
<p>
<a name="Muuttujat"><strong>Muuttujat</strong></a>
<br/>
Muuttujan lyhyt merkinttapa koostuu ensimmisen olevasta "$"
merkist, jonka jlkeen tulee VTL <em>tunniste</em>. VTL
tunnisteen on alettava aakkosnumeerisella merkill (a..z tai
A..Z). Muuttujan loput merkit ovat rajoitettu seuraaviin:
</p>
<p>
<ul>
<li>aakkoset (a .. z, A .. Z)</li>
<li>numerot (0 .. 9)</li>
<li>viiva ("-")</li>
<li>alaviiva ("_")</li>
</ul>
</p>
<p>
Seuraavassa muutamia esimerkkej toimivista muuttujaviittauksista:
</p>
<source><![CDATA[
$foo
$kuraLinko
$kura-linko
$kura_linko
$kuraLinko1
]]></source>
<p>
Kun VTL viittaa muuttujaan, kuten <em>$foo</em>, muuttuja voi
saada arvonsa joko sivupohjassa olevalta <em>set</em> ohjeelta,
tai java -koodista. Jos esimerkiksi javamuuttujalla <em>$foo</em>
on arvo <em>bar</em> silloin kun sivupohjaa haetaan, <em>bar</em>
korvaa kaikki <em>$foo</em> muuttujan esiintymiskohdat web
sivulla. Toisaalta jos sivulle listn lause
</p>
<source><![CDATA[
#set( $foo = "bar" )
]]></source>
<p>
Sivun tuloste on sama kaikilla <em>$foo</em> muuttujan
esiintymiskohdille jotka tulevat tmn lauseen jlkeen.
</p>
<p>
<a name="Ominaisuudet"><strong>Ominaisuudet</strong></a>
<br/>
Toinen VTL:n viittaustyyppi ovat ominaisuudet joilla on oma
tunnusomainen muotonsa. Lyhyt merkinttapa muodostuu ensimmisen
olevasta <em>$</em> merkist, jonka jlkeen tulee VTL tunniste,
jota seuraa piste (".") ja toinen VTL tunniste. Seuraavassa on
esimerkkej toimivista ominaisuusviittauksista:
</p>
<source><![CDATA[
$asiakas.Osoite
$ostos.Summa
]]></source>
<p>
Ksittelemme ensimmisen esimerkin <em>$asiakas.Osoite</em>
tarkemmin. Viittauksella voi olla kaksi merkityst. Se saattaa
tarkoittaa; hae <em>asiakas</em> nimisest hashtable taulukosta
arvo joka on liitetty avaimelle <em>Osoite</em>. Toisaalta
<em>$asiakas.Osoite</em> voi mys viitata metodiin (ksittelemme
metodeihin viittaavat viittaukset seuraavassa kappaleessa);
<em>$asiakas.Osoite</em> saattaa olla lyhennetty muoto
viittauksesta <em>$asiakas.getOsoite()</em>. Velocity tulkitsee
sivua haettaessa kumpaa nist vaihtoehdoista tarkoitetaan, ja
palauttaa vastaavan arvon.
</p>
<p>
<a name="Metodit"><strong>Metodit</strong></a>
<br/>
Metodit ovat mritelty java -koodissa ja niiden avulla voidaan
suorittaa jokin toimenpide; esimerkiksi laskutoimitus tai jonkin
ptksen tekeminen. Metodit ovat viittauksia jotka muodostuvat
aloittavasta "$" merkist, jota seuraa VTL tunniste, jonka jlkeen
tulee VTL <em>Metodirunko</em>. VTL Metodirunko koostuu VTL
tunnisteesta jota seuraa vasen sulkumerkki "(", jota seuraa
valinnainen parametrilista, jota seuraa oikeanpuoleinen
sulkumerkki ")". Seuraavassa on esimerkkej toimivista
metodiviittauksista:
</p>
<source><![CDATA[
$asiakas.getOsoite()
$ostos.getSumma()
$sivu.setOtsake( "Minun kotisivuni" )
$henkilo.setOminaisuudet( ["Outo", "Kummallinen", "Innostunut"] )
]]></source>
<p>
Metodirungossa esiintyv get tarkoittaa "hae" ja set "aseta".
</p>
<p>
Kaksi ensimmist esimerkki -- <em>$asiakas.getOsoite()</em> ja
<em>$ostos.getSumma()</em> -- nyttvt samanlaisilta kuin
Ominaisuudet -osiossa aiemmin; <em>$asiakas.Osoite</em> ja
<em>$ostos.Summa</em>. Jos arvasit ett nill esimerkeill on
jotakin yhteytt toisiinsa, olit oikeassa!
</p>
<p>
VTL ominaisuuksia voidaan kytt lyhyempin muotoina VTL
metodeista. Ominaisuudella <em>$asiakas.Osoite</em> on tysin sama
vaikutus kuin kyttmll metodia
<em>$asikas.getOsoite()</em>. Yleisesti ottaen ominaisuuksien
kytt on suositeltavaa silloin kuin se vain on
mahdollista. Suurin ero ominaisuuksien ja metodien vlill on se,
ett metodeille voi antaa parametreja.
</p>
<p>
Seuraavien metodien kanssa voidaan kytt lyhytt muotoa:
</p>
<source><![CDATA[
$aurinko.getPlaneetat()
$mato.getMulta()
$albumi.getValokuva()
]]></source>
<p>
Niden metodien voisimme olettaa palauttavan auringolle kuuluvien
planeettojen nimet, syttvn matomme, tai hakevan valokuvan
albumista. Seuraavissa metodeissa toimii vain pitk muoto:
</p>
<source><![CDATA[
$aurinko.getPlaneetat( ["Maa", "Mars", "Neptunus"] )
## lyhyess muodossa $sun.Planets ei voida antaa parametreja
$sisyphus.pushRock()
## Velocity olettaa ett tarkoitan $sisyphus.getRock()
$kirja.setOtsake( "Catalonian kotisivu" )
## Parametrilistaa ei voida antaa
]]></source>
<p>
<a name="Muodollinen viittausten merkint"><strong>Muodollinen viittausten merkint</strong></a>
<br/>
Edellisiss esimerkeiss kytettiin viittauksille lyhytt
merkinttapaa. Viittauksille on olemassa mys muodollinen
merkinttapa, jota kytetn seuraavissa esimerkeiss:
</p>
<source><![CDATA[
${kuraLinko}
${asiakas.Osoite}
${osto.getSumma()}
]]></source>
<p>
Voit kytt lyhytt muotoa viittauksiin lhes aina, mutta
joissain tapauksissa muodollista viittausta tarvitaan virheettmn
toiminnan turvaamiseksi.
</p>
<p>
Oletetaan ett olet luomassa lausetta jonka sislt riippuu
muuttujasta. Muuttujaa <em>$pahe</em> kytetn pohjana luotaessa
muuttujasta riippuvaista sanaa. Tarkoituksena on sallia kyttjn
valita pohjasana ja tuottaa toinen seuraavista tuloksista: "Juha
on pyromaani." tai "Juha on kleptomaani.". Tss tapauksessa
lyhyen viittausmuodon kyttminen ei toimisi. Tutki seuraavaa
esimerkki:
</p>
<source><![CDATA[
Juha on $pahemaani.
]]></source>
<p>
Velocity olettaa ett tarkoitat muuttujaa <em>$pahemaani</em>,
vaikka kytettv muuttuja oli <em>$pahe</em>. Koska Velocity ei
lyd arvoa muuttujalle <em>$pahemaani</em>, se palauttaa
<em>$pahemaani</em>. Tm ongelma voidaan ratkaista kyttmll
muodollista viittausta.
</p>
<source><![CDATA[
Juha on ${pahe}maani.
]]></source>
<p>
Nyt Velocity ymmrt ett haluttu viittaus on <em>$pahe</em>, ei
<em>$pahemaani</em>. Muodollinen viittausten merkint on usein
hydyllinen silloin kun viittaukset ovat kiinni muussa tekstiss.
</p>
<p>
<a name="Hiljainen viittausten merkint"><strong>Hiljainen viittausten merkint</strong></a>
<br/>
Kun Velocitylt haetaan viittaus jolle ei ole mritelty arvoa,
palauttaa se normaalisti viittauksen tekstin. Oletetaan
esimerkiksi ett seuraavat viittaukset ovat osa VTL sivupohjaa:
</p>
<source><![CDATA[
<input type="text" name="email" value="$email"/>
]]></source>
<p>
Kun lomake latautuu ensimmisen kerran muuttujaviittauksella
<em>$email</em> ei ole arvoa. Oletuksena Velocity tytt
lomakkeen tekstill "$email". Haluaisit kuitenkin kenttn
mieluummin tyhjn arvon. Kyttmll hiljaista viittausten
merkint voidaan Velocityn normaali toiminta est;
<em>$email</em> koodin sijaan kytt viittausta
<em>$!email</em>. Yll oleva koodi nyttisi siis seuraavalta:
</p>
<source><![CDATA[
<input type="text" name="email" value="$!email"/>
]]></source>
<p>
Kun lomake latautuu ensimmisen kerran eik muuttujalla
<em>$email</em> ole arvoa, tulostetaankin kenttn tyhj teksti
"$email" tekstin sijaan.
</p>
<p>
Muodollista ja hiljaista muuttujien merkint voidaan kytt mys
yhdess;
</p>
<source><![CDATA[
<input type="text" name="email" value="$!{email}"/>
]]></source>
</section>
<section name="Kirjaimellisesti">
<p>
VTL kytt erikoismerkkej kuten <em>$</em> ja <em>#</em> omassa
toiminnassaan, joten niden merkkien kytt sivupohjassa vaatii
erityist huolellisuutta. Tss kappaleessa ksittelemme
<em>$</em> merkin suojaamisen (escape).
</p>
<p>
<a name="Dollari"><strong>Dollari</strong></a>
<br/>
Seuraavassa lauseessa dollarimerkin kytss ei ole ongelmaa:
"Ostin markkinoilta skin perunoita hintaan $2.50!". Kuten
mainittu, VTL tunniste alkaa aina aakkosmerkill, joten merkint
$2.50 ei ole vaaraa sekoittaa viittaukseksi.
</p>
<p>
<a name="VTL viittausten suojaaminen"><strong>VTL viittausten suojaaminen</strong></a>
<br/>
Ongelmatilanne saattaa synty silloin, kun Velocity ei osaa
ptell tarkoitetaanko dollarinmerkill merkki itsen, vai
viittausta. Erikoismerkkien <em>suojaaminen</em> on paras keino
ksitell VTL erikoismerkkej sivupohjissa. Suojaamiseen kytetn
kenoviivaa ( <em>\</em> ).
</p>
<source><![CDATA[
#set( $email = "foo" )
$email
]]></source>
<p>
Kun Velocity ksittelee <em>$email</em> viittauksen
sivupohjassasi, se etsii lytyyk sen nimiselle muuttujalle
arvoa. Tss tapauksessa tuloste tulee olemaan <em>foo</em>, koska
<em>$email</em> on mritelty. Jos <em>$email</em> muuttujaa ei
olisi mritelty tulisi tulosteeksi <em>$email</em>.
</p>
<p>
Oletetaan ett <em>$email</em> on mritelty (sill on esimerkiksi
arvo <em>foo</em>), ja ett haluat muuttujan arvon sijaan tulostaa
sen nimen <em>$email</em>. Tm saavuttamiseksi on useita keinoja,
joista helpoin on suojausmerkin kyttminen.
</p>
<source><![CDATA[
## Seuraava rivi mrittelee muuttujan $email tss sivupohjassa:
#set( $email = "foo" )
$email
\$email
\\$email
\\\$email
]]></source>
<p>
tulosteeksi tulee
</p>
<source><![CDATA[
foo
$email
\foo
\\$email
]]></source>
<p>
Huomaa <em>$</em> merkin eteen liitetty <em>\</em>
merkki. Suojausmerkit tulkitaan vasemmalta oikealle, joten
<em>\\\$email</em> tulostuu <em>\\$email</em>. Vertaa nit
esimerkkej tulosteeseen joka saadaan kun <em>$email</em>
muuttujaa ei ole mritelty.
</p>
<source><![CDATA[
$email
\$email
\\$email
\\\$email
]]></source>
<p>
tulosteeksi tulee
</p>
<source><![CDATA[
$email
\$email
\\$email
\\\$email
]]></source>
<p>
Huomaa kuinka Velocity ksittelee eri tavalla viittaukset joiden
arvo on mritelty niist joita ei ole mritelty. Seuraavassa on
set ohje joka asettaa <em>$foo</em> muuttujalle arvon
<em>gibbous</em>.
</p>
<source><![CDATA[
#set( $foo = "gibbous" )
$kuu = $foo
]]></source>
<p>
Tulosteeksi tulee: <em>$kuu = gibbous</em> -- miss <em>$kuu</em>
tulostetaan muuttujan nimen, koska sen arvoa ei ole mritelty ja
<em>gibbous</em> tulostetaan muuttujan <em>$foo</em> arvona.
</p>
<p>
Mys VTL ohjeiden suojaaminen on mahdollista; tm kuvataan
tarkemmin Ohjeet -kappaleessa.
</p>
</section>
<section name="Kirjainkoon muutos">
<p>
Kun nyt olet tutustunut viittauksiin, voit alkaa kyttmn niit
tehokkaasti omissa sivupohjissasi. Viittaukset Velocityss
kyttvt hyvkseen joitakin java kielen perusperiaatteita, joiden
kytt helpottaa sivusuunnittelijoiden tyt. Esimerkiksi:
</p>
<source><![CDATA[
$foo
$foo.getBar()
## on sama kuin
$foo.Bar
$data.getKayttaja("juha")
## on sama kuin
$data.Kayttaja("juha")
$data.getPyynto().getPalvelinNimi()
## on sama kuin
$data.Pyynto.PalvelinNimi
## on sama kuin
${data.Pyynto.PalvelinNimi}
]]></source>
<p>
Nm esimerkit havainnollistavat viittauksen vaihtoehtoisia
merkitsemistapoja. Velocity kytt hyvkseen javan introspection
ja bean -ominaisuuksia objektien sek niiden metodien
viittausnimi ratkaistaessa. Viittauksia voidaan list lhes
mihin kohtaan tahansa sivupojassa.
</p>
<p>
Velocity on tehty Sun Microsystemsin mrittelemn Bean
mrityksen mukaiseksi, ja on tst syyst pieni-iso-eroava
(ts. pienet ja isot kirjaimet ksitelln eri
merkkein). Velocityn kehittjt ovat tehneet parhaansa jotta
mahdolliset kirjoitusvirheet voitaisiin korjata
automaattisesti. Kun sivupohjassa viitataan metodiin
<em>getFoo()</em> koodilla <code>$bar.foo</code>, Velocity
kokeilee ensin viittausta <code>$getfoo</code>. Jos tm ei tuota
tulosta, seuraavaksi yritetn viittausta
<code>$getFoo</code>. Samalla tavalla, kun sivupohjassa viitataan
muuttujaan <code>$bar.Foo</code>, ensin yritetn viittausta
<em>$getFoo()</em> ja sitten <em>getfoo()</em>.
</p>
<p>
Huomaa: <em>Viittauksia ilmentymmuuttujiin (instance variables)
ei ratkaista.</em> Vain viittaukset JavaBeanin mukaisiin
haku/asetus (getter/setter) metodeihin ratkaistaan (toisin sanoen
<code>$foo.Name</code> ratkaistaan Foo -luokan
<code>getName()</code> ilmentymmetodiin (instance method), mutta
ei luokan Foo julkiseen (public) <code>Name</code>
ilmentymmuuttujaan).
</p>
</section>
<section name="Ohjeet">
<p>
<em>Ohjeet</em> ovat helppokyttisi skriptielementtej joita
voidaan kytt web sivun tulosteen manipuloimiseen. Viittausten
avulla sivupohjien suunnittelijat voivat tuottaa web sivuille
dynaamista sislt, kun taas ohjeet antavat mahdollisuuden
mritell sivuston ulkoasun ja sislln.
</p>
<a name="Set"><strong>#set</strong></a>
<p>
<em>#set</em> ohjetta kytetn arvon mrittmiseksi
viittaukselle. Arvo voidaan mritt joko muuttujaviittaukselle
tai ominaisuusviittaukselle. Mritys tehdn suluissa, kuten
seuraavassa esimerkiss:
</p>
<source><![CDATA[
#set( $kadellinen = "apina" )
#set( $asiakas.Kayttaytyminen = $kadellinen )
]]></source>
<p>
Mrityksen vasemman puolen (left hand side, LHS) tulee olla
muuttuja- tai ominaisuusviittaus. Oikea puoli (right hand side,
RHS) voi olla jokin seuraavista tyypeist:
</p>
<p>
<ul>
<li>Muuttujaviittaus</li>
<li>Tekstivakio</li>
<li>Ominaisuusviittaus</li>
<li>Metodiviittaus</li>
<li>Numeerinen vakio</li>
<li>ArrayList taulukko</li>
</ul>
</p>
<p>
Seuraavassa esimerkit kustakin mainitusta tyypist:
</p>
<source><![CDATA[
#set( $apina = $bill ) ## muuttujaviittaus
#set( $apina.Ystava = "monica" ) ## tekstivakio
#set( $apina.Syytos = $valkoinentalo.vuoto ) ## ominaisuusviittaus
#set( $apina.Suunnitelma = $spindoctor.weave($web) ) ## metodiviittaus
#set( $apina.Numero = 123 ) ## numeerinen vakio
#set( $apina.Sano = ["Ei", $minun, "vikani"] ) ## taulukko
]]></source>
<p>
HUOMAA: Viimeisess esimerkiss [..] operaattorilla mritetyt
elementit ovat kytettviss ArrayList -luokan metodien
avulla. Voisit siis esimerkiksi viitata taulukon ensimmiseen
elementtiin koodilla $apina.Sano.get(0).
</p>
<p>
Oikeanpuoleinen arvo (RHS) voi olla mys yksinkertainen
matemaattinen operaatio:
</p>
<source><![CDATA[
#set( $arvo = $foo + 1 )
#set( $arvo = $bar - 1 )
#set( $arvo = $foo * $bar )
#set( $arvo = $foo / $bar )
]]></source>
<p>
Jos mrityksen oikeanpuoleinen ominaisuus- tai metodiviittaus on
arvoa <em>null</em>, sit <b>ei</b> anneta vasemman puolen
arvoksi. Tt keinoa ei voida kytt olemassa olevan viittauksen
poistamiseen. Tm saattaa olla hmv Velocityn uusille
kyttjille. Esimerkiksi:
</p>
<source><![CDATA[
#set( $tulos = $kysely.kriteeri("nimi") )
Ensimmisen kyselyn tulos on $tulos
#set( $tulos = $kysely.kriteeri("osoite") )
Toisen kyselyn tulos on $tulos
]]></source>
<p>
Jos <em>$kysely.kriteeri("nimi")</em> palauttaa merkkijonon
"pete", ja <em>$kysely.kriteeri("osoite")</em> palauttaa arvon
<em>null</em>, on esimerkin tuloste seuraava:
</p>
<source><![CDATA[
Ensimmisen kyselyn tulos on pete
Toisen kyselyn tulos on pete
]]></source>
<p>
Tll on vaara hmt aloittelijoita jotka muodostavat
<em>#foreach</em> silmukoita joissa yritetn asettaa
<em>#set</em> ohjeella viittausta ominaisuus- tai
metodiviittauksella, ja sen jlkeen testataan tuota viittausta
<em>#if</em> ohjeella. Esimerkiksi:
</p>
<source><![CDATA[
#set( $kriteerit = ["nimi", "osoite"] )
#foreach( $kriteeri in $kriteerit )
#set( $tulos = $kysely.kriteerit($kriteeri) )
#if( $tulos )
Kysely onnistui
#end
#end
]]></source>
<p>
Yll olevassa esimerkiss ei kannata luottaa <em>$tulos</em>
muuttujan vertaamiseen kyselyn onnistumisen selville
saamiseksi. Kun <em>$tulos</em> on asetettu <em>#set</em>
ohjeella (lisatty kontekstiin), sit ei voida asettaa
<em>null</em>:iksi (poistaa kontekstista). <em>#if</em> ja
<em>#foreach</em> ohjeet ksitelln tarkemmin myhemmin tss
dokumentissa.
</p>
<p>
Yksi ratkaisu ongelmaan olisi asettaa <em>$tulos</em> etukteen
arvoon <em>false</em> (eptosi). Tmn jlkeen jos kutsu
<em>$kysely.kriteeri()</em> eponnistuu, voit tarkastaa arvon.
</p>
<source><![CDATA[
#set( $kriteerit = ["nimi", "osoite"] )
#foreach( $kriteeri in $kriteeri )
#set( $tulos = false )
#set( $tulos = $kysely.kriteerit($kriteeri) )
#if( $tulos )
Kysely onnistui
#end
#end
]]></source>
<p>
Muutamista muista Velocityn ohjeista poiketen, <em>#set</em> ohje
ei kyt <em>#end</em> lausetta.
</p>
<a name="Tekstivakiot"><strong>Tekstivakiot</strong></a>
<p>
<em>#set</em> ohjetta kytettess lainausmerkkeihin (" ")
suljettu teksti tulkitaan ja tulostetaan kuten seuraavasta
esimerkist ky ilmi:
</p>
<source><![CDATA[
#set( $hakemistoJuuri = "www" )
#set( $sivupohjaNimi = "index.vm" )
#set( $sivupohja = "$hakemistoJuuri/$sivupohjaNimi" )
$sivupohja
]]></source>
<p>
Tulosteeksi tulee
</p>
<source><![CDATA[
www/index.vm
]]></source>
<p>
Jos teksti on suljettu hipsuihin (' '), sit ei tulkita:
</p>
<source><![CDATA[
#set( $foo = "bar" )
$foo
#set( $blargh = '$foo' )
$blargh
]]></source>
Tulosteeksi tulee:
<source><![CDATA[
bar
$foo
]]></source>
<p>
Tulkitsemattoman tekstin tulostaminen hipsumerkkien sisll
olevavasta tekstist on oletuksena kytss
Velocityss. Oletusarvo voidaan muuttaa vaihtamalla
<code>velocity.properties</code> siten ett
<code>stringliterals.interpolate=false</code>.
</p>
</section>
<section name="If-Else ehtolauseet">
<strong>If / ElseIf / Else</strong>
<p>
<em>#if</em> ohjeen avulla voidaan teksti sisllytt web
sivulle sill ehdolla ett if lauseen arvo on
tosi. Esimerkiksi:
</p>
<source><![CDATA[
#if( $foo )
<strong>Velocity!</strong>
#end
]]></source>
<p>
Muuttuja <em>$foo</em> testataan jotta nhdn onko se tosi,
joka tapahtuu kahdessa eri tapauksessa: (i) <em>$foo</em> on
boolean arvo (tosi/eptosi) jolla on tosi -arvo, tai (ii) arvo
on eri kuin null (eli muuttuja ei ole tyhj). <em>#if</em> ja
<em>#end</em> lauseiden vliin jv sislt tulostetaan mikli
testimuuttuja on tosi. Esimerkkitapauksessamme, jos muuttujalla
<em>$foo</em> on null arvo, tai jos se on boolean eptosi, on
testimuuttuja eptosi, eik tulostetta tule lainkaan.
</p>
<p>
<em>#if</em> ja <em>#end</em> lauseiden vliss oleva teksti
tulee tulosteeksi mikli ehto on tosi. Tss tapauksessa jos
<em>$foo</em> on tosi, tulosteeksi tulee:
"Velocity!". Toisaalta, mikli <em>$foo</em> on eptosi, on mys
ehtolause eptosi eik tulostetta tule.
</p>
<p>
<em>#elseif</em> tai <em>#else</em> elementtej voidaan kytt
<em>#if</em> elementin kanssa. Huomaa, ett Velocityn
sivumoottori lopettaa ensimmisen tosiarvon saaneen
testimuuttujan kohdalla. Oletetaan seuraavassa esimerkiss ett
muuttujalla <em>$foo</em> on arvo 15 ja muuttujalla
<em>$bar</em> on arvo 6.
</p>
<source><![CDATA[
#if( $foo < 10 )
<strong>Mene pohjoiseen</strong>
#elseif( $foo == 10 )
<strong>Mene itn</strong>
#elseif( $bar == 6 )
<strong>Mene eteln</strong>
#else
<strong>Mene lnteen</strong>
#end
]]></source>
<p>Tss esimerkiss <em>$foo</em> on suurempi kuin 10, joten
kaksi ensimmist vertailua eivt ole tosia. Seuraavaksi muuttujaa
<em>$bar</em> verrataan lukuun 6, joka on tosi, joten tulosteeksi
tulee <strong>Mene eteln</strong>.
</p>
<p>
Huomaa, ett nykyiselln Velocityn numeeriset vertailut on
rajoitettu Integer (kokonais-) lukuihin. Kaikki muut arvot
tulkitaan <em>eptosi</em>ksi. Ainoa poikkeus thn on vastaavuus
'==', jolloin Velocity vaatii ett objektit vertailun kummallakin
puolella ovat <em>samaa</em> luokkaa.
</p>
<p>
<a name="Relaatio- ja loogiset operaattorit"><strong>Relaatio- ja
loogiset operaattorit</strong></a>
</p>
<p>
Velocity kytt vastaavuusoperaattoria muuttujien vlisten
suhteiden tulkitsemiseen. Seuraavassa on yksinkertainen esimerkki
vastaavuusoperaattorin kytst.
</p>
<source><![CDATA[
#set ($foo = "deoksiribonukleiinihappo")
#set ($bar = "ribonukleiinihappo")
#if ($foo == $bar)
Muuttujat eivt selvstikn ole samanlaiset. Joten...
#else
Vastaavuusvertaus on eptosi, ja tm teksti tulee tulosteeksi.
#end
]]></source>
<p>
Velocity tukee mys loogisia AND ja OR
operaattoreita. Listietoja lydt dokumentista <a
href="vtl-reference-guide.html">VTL Reference Guide</a>. Alla on
esimerkkilause joka kytt loogista AND:i.
</p>
<source><![CDATA[
## looginen AND
#if( $foo && $bar )
<strong> Tm JA tuo</strong>
#end
]]></source>
<p>
If lause on tosi vain mikli sek <em>$foo</em> ett
<em>$bar</em> ovat tosia. Jos <em>$foo</em> on eptosi, tulee
lauseesta eptosi eik <em>$bar</em> muuttujaa tarvitse edes
testata. Jos <em>$foo</em> on tosi, testataan sen jlkeen
muuttujan <em>$bar</em> arvo; jos mys <em>$bar</em> on tosi,
silloin koko ilmaus on tosi ja <strong>Tm JA tuo</strong>
tulee tulosteeksi. Jos <em>$bar</em> on eptosi, silloin koko
ilmaus on eptosi eik tulostetta tule.
</p>
<p>
Looginen OR operaattori toimii samaan tapaan, paitsi ett vain
toisen viittauksen pit olla tosi jotta koko ilmaus olisi
tosi. Katso seuraavaa esimerkki.
</p>
<source><![CDATA[
## looginen OR
#if( $foo || $bar )
<strong>Tm TAI tuo</strong>
#end
]]></source>
<p>
Jos <em>$foo</em> on tosi, ei <em>$bar</em> muuttujaa tarvitse
edes testata. Oli <em>$bar</em> sitten tosi tai eptosi, koko
lauseke on tosi, ja <strong>Tm TAI tuo</strong> on
tulosteena. Toisaalta mikli <em>$foo</em> on eptosi, on
muuttujan <em>$bar</em> arvo testattava. Jos tss tapauksessa
mys <em>$bar</em> on eptosi, koko ilmauksesta tulee eptosi
eik tulostetta tule. Jos <em>$bar</em> on tosi, silloin koko
ilmauksesta tulee tosi, ja tulosteena on <strong>Tm TAI
tuo</strong>.
</p>
<p>
Loogisella EI (NOT) operaattorilla on vain yksi argumentti :
</p>
<source><![CDATA[
## looginen NOT
#if( !$foo )
<strong>EI tuota</strong>
#end
]]></source>
<p>
Jos <em>$foo</em> on tosi, silloin <em>!$foo</em> on eptosi, eik
tulostetta tmn vuoksi tule. Mikli <em>$foo</em> on eptosi,
silloin <em>!$foo</em> on tosi ja <strong>EI tuota</strong> on
tulosteena. l sekoita tt merkint <em>hiljaiseen viittaukseen
$!foo</em> joka tarkoittaa jotakin aivan muuta.
</p>
</section>
<section name="Silmukat">
<strong>Foreach silmukat</strong>
<p>
<em>#foreach</em> mahdollistaa silmukoiden tekemisen. Esimerkiksi:
</p>
<source><![CDATA[
<ul>
#foreach( $tuote in $kaikkiTuotteet )
<li>$tuote</li>
#end
</ul>
]]></source>
<p>
Tm <em>#foreach</em> silmukka ky lpi yksi kerrallaan kaikki
<em>$kaikkiTuotteet</em> listassa olevat tuotteet. Jokaisella
kierroksella seuraavan tuotteen arvo kopioidaan
<em>$kaikkiTuotteet</em> listasta muuttujaan <em>$tuote</em>.
</p>
<p>
<em>$kaikkiTuotteet</em> lista on tyyppi Vector, Hashtable tai
Array. <em>$tuote</em> muuttujaan kopioitu arvo on java objekti
(Object), joten siihen voidaan mys viitata objektina. Jos
esimerkiksi <em>$tuote</em> muuttuja olisi tyyppi Tuote, sen nimi
voitaisiin hakea viittaamalla <em>$tuote.Name</em> metodiin
(ts. <em>$Tuote.getName()</em>.
</p>
<p>
Oletetaan ett <em>$kaikkiTuotteet</em> on tyyppi Hashtable. Jos
haluat hakea Hashtablen avainarvot sek niihin liittyvt objektit,
voit kytt seuraavanlaista koodia:
</p>
<source><![CDATA[
<ul>
#foreach( $avain in $kaikkiTuotteet.keySet() )
<li>Avain: $avain -> Arvo: $kaikkiTuotteet.get($avain)</li>
#end
</ul>
]]></source>
<p>
Velocityll on helppo keino silmukkalaskurin kyttmiseen. Voit
kytt laskuria esimerkiksi seuraavasti:
</p>
<source><![CDATA[
<table>
#foreach( $asiakas in $asiakasLista )
<tr><td>$velocityCount</td><td>$asiakas.Nimi</td></tr>
#end
</table>
]]></source>
<p>
Silmukkalaskurin oletusnimi on $velocityCount ja se mritetn
velocity.properties tiedostossa. Oletuksena laskuri alkaa arvosta
1, mutta aloitusarvo voidaan mritt olemaan joko 1 tai 0
<code>velocity.properties</code>
tiedostossa. <code>velocity.properties</code> tiedoston
silmukkalaskuriosio nytt tlt:
</p>
<source><![CDATA[
# Silmukkalaskurin oletusnimi
counter.name = velocityCount
# Silmukkalaskurin aloitusarvo
counter.initial.value = 1
]]></source>
</section>
<section name="Include">
<p>
<em>#include</em> elementin avulla sivusuunnittelija voi hakea
paikallisesta tiedostojrjestelmst tiedoston, jonka sislt
listn sivun siihen kohtaan jossa <em>#include</em> mritys
tehtiin. Tiedoston sislt liitetn sellaisenaan eik sit siis
kytet Velocityn sivumoottorin kautta. Turvallisuussyist
haettava tiedosto voi sijaita vain TEMPLATE_ROOT vakion
mrittmn hakemiston alla.
</p>
<source><![CDATA[
#include( "yksi.txt" )
]]></source>
<p>
Tiedosto johon <em>#include</em> ohje viittaa on
lainausmerkeiss. Jos halutaan sisllytt useampia kuin yksi
tiedosto, tiedostonimet tulee erotella toisistaan pilkuilla.
</p>
<source><![CDATA[
#include( "yksi.gif","kaksi.txt","kolme.htm" )
]]></source>
<p>
Sisllytettvn tiedoston ei ole pakko viitata nimen perusteella;
itse asiassa usein on parempi kytt muuttujaa tiedostonimen
asemesta. Tm on hydyllist esimerkiksi silloin kun sivun
ulkoasu riippuu sivupyynnn aikana ptettvst
ehdosta. Seuraavassa on esimerkki jossa kytetn sek
tiedostonime ett muuttujaa.
</p>
<source><![CDATA[
#include( "terveiset.txt", $sesonkivarasto )
]]></source>
</section>
<section name="Parse">
<p>
<em>#parse</em> elementin avulla sivusuunnittelija voi sisllytt
paikallisesta levyjrjestelmst tiedostoja jotka sisltvt VTL
elementtej. Velocity tulkitsee VTL komennot ja tulostaa tuloksen.
</p>
<source><![CDATA[
#parse( "mina.vm" )
]]></source>
<p>
<em>#include</em> ohjeen tapaan <em>#parse</em> voi ottaa
parametrikseen nimen lisksi mys muuttujan. Kaikkien sivupohjien
joihin <em>#parse</em> ohjeella viitataan tulee sijaita
TEMPLATE_ROOT vakion mrittmn hakemiston
alla. <em>#include</em> ohjeesta poiketen <em>#parse</em> voi
ottaa vain yhden argumentin.
</p>
<p>
VTL sivupohjissa voi olla <em>#parse</em> ohjeita jotka viittaavat
sivupohjiin joissa niisskin on <em>#parse</em>
ohjeita. <code>velocity.properties</code> tiedostossa oleva rivi
<em>parse_directive.maxdepth</em> mritt sen kuinka monta
perkkist <em>#parse</em> viittausta voidaan tehd. Mikli
<em>parse_directive.maxdepth</em> mritys puuttuu, kytetn
oletusarvoa 10. Rekursiivisuus on sallittu. Jos esimerkiksi
sivupohja <code>dofoo.vm</code> sislt seuraavat rivit:
</p>
<source><![CDATA[
Laske alaspin.
#set( $laskuri = 8 )
#parse( "parsefoo.vm" )
Kaikki valmista: dofoo.vm!
]]></source>
<p>
Koodi viittaisi sivupohjaan <code>parsefoo.vm</code>, jossa
puolestaan voisi olla seuraavat VTL komennot:
</p>
<source><![CDATA[
$laskuri
#set( $laskuri = $laskuri - 1 )
#if( $laskuri > 0 )
#parse( "parsefoo.vm" )
#else
Kaikki valmista: parsefoo.vm!
#end
]]></source>
<p>
Kun "Laske alaspin." on nytetty, Velocity lataa ja siirt
kontrollin sivupohjalle <code>parsefoo.vm</code>, joka laskee alas
luvusta 8. Kun laskuri saavuttaa arvon 0, tulostetaan "Kaikki
valmista: parsefoo.vm!". Tmn jlkeen Velocity palaa sivupohjaan
<code>dofoo.vm</code> ja tulostaa "Kaikki valmista: dofoo.vm!"
tekstin.
</p>
</section>
<section name="Stop">
<p>
<em>#stop</em> elementin avulla sivupohjan suunnittelija voi
pysytt sivun tulkitsemisen. Tm on hydyllist sivupohjan
virheidenetsinnn aikana.
</p>
<source><![CDATA[
#stop
]]></source>
</section>
<section name="Velocimakrot">
<p>
<em>#macro</em> elementin avulla sivupohjan suunnittelija voi
mritt toistuvasti kytetyn VTL sivupohjan osan. Velocimakrot
ovat erittin kyttkelpoisia sek monimutkaisissa, ett
yksinkertaisissa tehtviss. Seuraava Velocimakro toimii
johdantona Velocimakroihin. Se on luotu kirjoitettavan tekstin
mrn vhentmiseksi, sek kirjoitusvirheiden mrn
minimoimiseksi.
</p>
<source><![CDATA[
#macro( d )
<tr><td></td></tr>
#end
]]></source>
<p>
Esimerkiss mriteltiin Velocimakro nimeltn <em>d</em>, ja sit
voidaan kutsua muiden VTL ohjeiden tapaan:
</p>
<source><![CDATA[
#d()
]]></source>
<p>
Kun tt sivupohjaa haetaan, Velocity korvaa ohjeen <em>#d()</em>
rivill joka sislt yhden tyhjn solun.
</p>
<p>
Velocimakro voi ottaa kuinka monta parametria tahansa -- tai ei
yhtn parametria, kuten ensimmisess esimerkissmme -- mutta kun
Velocimakroa kutsutaan, tulee kutsussa olla tsmlleen yht monta
parametria kuin makroa mriteltess. Useimmat Velocimakrot ovat
hieman monimutkaisempia kuin edellinen esimerkki. Seuraavassa on
Velocimakro joka ottaa kaksi argumenttia; vrin ja listan.
</p>
<source><![CDATA[
#macro( taulurivit $vari $jokulista )
#foreach( $jotain in $jokulista )
<tr><td bgcolor=$vari>$jotain</td></tr>
#end
#end
]]></source>
<p>
Tss esimerkiss mriteltiin Velocimakro <em>taulurivit</em>
joka ottaa kaksi parametria. Ensimminen parametri on
<em>$vari</em> ja toinen <em>$jokulista</em>.
</p>
<p>
Velocimakroon voidaan kirjoittaa mit tahansa koodia jota voidaan
kytt muuallakin VTL sivupohjassa. <em>taulurivit</em>
Velocimakro on <em>foreach</em> lause. <em>taulurivit</em>
Velocimakrossa on kaksi <em>#end</em> lausetta; ensimminen kuuluu
<em>#foreach</em> lauseelle, jlkimminen ptt Velocimakron
mrityksen.
</p>
<source><![CDATA[
#set( $suuretjarvet = ["Superior","Michigan","Huron","Erie","Ontario"] )
#set( $vari = "blue" )
<table>
#taulurivit( $vari $suuretjarvet )
</table>
]]></source>
<p>
Huomaa ett <em>$suuretjarvet</em> on makron parametrin
<em>$jokulista</em> arvona. Kun Velocimakroa <em>#taulurivit</em>
tss tapauksessa kutsutaan, on tuloksena seuraavaa:
</p>
<source><![CDATA[
<table>
<tr><td bgcolor="blue">Superior</td></tr>
<tr><td bgcolor="blue">Michigan</td></tr>
<tr><td bgcolor="blue">Huron</td></tr>
<tr><td bgcolor="blue">Erie</td></tr>
<tr><td bgcolor="blue">Ontario</td></tr>
</table>
]]></source>
<p>
Velocimakroja voidaan mritt <em>inline</em>, eli Velocity
sivupohjassa itsessn, jolloin ko. makro ei ole kytettviss
muissa sivupohjissa. Velocimakron mrittminen siten ett se on
kaikkien sivupohjien kytss on hydyllist; samaa makroa ei
tarvitse mritt erikseen jokaisessa sivupohjassa jossa sit
tarvitaan, jolloin tymr ja virheiden mahdollisuus
vhenee. Lisksi makroon tehty muutos vaikuttaa heti kaikkiin
sivupohjiin joissa se on kytss.
</p>
<p>
Oletetaan ett Velocityss on mriteltyn Velocimakro
<em>#tablerows($vari $lista)</em>. Tt makroa voitaisiin kytt
miss tahansa sivupohjassa. Sit voitaisiin kytt useaan kertaan
ja moneen eri kytttarkoitukseen. Sieniasioita ksittelevss
sivupohjassa <code>sieni.vm</code>, <em>#tablerows</em>
Velocimakroa voitaisiin kytt listaamaan tyypillisen sienen
osat:
</p>
<source><![CDATA[
#set( $osat = ["volva","stipe","annulus","gills","pileus"] )
#set( $cellbgcol = "#CC00FF" )
<table>
#tablerows( $cellbgcol $osat )
</table>
]]></source>
<p>
Kun Velocity luo sivun sivupohjasta <code>sieni.vm</code>, se
etsii Velocimakron <em>#tablerows</em> sivupohjakirjastosta (joka
on mritelty <code>velocity.properties</code> tiedostossa) ja
tuottaa seuraavan tulosteen:
</p>
<source><![CDATA[
<table>
<tr><td bgcolor="#CC00FF">volva</td></tr>
<tr><td bgcolor="#CC00FF">stipe</td></tr>
<tr><td bgcolor="#CC00FF">annulus</td></tr>
<tr><td bgcolor="#CC00FF">gills</td></tr>
<tr><td bgcolor="#CC00FF">pileus</td></tr>
</table>
]]></source>
<strong>Velocimakron argumentit</strong>
<p>
Velocimakrot voivat ottaa argumenteiksi mit tahansa seuraavista
VTL elementeist:
</p>
<ul>
<li>
Viittaus : mit tahansa '$' merkill alkavaa
</li>
<li>
Tekstivakio : esimerkiksi "$foo" tai 'hei'
</li>
<li>
Numerovakio : 1, 2 jne
</li>
<li>
Numerovli : [ 1..2] tai [$foo .. $bar]
</li>
<li>
ObjectArray : [ "a", "b", "c"]
</li>
<li>
boolean arvo true (tosi)
</li>
<li>
boolean arvo false (eptosi)
</li>
</ul>
<p>
Kun siirrt viittauksia argumentteina Velocimakroille, huomaa,
ett viittaukset siirretn 'nimen mukaan' ('by name'). Tm
tarkoittaa sit, ett viittausten arvo 'haetaan' Velocimakrossa
itsessn. Tmn ominaisuuden avulla voit siirt viittauksia
jotka ovat metodikutsuja, ja nin ko. metodeja kutsutaan
Velocimakrossa. Esimerkiksi kun Velocimakroa kutsutaan
seuraavasti:
</p>
<source><![CDATA[
#macro( kutsu $a )
$a $a $a
#end
#kutsu( $foo.bar() )
]]></source>
<p>
tuloksena viittauksen $foo metodia bar() kutsutaan 3 kertaa.
</p>
<p>
Ensi katsomalta tm ominaisuus saattaa vaikuttaa yllttvlt,
mutta kun otat huomioon Velocimakrojen alkuperisen
tarkoituksen -- usein kytettyjen VTL komentojen leikkaa-liimaa
kopioimisen vhentminen -- ominaisuus on perusteltu. Sen
avulla voit esimerkiksi siirt Velocimakroon argumenttina
tilansa muistavia (stateful) objekteja, kuten objektin joka
generoi vrej perkkisess jrjestyksess taulukon rivien
vrien mrittmiseksi.
</p>
<p>
Jos sinun tarvitsee kiert tm ominaisuus, voit hakea arvon
metodista uudeksi viittaukseksi, ja antaa sen argumentiksi:
</p>
<source><![CDATA[
#set( $uusiarvo = $foo.bar() )
#kutsu( $uusiarvo )
]]></source>
<strong>Velocimakro ominaisuudet</strong>
<p>
<code>velocity.properties</code> tiedostossa on useita rivej
joiden avulla Velocimakrojen toimintaa voidaan muuttaa
joustavasti. Huomaa ett nm arvot on dokumentoitu mys <a
href="http://jakarta.apache.org/velocity/developer-guide.html">Kehittjn
oppaassa</a>.
</p>
<p>
<code>velocimacro.library</code> - Pilkulla eroteltu lista
Velocimakro sivupohjakirjastoja. Oletuksena Velocity etsii yht
kirjastoa: <em>VM_global_library.vm</em>. Velocimakro kirjastoja
etsitn mritellyst sivupohjahakemistosta.
</p>
<p>
<code>velocimacro.permissions.allow.inline</code> - Tm
ominaisuus ptt voidaanko Velocimakroja mritt tavallisissa
sivupohjissa. Ominaisuus voi saada arvon true (tosi) tai false
(eptosi). Oletuksena on tosi, jolloin sivusuunnittelijat voivat
mritt Velocimakroja suoraan omissa sivupohjissaan.
</p>
<p>
<code>velocimacro.permissions.allow.inline.to.replace.global</code>
- Tmn ominaisuuden avulla voidaan mritt voivatko
sivupohjassa mritellyt Velocimakrot korvata yleisesti
mritellyt, <code>velocimacro.library</code> ominaisuuden kautta
ladatut Velocimakrot. Ominaisuus voi saada arvon true tai
false. Oletuksena <code>false</code>, eptosi, jolloin
sivupohjassa mritellyt Velocimakrot eivt voi korvata
sivupohjakirjastoista ladattuja makroja.
</p>
<p>
<code>velocimacro.permissions.allow.inline.local.scope</code> -
Mahdolliset arvot ovat true tai false, oletuksena false. Tm
ominaisuus ptt ovatko sivupohjassa mritetyt Velocimakrot
'nkyvi' ainoastaan siin sivupohjassa jossa ne on
mritelty. Toisin sanoen kun tm ominaisuus on asetettu arvoon
true (tosi), sivupohja voi mritt inline Velocimakroja jotka
ovat kytettviss vain sivupohjasta joka ne mritti. Tmn
ominaisuuden avulla voidaan aikaansaada erikoisia vaikutuksia; jos
yleisesti mritelty Velocimakro kutsuu toista yleisesti
mritelty makroa, tmn ominaisuuden avulla sivupohja voi
mritt oman toteutuksensa jlkimmisest makrosta, jota
ensimminen makro kutsuu. Sivupohjan paikallista makroa kytetn
vain kun ensimmist makroa kutsutaan ko. sivupohjasta. Uusi makro
ei vaikuta muihin sivupohjiin.
</p>
<p>
<code>velocimacro.context.localscope</code> - Mahdolliset arvot
ovat true tai false, oletuksena false. Kun ominaisuuden arvoksi on
asetettu tosi, Velocimakroissa #set() ohjeella tehdyt muutokset
ovat 'paikallisia' eivtk vaikuta pysyvsti muuttujien sisltn.
</p>
<p>
<code>velocimacro.library.autoreload</code> - Tm ominaisuus
ohjaa Velocimakrokirjaston automaattista uudelleenlatausta. Kun
ominaisuus on asetettu arvoon <code>true</code> kutsutun
Velocimakron koodi tutkitaan mahdollisten muutosten varalta, ja se
ladataan uudelleen mikli tarpeellista. Nin voit muuttaa ja
testata Velocimakrokirjastoa ilman ett sinun tarvitsee kynnist
uudelleen sovellustasi tai sovellusalustaa, aivan kuten voit tehd
normaalien sivupohjienkin kanssa. Tm asetus toimii vain kun
resurssilataajien vlimuisti on pois plt (<i>off</i>,
esim. <code>file.resource.loader.cache = false</code>). Tm
ominaisuus on tarkoitettu kytettvksi vain sovelluksen
kehitysvaiheessa, ei tuotantokyttn.
</p>
<strong>Velocimakro Trivia</strong>
<p>
Nykyiselln Velocimakrot tulee olla mriteltyin ennen kuin
niit kytetn sivupohjissa. Tm tarkoittaa sit ett #macro()
mritystesi tulee sijaita ennen rivej joissa kytt Velocimakroja.
</p>
<p>
Tm on trke muistaa jos yritt kytt ohjetta #parse()
sivupohjaan jossa on inline #macro() ohjeita. Koska #parse()
suoritetaan ajon aikana, ja parseri ptt ajon aikana onko
sivupohjassa oleva Velocimakrolta nyttv elementti Velocimakro,
ei Velocimakrojen #parse():aminen toimi niin kuin
olettaisi. Ongelma voidaan vltt helposti kyttmll
<code>velocimacro.library</code> toimintoa jonka avulla Velocity
lataa Velocimakrosi kynnistyksen yhteydess.
</p>
</section>
<section name="VTL ohjeiden suojaaminen">
<p>
VTL ohjeet voidaan suojata kenoviivalla ("\") samalla tavalla kuin
VTL viittauksetkin.
</p>
<source><![CDATA[
## #include( "a.txt" ) tulostuu <tiedoston a.txt sislt>
#include( "a.txt" )
## \#include( "a.txt" ) tulostuu \#include( "a.txt" )
\#include( "a.txt" )
## \\#include ( "a.txt" ) tulostuu \<tiedoston a.txt sislt>
\\#include ( "a.txt" )
]]></source>
<p>
Erityst tarkkaavaisuutta tarvitaan tapauksissa joissa suojataan VTL
ohjeita jotka sisltvt useita skriptielementtej samassa ohjeessa
(kuten if-else-end lause). Seuraavassa on tyypillinen VTL if-lause:
</p>
<source><![CDATA[
#if( $jazz )
Vyacheslav Ganelin
#end
]]></source>
<p>
Jos <em>$jazz</em> on tosi (true), tuloste on
</p>
<source><![CDATA[
Vyacheslav Ganelin
]]></source>
<p>
Jos <em>$jazz</em> on eptosi (false), tulostetta ei
tule. Skriptielementtien suojaaminen muuttaa tulostetta. Katso
seuraavaa esimerkki:
</p>
<source><![CDATA[
\#if( $jazz )
Vyacheslav Ganelin
\#end
]]></source>
<p>
Riippumatta siit onko <em>$jazz</em> tosi vai eptosi, tuloste on
aina:
</p>
<source><![CDATA[
#if($ jazz )
Vyacheslav Ganelin
#end
]]></source>
<p>
Itse asiassa koska kaikki skriptielementit on suojattu,
<em>$jazz</em> muuttujan totuusarvoa ei edes tutkita. Oletetaan ett
kenoviiva edelt skriptielementtej jotka on suojattu:
</p>
<source><![CDATA[
\\#if( $jazz )
Vyacheslav Ganelin
\\#end
]]></source>
<p>
Mikli <em>$jazz</em> on tss tapauksessa tosi, tuloste on:
</p>
<source><![CDATA[
\ Vyacheslav Ganelin
\
]]></source>
<p>
Tmn ymmrtmiseksi huomaa, ett <code>#if( arg )</code> rivill
olevaa rivinvaihtoa (return) ei kopioida tulosteeseen. Tmn vuoksi
<code>#if()</code> lauseen runko ('Vyacheslav Ganelin') on '\\'
merkinnst saadun ensimmisen '\' merkin kanssa samalla
rivill. Jlkimminen '\' merkki on toisella rivill kuin teksti,
koska tekstin lopussa on rivinvaihto ja jlkimminen '\\'
merkinnst saatu '\' merkki on ennen <code>#end</code> ohjetta,
joten merkki kuuluu edelleen <code>#if()</code> lauseen runkoon.
</p>
<p>
Jos <em>$jazz</em> on eptosi, ei tulostetta tule. Huomaa ett
ongelmia tulee mikli skriptielementtej ei ole suojattu oikein.
</p>
<source><![CDATA[
\\\#if( $jazz )
Vyacheslave Ganelin
\\#end
]]></source>
<p>
Esimerkiss <em>#if</em> on suojattu, mutta <em>#end</em> elementti
on edelleen kytss. Liian monta lopetuselementti sivupohjassa
aiheuttaa virheen sivua luotaessa.
</p>
</section>
<section name="VTL: Muotoilu">
<p>
Vaikka tss ohjeessa oleva VTL on usein muotoiltu rivivaihdoin ja
vlilynnein, alla oleva VTL
</p>
<source><![CDATA[
#set( $imperial = ["Munetaka","Koreyasu","Hisakira","Morikune"] )
#foreach( $shogun in $imperial )
$shogun
#end
]]></source>
<p>
on yht toimiva kuin seuraava kodinptk jonka Geir Magnusson
Jr. lhetti Velocityn kyttjien postituslistalle:
</p>
<source><![CDATA[
Send me #set($foo = ["$10 and ","a cake"])#foreach($a in $foo)$a #end please.
]]></source>
<p>
Velocity sy ylimriset vlilynnit. Edellinen koodinptk
voitaisiin kirjoittaa seuraavasti:
</p>
<source><![CDATA[
Send me
#set( $foo = ["$10 and ","a cake"] )
#foreach( $a in $foo )
$a
#end
please.
]]></source>
<p>
tai
</p>
<source><![CDATA[
Send me
#set($foo = ["$10 and ","a cake"])
#foreach ($a in $foo )$a
#end please.
]]></source>
<p>
Kussakin tapauksessa tulos on sama.
</p>
</section>
<section name="Muita ominaisuuksia ja sekalaista">
<subsection name="Matematiikka">
<p>
Velocitylla on muutamia sisnrakennettuja matemaattisia
funktioita joita voidaan kytt sivupohjissa <em>#set</em> ohjeen
kanssa. Seuraavat yhtlt ovat esimerkkej yhteen-, vhennys-,
kerto- sek jakolaskuista.
</p>
<source><![CDATA[
#set( $foo = $bar + 3 )
#set( $foo = $bar - 4 )
#set( $foo = $bar * 6 )
#set( $foo = $bar / 2 )
]]></source>
<p>
Jako-operaation tapauksessa tulos on kokonaisluku. Jakojnns
saadaan kyttn jnnsoperandilla (<em>%</em>).
</p>
<source><![CDATA[
#set( $foo = $bar % 5 )
]]></source>
<p>
Matemaattisia funktioita kytettess Velocityss vain
kokonaisluvut (...-2, -1, 0, 1, 2...) ovat sallittuja;
ei-kokonaislukuja kytettess asia kirjataan lokiin ja tulokseksi
palautetaan tyhj arvo (null).
</p>
<p>
Velocityll on sisnrakennettu keino nollalla jakamisen
ksittelemiseen. Seuraavassa esimerkiss:
</p>
<source><![CDATA[
#set( $foo = 5 )
#set( $bar = $foo - 5 )
#set( $uhoh = $foo / $bar )
$uhoh
]]></source>
<p>
Viittaukseen <em>$uhoh</em> asetetaan tulos operaatiosta viisi
jaettuna nollalla. Kun Velocity nytt tmn sivupohjan, tuloste
on:
</p>
<source><![CDATA[
$uhoh
]]></source>
<p>
Suunnittelijoiden on otettava huomioon mys, ett <em>#set</em>
tuottaa merkkijonoja, jotka on muunnettava kokonaisluvuiksi jotta
niit voidaan kytt vaihteluvli mritettess (range
operator). Seuraavassa esimerkki tllaisesta muunnoksesta:
</p>
<source><![CDATA[
#set($a = "7")
#set($b = $int.valueOf($a) + 10)
$b
]]></source>
<p>
Tuloksena on <em>17</em>.
</p>
</subsection>
<subsection name="Vaihteluvli (Range Operator)">
<p>
Vaihteluvli voidaan kytt <em>#set</em> ja <em>#foreach</em>
lauseiden yhteydess. Vaihteluvli tuottaa kokonaislukuja
sisltvi oliotaulukoita seuraavalla tavalla:
</p>
<source><![CDATA[
[n..m]
]]></source>
<p>
Sek <em>n</em> ett <em>m</em> pit olla tai niiden tulee
tuottaa kokonaislukuja. Mikli <em>m</em> on pienempi kuin
<em>n</em> lasketaan vaihteluvlin luvut alaspin. Seuraavassa
esimerkkej vaihteluvlin kytst:
</p>
<source><![CDATA[
Ensimminen esimerkki:
#foreach( $foo in [1..5] )
$foo
#end
Toinen esimerkki:
#foreach( $bar in [2..-2] )
$bar
#end
Kolmas esimerkki:
#set( $arr = [0..1] )
#foreach( $i in $arr )
$i
#end
Neljs esimerkki:
[1..3]
]]></source>
<p>
Tuottaa seuraavan tulosteen:
</p>
<source><![CDATA[
Ensimminen esimerkki:
1 2 3 4 5
Toinen esimerkki:
2 1 0 -1 -2
Kolmas esimerkki:
0 1
Neljs esimerkki:
[1..3]
]]></source>
<p>
Huomaa ett vaihteluvlioperaattori tuottaa taulukon vain kun sit
kytetn <em>#set</em> tai <em>#foreach</em> ohjeiden kanssa,
kuten neljnnest esimerkist ky selville.
</p>
<p>
Vaihteluvlioperaattori on erityisen kyttkelpoinen kun halutaan
tehd verkkosivun taulukko standardikokoiseksi, mutta joissain
tapauksissa taulukon tyttmiseksi ei ole riittvsti dataa.
</p>
</subsection>
<subsection name="Edistyneet kysymykset: Suojaaminen ja !">
<p>
Kun viittaus hiljennetn <em>!</em> merkill ja <em>!</em> merkki
edelt suojausmerkki <em>\</em> ksitelln viittaus erityisell
tavalla. Huomaa erot normaalin suojauksen ja tilanteen jossa
<em>\</em> edelt <em>!</em> merkki, vlill.
</p>
<source><![CDATA[
#set( $foo = "bar" )
$\!foo
$\!{foo}
$\\!foo
$\\\!foo
]]></source>
<p>
Tulosteena on:
</p>
<source><![CDATA[
$!foo
$!{foo}
$\!foo
$\\!foo
]]></source>
<p>
Vertaa tt normaaliin suojaukseen, jossa <em>\</em> on <em>$</em>
merkin edell:
</p>
<source><![CDATA[
\$foo
\$!foo
\$!{foo}
\\$!{foo}
]]></source>
<p>
Tulosteena on:
</p>
<source><![CDATA[
\$foo
\$!foo
\$!{foo}
\bar
]]></source>
</subsection>
<subsection name="Yleist Velocimakroista">
<p>
Tm osio on Velocimakroaiheinen mini-FAQ. Osio muuttuu ajan myt,
joten uutta tietoa hakevien kannattanee palata sivulle aika ajoin.
</p>
<p>
Huom! : Tss osiossa 'Velocimakro':ihin viitataan usein lyhenteell
'VM'.
</p>
<strong>Voinko kytt ohjetta tai toista VM:a argumenttina
VM:oon?</strong>
<p>
Esimerkki : <code>#center( #bold("hello") )</code>
</p>
<p>
Et. Ohje ei ole sallittu argumentti ohjeelle, ja VM on
kytnnllisesti katsoen ohje.
</p>
<p>
<i>Kuitenkin...</i>, voit kiert rajoituksen. Yksinkertainen ratkaisu
on kytt hyvksi sit ett lainausmerkeiss (") oleva teksti
tulkitaan. Tm ansiosta voit tehd seuraavasti:
</p>
<source><![CDATA[
#set($stuff = "#bold('hello')" )
#center( $stuff )
]]></source>
<p>
Voit mys sst rivin...
</p>
<source><![CDATA[
#center( "#bold( 'hello' )" )
]]></source>
<p>
Huomaa ett jlkimmisess esimerkiss parametri ksitelln VM:n
<i>sisll</i>, ei kutsun tasolla. Toisin sanoen VM:lle annettu
parametri siirretn kokonaisuudessaan ja ksitelln VM:ssa johon se
siirrettiin. Tmn ansiosta voit tehd esimerkiksi seuraavaa:
</p>
<source><![CDATA[
#macro( inner $foo )
inner : $foo
#end
#macro( outer $foo )
#set($bar = "outerlala")
outer : $foo
#end
#set($bar = 'calltimelala')
#outer( "#inner($bar)" )
]]></source>
<p>
Tulosteeksi tulee
</p>
<source><![CDATA[
Outer : inner : outerlala
]]></source>
<p>
koska parametrin "#inner($bar)" tulkitseminen tapahtuu lauseen
#outer() sisll, kytetn muuttujan $bar arvoa joka asetettiin
#outer VM:ssa.
</p>
<p>
Tm on tarkoituksellinen ja tarkkaan vaalittu ominaisuus - parametrit
siirretn 'nimen mukaan' ('by name') VM:oon, jotta voit siirt
VM:oon tilansa muistavia (stateful) viittauksia kuten
</p>
<source><![CDATA[
#macro( foo $vari )
<tr bgcolor=$vari><td>Hei</td></tr>
<tr bgcolor=$vari><td>Siell</td></tr>
#end
#foo( $bar.rivinVari() )
]]></source>
<p>
jossa rivinVari() metodia kutsutaan toistuvasti, ei vain kerran. Sen
vlttmiseksi kutsu metodia VM:n ulkopuolelta ja siirr arvo VM:oon.
</p>
<source><![CDATA[
#set($vari = $bar.rivinVari())
#foo( $vari )
]]></source>
<strong>Voinko rekisterid Velocimakroja #parse() :n kautta?
</strong>
<p>
Nykyiselln Velocimakrot tulee olla mriteltyin ennen
ensimmist kytt. Tm tarkoittaa sit ett #macro()
mritystesi tulisi tulla ennen kuin kytt Velocimakroja.
</p>
<p>
Tm on trke muistaa jos yritt kytt ohjetta #parse()
sivupohjaan jossa on inline #macro() ohjeita. Koska #parse()
suoritetaan ajon aikana, ja parseri ptt ajon aikana onko
sivupohjassa oleva Velocimakrolta nyttv elementti Velocimakro,
ei Velocimakrojen #parse():aminen toimi niin kuin
olettaisi. Ongelma voidaan vltt helposti kyttmll
<code>velocimacro.library</code> toimintoa jonka avulla Velocity
lataa Velocimakrosi kynnistyksen yhteydess.
</p>
<strong>Mit tarkoittaa Velocimakrojen automaattinen
uudelleenlataus?</strong>
<p>
On olemassa asetus joka on tarkoitettu kytettvksi jrjestelmn
<i>kehityksen</i> aikana, ei kytss olevassa jrjestelmss :
</p>
<p>
<code>velocimacro.library.autoreload</code>
</p>
<p>
joka on oletuksena pois kytst (false). Kun ominaisuus on
asetettu kyttn (true) <em>yhdess</em> asetuksen
</p>
<p>
<code><type>.resource.loader.cache = false</code>
</p>
<p>
kanssa (jossa <type> on resurssilataajan nimi jota kytt,
kuten 'file'), silloin Velocity lataa automaattisesti
Velocitymakroihin tekemsi muutokset silloin kun teet niit, joten
sinun ei tarvitse kynnist uudelleen sovellusalustaa (tai
ohjelmaa) tai turvautua johonkin muuhun kikkaan saadaksesi
muuttuneet Velocitymakrosi kyttn.
</p>
<p>
Yksinkertainen konfiguraatio saattaisi nytt seuraavalta:
</p>
<source><![CDATA[
file.resource.loader.path = templates
file.resource.loader.cache = false
velocimacro.library.autoreload = true
]]></source>
<p>
l kyt nit asetuksia tuotantokytss.
</p>
</subsection>
<subsection name="Merkkijonojen yhdistminen">
<p>
Yleinen kehittjien kysym kysymys on <i>Kuinka yhdistn
merkkijonoja? Onko olemassa Javan '+' operaattoria vastaavaa
toimintoa?</i>.
</p>
<p>
Viittausten liittmiseksi yhteen VTL:ssa, sinun tarvitsee vain
'laittaa ne yhteen'. Konteksti jossa yhdistt viittaukset
vaikuttaa tuloksiin, joten esimerkit ovat paikallaan.
</p>
<p>
Normaalissa tapauksessa (jolloin sekoitat muuttujat sivupohjan
muuhun sisltn) :
</p>
<source><![CDATA[
#set( $koko = "Big" )
#set( $nimi = "Ben" )
Kello on $iso$nimi.
]]></source>
<p>
tulosteena on 'Kello on BigBen'. Hieman mielenkiintoisemmassa
tapauksessa, kuten silloin kun haluat liitt merkkijonot
siirrettvksi parametrina metodille, tai asettaaksesi uuden
viittauksen, tee seuraavasti:
</p>
<source><![CDATA[
#set( $koko = "Big" )
#set( $nimi = "Ben" )
#set($kello = "$koko$nimi" )
Kello on $kello.
]]></source>
<p>
Josta tulee sama tuloste. Viimeisen esimerkkin, kun haluat
sekoittaa 'staattisia' merkkijonoja viittauksiin, saatat joutua
kyttmn 'muodollista viittausten merkint' :
</p>
<source><![CDATA[
#set( $koko = "Big" )
#set( $nimi = "Ben" )
#set($kello = "${koko}Tall$nimi" )
Kello on $kello.
]]></source>
<p>
Nyt tuloste on 'Kello on BigTallBen'. Muodollista viittausten
merkint kytetn, jotta parseri tietisi ett tarkoitat
viittauksellasi muuttujaa '$size' eik '$sizeTall', jota se
kyttisi mikli et olisi kyttnyt '{}' merkkej.
</p>
</subsection>
</section>
<section name="Palaute">
<p>
Mikli lydt tst ohjeesta virheit tai haluat antaa ohjetta
koskevaa palautetta, ole hyv ja lhet shkpostia <a
href="mailto:velocity-user@jakarta.apache.org">Velocity
kyttjlistalle</a>. Kiitos!
</p>
</section>
</body>
</document>
|