About
Community
Docs
Tools
Comparisons
Site Translations
|
Tietoja tästä oppaasta
|
Velocity käyttäjän opas on tarkoitettu sivusuunnittelijoille ja
sisällöntuottajille avuksi tutustuttaessa Velocityyn ja sen
yksinkertaiseen mutta tehokkaaseen skriptikieleen, Velocity
Template Language:en (VTL). Useat tämän oppaan esimerkeistä
käsittelevät Velocityn käyttämistä dynaamisen sisällön
lisäämiseksi web sivuille, mutta kaikki VTL esimerkit toimivat
HTML sivujen lisäksi yhtä hyvin myös muiden sivujen ja sivupohjien
kanssa.
Kiitos että valitsit Velocityn!
|
|
Mikä on Velocity?
|
Velocity on javapohjainen sivumoottori (template engine). Sen
avulla sivusuunnittelijat voivat viitata java -koodissa
määriteltyihin metodeihin. Sivusuunnittelijat voivat työskennellä
java ohjelmoijien kanssa samanaikaisesti käyttäen
Malli-Näkymä-Ohjain (Model-View-Controller, MVC)
suunnittelumallia. MVC mallissa sivusuunnittelijat voivat
keskittyä täysin luomaan hyvin suunniteltua sivustoa, ja
ohjelmoijat voivat keskittyä koodaamaan ykkösluokan
koodia. Velocity erottaa java -koodin web sivuista, tehden
sivustosta pitkällä aikavälillä helpommin ylläpidettävän ja
antamalla varteenotettavan vaihtoehdon JSP:lle (Java Server
Pages) ja PHP:lle.
Velocityä voidaan käyttää web sivujen, SQL:n, PostScriptin ja
muunlaisten tulosteiden tuottamiseen sivupohjista (template). Sitä
voidaan käyttää joko itsenäisenä työkaluna lähdekoodin ja
raporttien luomiseen, tai muihin järjestelmiin integroituna
komponenttina. Velocity tarjoaa sivupohjaratkaisun Turbine web
sovelluskehykselle. Yhdessä Velocity ja Turbine tarjoavat
sivupohjaratkaisun jonka avulla web sovelluksia voidaan kehittää
todellisen MVC -mallin mukaisesti.
|
|
Miten voin käyttää Velocityä?
|
Kurakauppa esimerkki
|
Oletetaan että olet kuraa myyvän onlinekaupan
sivusuunnittelija. Kutsumme kauppaa "Kurakauppa
Online":ksi. Kauppa käy hyvin. Asiakkaat tilaavat vaihtelevia
määriä eri kuratyyppejä. He pääsevät tutkimaan tekemiään tilauksia
sekä tekemään uusia ostoja kirjautumalla sivullesi käyttäen
käyttäjätunnustaan ja salasanaansa. Tällä hetkellä suosittu
Terracotta -kura on alennusmyynnissä. Pieni osa asiakkaistasi
ostaa säännöllisesti Kirkkaanpunaista Kuraa, joka myös on
alennusmyynnissä, mutta pienemmän suosionsa vuoksi yleensä
mainittu sivulla hieman syrjässä. Tiedot kustakin asiakkaasta
talletetaan tietokantaan, joten eräänä päivänä herää kysymys;
Miksipä emme käyttäisi Velocityä kohdentamaan erikoistarjouksia
kurasta asiakkaille jotka ovat kiinnostuneita juuri tuosta
kuratyypistä?
Velocityn avulla verkkosivut on helppo personoida kävijöidesi
mukaan. Kurakauppa Onlinen sivusuunnittelijana haluat tehdä sivun
jonka asiakas näkee kirjauduttuaan järjestelmään.
Tapaat yrityksesi ohjelmoijat ja sovitte, että muuttuja
$asiakas pitää sisällään tiedot parhaillaan kirjautuneena
olevasta asiakkaasta. Muuttujassa $kuratTarjouksessa ovat
tiedot kuratyypeistä jotka ovat parhaillaan
erikoistarjouksessa. $tarjous objektissa on metodeja
jotka auttavat mainostamisessa. Tällä kertaa keskitymme vain
näihin kolmeen viittaukseen. Muista, että sinun ei tarvitse
huolehtia siitä kuinka ohjelmoijat hakevat tarvittavat tiedot
tietokannasta, sinun tarvitsee tietää vain että se toimii. Näin
pääset tekemään omaa työtäsi ja ohjelmoijat pääsevät tekemään
omaansa.
Voisit lisätä seuraavat VTL lauseen sivulle:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<HTML>
<BODY>
Hei $asiakas.Nimi!
<table>
#foreach( $kura in $kuratTarjouksessa )
#if ( $asiakas.onOstanut($kura) )
<tr>
<td>
$tarjous.haePromo( $kura )
</td>
</tr>
#end
#end
</table>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
foreach lauseen toiminta kuvataan yksityiskohtaisemmin
jäljempänä; tärkeää tässä on tämän lyhyen skriptin tekemä vaikutus
sivullesi. Kun Kirkkaanpunainen Kura on alennusmyynnissä ja sitä
joskus aiemmin ostanut asiakas kirjautuu sisään, asiakas näkee
ilmoituksen alennuksesta parhaalla mahdollisella paikalla. Jos
toinen, Terracottakuraa ostanut asiakas kirjautuu järjestelmään,
ilmoitus Terracottakuran alennusmyynnistä näkyy hänelle
ensimmäisenä. Velocity on joustava ja sen käytössä vain
mielikuvituksesi on rajana.
VTL hakemistossa on kuvattu Velocityn kaikki elementit jotka
yhdessä antavat käyttöösi tehokkaan ja joustavan työkalun jota
tarvitset luodaksesi web sivuistasi dynaamisen. Pääset
hyödyntämään Velocityn voimaa jatkuvasti paremmin sitä mukaa kun
opit käyttämään näitä elementtejä.
|
|
|
|
Velocity Template Language (VTL): Johdanto
|
Velocityn sivunkuvauskieli (Velocity Template Language, VTL)
tarjoaa helpon ja yksinkertaisen keinon liittää dynaamista
sisältöä web sivulle. Dynaamisen sisällön käyttäminen pitäisi
onnistua nopeasti jopa sellaiselta sivusuunnittelijalta jolla on
ohjelmointikokemusta vain vähän, tai ei ollenkaan.
VTL käyttää viittauksia dynaamisen aineiston lisäämiseen
verkkosivulle. Muuttujat ovat yhdentyyppisiä
viittauksia. Muuttujat voivat viitata johonkin java -koodissa
määriteltyyn, tai niiden arvo voidaan määrittää web -sivulla
annetun VTL lauseen avulla. Seuraavassa on esimerkki VTL
lauseesta joka voidaan lisätä HTML -dokumenttiin:
Kuten kaikki VTL lauseet (statement), tämäkin lause alkaa #
merkillä ja sisältää ohjeen (directive): set. Kun verkkosivun
käyttäjä hakee sivun Velocity etsii sivupohjastasi kaikki
# -merkit. Sitten se tulkitsee mitkä niistä merkitsevät
VTL lausetta, ja mitkä # merkeistä ovat osa sivujesi
normaalia HTML -koodia, eivätkä kuulu VTL -koodiin.
# merkkiä seuraa ohje, set. set ohjeen
jälkeen tulee suluissa ilmaus (expression), -- yhtälö joka määrittää
arvon muuttujalle. Muuttuja on ilmaistu
vasemmalla ja arvo oikealla puolella. Nämä on erotettu =
merkillä.
Yllä olevassa esimerkissä muuttuja on $a ja arvo on
Velocity. Kaikkien viittausten tapaan tämäkin muuttuja
alkaa $ merkillä. Arvot ovat aina lainausmerkkien
sisällä; Velocityssä muuttujien datatyypeistä ei tule
sekaannuksia, koska vain merkkijonoja (string) voi antaa
muuttujien arvoksi.
Seuraava nyrkkisääntö voi auttaa ymmärtämään Velocityn toimintaa:
Viittaukset alkavat $ merkillä ja niitä käytetään
jonkin hakemiseen. Ohjeet alkavat # merkillä ja niitä
käytetään jonkin suorittamiseen.
Yllä olevassa esimerkissä #set -ohjetta käytetään arvon
määrittämiseksi muuttujaan. Muuttujaa $a voidaan tämän
jälkeen käyttää sivupohjassa tulostamaan "Velocity".
|
|
Viittaukset
|
VTL:ssä on kolme erityyppistä viittausta: muuttujat, ominaisuudet
ja metodit. VTL:ää käyttävänä sivusuunnittelijana sinun, ja
javapuolta koodaavien ohjelmoijien on sovittava viittausten
nimistä, jotta voit käyttää niitä sivupohjissasi.
Kaikkea viittauksissa olevaa ja niihin määriteltävää tietoa
käsitellään tekstityyppisenä. Jos on esimerkiksi määritelty
objekti $foo (Integer objekti), Velocity kutsuu objektin
.toString() metodia objektin arvon muuntamiseksi
tekstityyppiseksi.
Muuttujat
Muuttujan lyhyt merkintätapa koostuu ensimmäisenä olevasta "$"
merkistä, jonka jälkeen tulee VTL tunniste. VTL
tunnisteen on alettava aakkosnumeerisella merkillä (a..z tai
A..Z). Muuttujan loput merkit ovat rajoitettu seuraaviin:
- aakkoset (a .. z, A .. Z)
- numerot (0 .. 9)
- viiva ("-")
- alaviiva ("_")
Seuraavassa muutamia esimerkkejä toimivista muuttujaviittauksista:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$foo
$kuraLinko
$kura-linko
$kura_linko
$kuraLinko1
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Kun VTL viittaa muuttujaan, kuten $foo, muuttuja voi
saada arvonsa joko sivupohjassa olevalta set ohjeelta,
tai java -koodista. Jos esimerkiksi javamuuttujalla $foo
on arvo bar silloin kun sivupohjaa haetaan, bar
korvaa kaikki $foo muuttujan esiintymiskohdat web
sivulla. Toisaalta jos sivulle lisätään lause
Sivun tuloste on sama kaikilla $foo muuttujan
esiintymiskohdille jotka tulevat tämän lauseen jälkeen.
Ominaisuudet
Toinen VTL:n viittaustyyppi ovat ominaisuudet joilla on oma
tunnusomainen muotonsa. Lyhyt merkintätapa muodostuu ensimmäisenä
olevasta $ merkistä, jonka jälkeen tulee VTL tunniste,
jota seuraa piste (".") ja toinen VTL tunniste. Seuraavassa on
esimerkkejä toimivista ominaisuusviittauksista:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$asiakas.Osoite
$ostos.Summa
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Käsittelemme ensimmäisen esimerkin $asiakas.Osoite
tarkemmin. Viittauksella voi olla kaksi merkitystä. Se saattaa
tarkoittaa; hae asiakas nimisestä hashtable taulukosta
arvo joka on liitetty avaimelle Osoite. Toisaalta
$asiakas.Osoite voi myös viitata metodiin (käsittelemme
metodeihin viittaavat viittaukset seuraavassa kappaleessa);
$asiakas.Osoite saattaa olla lyhennetty muoto
viittauksesta $asiakas.getOsoite(). Velocity tulkitsee
sivua haettaessa kumpaa näistä vaihtoehdoista tarkoitetaan, ja
palauttaa vastaavan arvon.
Metodit
Metodit ovat määritelty java -koodissa ja niiden avulla voidaan
suorittaa jokin toimenpide; esimerkiksi laskutoimitus tai jonkin
päätöksen tekeminen. Metodit ovat viittauksia jotka muodostuvat
aloittavasta "$" merkistä, jota seuraa VTL tunniste, jonka jälkeen
tulee VTL Metodirunko. VTL Metodirunko koostuu VTL
tunnisteesta jota seuraa vasen sulkumerkki "(", jota seuraa
valinnainen parametrilista, jota seuraa oikeanpuoleinen
sulkumerkki ")". Seuraavassa on esimerkkejä toimivista
metodiviittauksista:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$asiakas.getOsoite()
$ostos.getSumma()
$sivu.setOtsake( "Minun kotisivuni" )
$henkilo.setOminaisuudet( ["Outo", "Kummallinen", "Innostunut"] )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Metodirungossa esiintyvä get tarkoittaa "hae" ja set "aseta".
Kaksi ensimmäistä esimerkkiä -- $asiakas.getOsoite() ja
$ostos.getSumma() -- näyttävät samanlaisilta kuin
Ominaisuudet -osiossa aiemmin; $asiakas.Osoite ja
$ostos.Summa. Jos arvasit että näillä esimerkeillä on
jotakin yhteyttä toisiinsa, olit oikeassa!
VTL ominaisuuksia voidaan käyttää lyhyempinä muotoina VTL
metodeista. Ominaisuudella $asiakas.Osoite on täysin sama
vaikutus kuin käyttämällä metodia
$asikas.getOsoite(). Yleisesti ottaen ominaisuuksien
käyttö on suositeltavaa silloin kuin se vain on
mahdollista. Suurin ero ominaisuuksien ja metodien välillä on se,
että metodeille voi antaa parametreja.
Seuraavien metodien kanssa voidaan käyttää lyhyttä muotoa:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$aurinko.getPlaneetat()
$mato.getMulta()
$albumi.getValokuva()
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Näiden metodien voisimme olettaa palauttavan auringolle kuuluvien
planeettojen nimet, syöttävän matomme, tai hakevan valokuvan
albumista. Seuraavissa metodeissa toimii vain pitkä muoto:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$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
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Muodollinen viittausten merkintä
Edellisissä esimerkeissä käytettiin viittauksille lyhyttä
merkintätapaa. Viittauksille on olemassa myös muodollinen
merkintätapa, jota käytetään seuraavissa esimerkeissä:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
${kuraLinko}
${asiakas.Osoite}
${osto.getSumma()}
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Voit käyttää lyhyttä muotoa viittauksiin lähes aina, mutta
joissain tapauksissa muodollista viittausta tarvitaan virheettömän
toiminnan turvaamiseksi.
Oletetaan että olet luomassa lausetta jonka sisältö riippuu
muuttujasta. Muuttujaa $pahe käytetään pohjana luotaessa
muuttujasta riippuvaista sanaa. Tarkoituksena on sallia käyttäjän
valita pohjasana ja tuottaa toinen seuraavista tuloksista: "Juha
on pyromaani." tai "Juha on kleptomaani.". Tässä tapauksessa
lyhyen viittausmuodon käyttäminen ei toimisi. Tutki seuraavaa
esimerkkiä:
Velocity olettaa että tarkoitat muuttujaa $pahemaani,
vaikka käytettävä muuttuja oli $pahe. Koska Velocity ei
löydä arvoa muuttujalle $pahemaani, se palauttaa
$pahemaani. Tämä ongelma voidaan ratkaista käyttämällä
muodollista viittausta.
Nyt Velocity ymmärtää että haluttu viittaus on $pahe, ei
$pahemaani. Muodollinen viittausten merkintä on usein
hyödyllinen silloin kun viittaukset ovat kiinni muussa tekstissä.
Hiljainen viittausten merkintä
Kun Velocityltä haetaan viittaus jolle ei ole määritelty arvoa,
palauttaa se normaalisti viittauksen tekstinä. Oletetaan
esimerkiksi että seuraavat viittaukset ovat osa VTL sivupohjaa:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<input type="text" name="email" value="$email"/>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Kun lomake latautuu ensimmäisen kerran muuttujaviittauksella
$email ei ole arvoa. Oletuksena Velocity täyttää
lomakkeen tekstillä "$email". Haluaisit kuitenkin kenttään
mieluummin tyhjän arvon. Käyttämällä hiljaista viittausten
merkintää voidaan Velocityn normaali toiminta estää;
$email koodin sijaan käytät viittausta
$!email. Yllä oleva koodi näyttäisi siis seuraavalta:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<input type="text" name="email" value="$!email"/>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Kun lomake latautuu ensimmäisen kerran eikä muuttujalla
$email ole arvoa, tulostetaankin kenttään tyhjä teksti
"$email" tekstin sijaan.
Muodollista ja hiljaista muuttujien merkintää voidaan käyttää myös
yhdessä;
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<input type="text" name="email" value="$!{email}"/>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
|
|
Kirjaimellisesti
|
VTL käyttää erikoismerkkejä kuten $ ja # omassa
toiminnassaan, joten näiden merkkien käyttö sivupohjassa vaatii
erityistä huolellisuutta. Tässä kappaleessa käsittelemme
$ merkin suojaamisen (escape).
Dollari
Seuraavassa lauseessa dollarimerkin käytössä ei ole ongelmaa:
"Ostin markkinoilta säkin perunoita hintaan $2.50!". Kuten
mainittu, VTL tunniste alkaa aina aakkosmerkillä, joten merkintää
$2.50 ei ole vaaraa sekoittaa viittaukseksi.
VTL viittausten suojaaminen
Ongelmatilanne saattaa syntyä silloin, kun Velocity ei osaa
päätellä tarkoitetaanko dollarinmerkillä merkkiä itseään, vai
viittausta. Erikoismerkkien suojaaminen on paras keino
käsitellä VTL erikoismerkkejä sivupohjissa. Suojaamiseen käytetään
kenoviivaa ( \ ).
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $email = "foo" )
$email
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Kun Velocity käsittelee $email viittauksen
sivupohjassasi, se etsii löytyykö sen nimiselle muuttujalle
arvoa. Tässä tapauksessa tuloste tulee olemaan foo, koska
$email on määritelty. Jos $email muuttujaa ei
olisi määritelty tulisi tulosteeksi $email.
Oletetaan että $email on määritelty (sillä on esimerkiksi
arvo foo), ja että haluat muuttujan arvon sijaan tulostaa
sen nimen $email. Tämä saavuttamiseksi on useita keinoja,
joista helpoin on suojausmerkin käyttäminen.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
## Seuraava rivi määrittelee muuttujan $email tässä sivupohjassa:
#set( $email = "foo" )
$email
\$email
\\$email
\\\$email
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
tulosteeksi tulee
Huomaa $ merkin eteen liitetty \
merkki. Suojausmerkit tulkitaan vasemmalta oikealle, joten
\\\$email tulostuu \\$email. Vertaa näitä
esimerkkejä tulosteeseen joka saadaan kun $email
muuttujaa ei ole määritelty.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$email
\$email
\\$email
\\\$email
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
tulosteeksi tulee
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
$email
\$email
\\$email
\\\$email
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Huomaa kuinka Velocity käsittelee eri tavalla viittaukset joiden
arvo on määritelty niistä joita ei ole määritelty. Seuraavassa on
set ohje joka asettaa $foo muuttujalle arvon
gibbous.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $foo = "gibbous" )
$kuu = $foo
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tulosteeksi tulee: $kuu = gibbous -- missä $kuu
tulostetaan muuttujan nimenä, koska sen arvoa ei ole määritelty ja
gibbous tulostetaan muuttujan $foo arvona.
Myös VTL ohjeiden suojaaminen on mahdollista; tämä kuvataan
tarkemmin Ohjeet -kappaleessa.
|
|
Ohjeet
|
Ohjeet ovat helppokäyttöisiä skriptielementtejä joita
voidaan käyttää web sivun tulosteen manipuloimiseen. Viittausten
avulla sivupohjien suunnittelijat voivat tuottaa web sivuille
dynaamista sisältöä, kun taas ohjeet antavat mahdollisuuden
määritellä sivuston ulkoasun ja sisällön.
#set
#set ohjetta käytetään arvon määrittämiseksi
viittaukselle. Arvo voidaan määrittää joko muuttujaviittaukselle
tai ominaisuusviittaukselle. Määritys tehdään suluissa, kuten
seuraavassa esimerkissä:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $kadellinen = "apina" )
#set( $asiakas.Kayttaytyminen = $kadellinen )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Määrityksen vasemman puolen (left hand side, LHS) tulee olla
muuttuja- tai ominaisuusviittaus. Oikea puoli (right hand side,
RHS) voi olla jokin seuraavista tyypeistä:
- Muuttujaviittaus
- Tekstivakio
- Ominaisuusviittaus
- Metodiviittaus
- Numeerinen vakio
- ArrayList taulukko
Seuraavassa esimerkit kustakin mainitusta tyypistä:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#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
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
HUOMAA: Viimeisessä esimerkissä [..] operaattorilla määritetyt
elementit ovat käytettävissä ArrayList -luokan metodien
avulla. Voisit siis esimerkiksi viitata taulukon ensimmäiseen
elementtiin koodilla $apina.Sano.get(0).
Oikeanpuoleinen arvo (RHS) voi olla myös yksinkertainen
matemaattinen operaatio:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $arvo = $foo + 1 )
#set( $arvo = $bar - 1 )
#set( $arvo = $foo * $bar )
#set( $arvo = $foo / $bar )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Jos määrityksen oikeanpuoleinen ominaisuus- tai metodiviittaus on
arvoa null, sitä ei anneta vasemman puolen
arvoksi. Tätä keinoa ei voida käyttää olemassa olevan viittauksen
poistamiseen. Tämä saattaa olla hämäävää Velocityn uusille
käyttäjille. Esimerkiksi:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $tulos = $kysely.kriteeri("nimi") )
Ensimmäisen kyselyn tulos on $tulos
#set( $tulos = $kysely.kriteeri("osoite") )
Toisen kyselyn tulos on $tulos
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Jos $kysely.kriteeri("nimi") palauttaa merkkijonon
"pete", ja $kysely.kriteeri("osoite") palauttaa arvon
null, on esimerkin tuloste seuraava:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Ensimmäisen kyselyn tulos on pete
Toisen kyselyn tulos on pete
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tällä on vaara hämätä aloittelijoita jotka muodostavat
#foreach silmukoita joissa yritetään asettaa
#set ohjeella viittausta ominaisuus- tai
metodiviittauksella, ja sen jälkeen testataan tuota viittausta
#if ohjeella. Esimerkiksi:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $kriteerit = ["nimi", "osoite"] )
#foreach( $kriteeri in $kriteerit )
#set( $tulos = $kysely.kriteerit($kriteeri) )
#if( $tulos )
Kysely onnistui
#end
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Yllä olevassa esimerkissä ei kannata luottaa $tulos
muuttujan vertaamiseen kyselyn onnistumisen selville
saamiseksi. Kun $tulos on asetettu #set
ohjeella (lisatty kontekstiin), sitä ei voida asettaa
null:iksi (poistaa kontekstista). #if ja
#foreach ohjeet käsitellään tarkemmin myöhemmin tässä
dokumentissa.
Yksi ratkaisu ongelmaan olisi asettaa $tulos etukäteen
arvoon false (epätosi). Tämän jälkeen jos kutsu
$kysely.kriteeri() epäonnistuu, voit tarkastaa arvon.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $kriteerit = ["nimi", "osoite"] )
#foreach( $kriteeri in $kriteeri )
#set( $tulos = false )
#set( $tulos = $kysely.kriteerit($kriteeri) )
#if( $tulos )
Kysely onnistui
#end
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Muutamista muista Velocityn ohjeista poiketen, #set ohje
ei käytä #end lausetta.
Tekstivakiot
#set ohjetta käytettäessä lainausmerkkeihin (" ")
suljettu teksti tulkitaan ja tulostetaan kuten seuraavasta
esimerkistä käy ilmi:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $hakemistoJuuri = "www" )
#set( $sivupohjaNimi = "index.vm" )
#set( $sivupohja = "$hakemistoJuuri/$sivupohjaNimi" )
$sivupohja
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tulosteeksi tulee
Jos teksti on suljettu hipsuihin (' '), sitä ei tulkita:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $foo = "bar" )
$foo
#set( $blargh = '$foo' )
$blargh
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tulkitsemattoman tekstin tulostaminen hipsumerkkien sisällä
olevavasta tekstistä on oletuksena käytössä
Velocityssä. Oletusarvo voidaan muuttaa vaihtamalla
velocity.properties siten että
stringliterals.interpolate=false .
|
|
If-Else ehtolauseet
|
If / ElseIf / Else
#if ohjeen avulla voidaan teksti sisällyttää web
sivulle sillä ehdolla että if lauseen arvo on
tosi. Esimerkiksi:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#if( $foo )
<strong>Velocity!</strong>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Muuttuja $foo testataan jotta nähdään onko se tosi,
joka tapahtuu kahdessa eri tapauksessa: (i) $foo on
boolean arvo (tosi/epätosi) jolla on tosi -arvo, tai (ii) arvo
on eri kuin null (eli muuttuja ei ole tyhjä). #if ja
#end lauseiden väliin jäävä sisältö tulostetaan mikäli
testimuuttuja on tosi. Esimerkkitapauksessamme, jos muuttujalla
$foo on null arvo, tai jos se on boolean epätosi, on
testimuuttuja epätosi, eikä tulostetta tule lainkaan.
#if ja #end lauseiden välissä oleva teksti
tulee tulosteeksi mikäli ehto on tosi. Tässä tapauksessa jos
$foo on tosi, tulosteeksi tulee:
"Velocity!". Toisaalta, mikäli $foo on epätosi, on myös
ehtolause epätosi eikä tulostetta tule.
#elseif tai #else elementtejä voidaan käyttää
#if elementin kanssa. Huomaa, että Velocityn
sivumoottori lopettaa ensimmäisen tosiarvon saaneen
testimuuttujan kohdalla. Oletetaan seuraavassa esimerkissä että
muuttujalla $foo on arvo 15 ja muuttujalla
$bar on arvo 6.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#if( $foo < 10 )
<strong>Mene pohjoiseen</strong>
#elseif( $foo == 10 )
<strong>Mene itään</strong>
#elseif( $bar == 6 )
<strong>Mene etelään</strong>
#else
<strong>Mene länteen</strong>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tässä esimerkissä $foo on suurempi kuin 10, joten
kaksi ensimmäistä vertailua eivät ole tosia. Seuraavaksi muuttujaa
$bar verrataan lukuun 6, joka on tosi, joten tulosteeksi
tulee Mene etelään.
Relaatio- ja
loogiset operaattorit
Velocity käyttää vastaavuusoperaattoria muuttujien välisten
suhteiden tulkitsemiseen. Seuraavassa on yksinkertainen esimerkki
vastaavuusoperaattorin käytöstä.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set ($foo = "deoksiribonukleiinihappo")
#set ($bar = "ribonukleiinihappo")
#if ($foo == $bar)
Muuttujat eivät selvästikään ole samanlaiset. Joten...
#else
Vastaavuusvertaus on epätosi, ja tämä teksti tulee tulosteeksi.
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Velocity tukee myös loogisia AND ja OR
operaattoreita. Lisätietoja löydät dokumentista VTL Reference Guide. Alla on
esimerkkilause joka käyttää loogista AND:iä.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
## looginen AND
#if( $foo && $bar )
<strong> Tämä JA tuo</strong>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
If lause on tosi vain mikäli sekä $foo että
$bar ovat tosia. Jos $foo on epätosi, tulee
lauseesta epätosi eikä $bar muuttujaa tarvitse edes
testata. Jos $foo on tosi, testataan sen jälkeen
muuttujan $bar arvo; jos myös $bar on tosi,
silloin koko ilmaus on tosi ja Tämä JA tuo
tulee tulosteeksi. Jos $bar on epätosi, silloin koko
ilmaus on epätosi eikä tulostetta tule.
Looginen OR operaattori toimii samaan tapaan, paitsi että vain
toisen viittauksen pitää olla tosi jotta koko ilmaus olisi
tosi. Katso seuraavaa esimerkkiä.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
## looginen OR
#if( $foo || $bar )
<strong>Tämä TAI tuo</strong>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Jos $foo on tosi, ei $bar muuttujaa tarvitse
edes testata. Oli $bar sitten tosi tai epätosi, koko
lauseke on tosi, ja Tämä TAI tuo on
tulosteena. Toisaalta mikäli $foo on epätosi, on
muuttujan $bar arvo testattava. Jos tässä tapauksessa
myös $bar on epätosi, koko ilmauksesta tulee epätosi
eikä tulostetta tule. Jos $bar on tosi, silloin koko
ilmauksesta tulee tosi, ja tulosteena on Tämä TAI
tuo.
Loogisella EI (NOT) operaattorilla on vain yksi argumentti :
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
## looginen NOT
#if( !$foo )
<strong>EI tuota</strong>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Jos $foo on tosi, silloin !$foo on epätosi, eikä
tulostetta tämän vuoksi tule. Mikäli $foo on epätosi,
silloin !$foo on tosi ja EI tuota on
tulosteena. Älä sekoita tätä merkintää hiljaiseen viittaukseen
$!foo joka tarkoittaa jotakin aivan muuta.
|
|
Stop
|
#stop elementin avulla sivupohjan suunnittelija voi
pysäyttää sivun tulkitsemisen. Tämä on hyödyllistä sivupohjan
virheidenetsinnän aikana.
|
|
Velocimakrot
|
#macro elementin avulla sivupohjan suunnittelija voi
määrittää toistuvasti käytetyn VTL sivupohjan osan. Velocimakrot
ovat erittäin käyttökelpoisia sekä monimutkaisissa, että
yksinkertaisissa tehtävissä. Seuraava Velocimakro toimii
johdantona Velocimakroihin. Se on luotu kirjoitettavan tekstin
määrän vähentämiseksi, sekä kirjoitusvirheiden määrän
minimoimiseksi.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#macro( d )
<tr><td></td></tr>
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Esimerkissä määriteltiin Velocimakro nimeltään d, ja sitä
voidaan kutsua muiden VTL ohjeiden tapaan:
Kun tätä sivupohjaa haetaan, Velocity korvaa ohjeen #d()
rivillä joka sisältää yhden tyhjän solun.
Velocimakro voi ottaa kuinka monta parametria tahansa -- tai ei
yhtään parametria, kuten ensimmäisessä esimerkissämme -- mutta kun
Velocimakroa kutsutaan, tulee kutsussa olla täsmälleen yhtä monta
parametria kuin makroa määriteltäessä. Useimmat Velocimakrot ovat
hieman monimutkaisempia kuin edellinen esimerkki. Seuraavassa on
Velocimakro joka ottaa kaksi argumenttia; värin ja listan.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#macro( taulurivit $vari $jokulista )
#foreach( $jotain in $jokulista )
<tr><td bgcolor=$vari>$jotain</td></tr>
#end
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tässä esimerkissä määriteltiin Velocimakro taulurivit
joka ottaa kaksi parametria. Ensimmäinen parametri on
$vari ja toinen $jokulista.
Velocimakroon voidaan kirjoittaa mitä tahansa koodia jota voidaan
käyttää muuallakin VTL sivupohjassa. taulurivit
Velocimakro on foreach lause. taulurivit
Velocimakrossa on kaksi #end lausetta; ensimmäinen kuuluu
#foreach lauseelle, jälkimmäinen päättää Velocimakron
määrityksen.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $suuretjarvet = ["Superior","Michigan","Huron","Erie","Ontario"] )
#set( $vari = "blue" )
<table>
#taulurivit( $vari $suuretjarvet )
</table>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Huomaa että $suuretjarvet on makron parametrin
$jokulista arvona. Kun Velocimakroa #taulurivit
tässä tapauksessa kutsutaan, on tuloksena seuraavaa:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<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>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Velocimakroja voidaan määrittää inline, eli Velocity
sivupohjassa itsessään, jolloin ko. makro ei ole käytettävissä
muissa sivupohjissa. Velocimakron määrittäminen siten että se on
kaikkien sivupohjien käytössä on hyödyllistä; samaa makroa ei
tarvitse määrittää erikseen jokaisessa sivupohjassa jossa sitä
tarvitaan, jolloin työmäärä ja virheiden mahdollisuus
vähenee. Lisäksi makroon tehty muutos vaikuttaa heti kaikkiin
sivupohjiin joissa se on käytössä.
Oletetaan että Velocityssä on määriteltynä Velocimakro
#tablerows($vari $lista). Tätä makroa voitaisiin käyttää
missä tahansa sivupohjassa. Sitä voitaisiin käyttää useaan kertaan
ja moneen eri käyttötarkoitukseen. Sieniasioita käsittelevässä
sivupohjassa sieni.vm , #tablerows
Velocimakroa voitaisiin käyttää listaamaan tyypillisen sienen
osat:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $osat = ["volva","stipe","annulus","gills","pileus"] )
#set( $cellbgcol = "#CC00FF" )
<table>
#tablerows( $cellbgcol $osat )
</table>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Kun Velocity luo sivun sivupohjasta sieni.vm , se
etsii Velocimakron #tablerows sivupohjakirjastosta (joka
on määritelty velocity.properties tiedostossa) ja
tuottaa seuraavan tulosteen:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
<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>
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Velocimakron argumentit
Velocimakrot voivat ottaa argumenteiksi mitä tahansa seuraavista
VTL elementeistä:
-
Viittaus : mitä tahansa '$' merkillä alkavaa
-
Tekstivakio : esimerkiksi "$foo" tai 'hei'
-
Numerovakio : 1, 2 jne
-
Numeroväli : [ 1..2] tai [$foo .. $bar]
-
ObjectArray : [ "a", "b", "c"]
-
boolean arvo true (tosi)
-
boolean arvo false (epätosi)
Kun siirrät viittauksia argumentteina Velocimakroille, huomaa,
että viittaukset siirretään 'nimen mukaan' ('by name'). Tämä
tarkoittaa sitä, että viittausten arvo 'haetaan' Velocimakrossa
itsessään. Tämän ominaisuuden avulla voit siirtää viittauksia
jotka ovat metodikutsuja, ja näin ko. metodeja kutsutaan
Velocimakrossa. Esimerkiksi kun Velocimakroa kutsutaan
seuraavasti:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#macro( kutsu $a )
$a $a $a
#end
#kutsu( $foo.bar() )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
tuloksena viittauksen $foo metodia bar() kutsutaan 3 kertaa.
Ensi katsomalta tämä ominaisuus saattaa vaikuttaa yllättävältä,
mutta kun otat huomioon Velocimakrojen alkuperäisen
tarkoituksen -- usein käytettyjen VTL komentojen leikkaa-liimaa
kopioimisen vähentäminen -- ominaisuus on perusteltu. Sen
avulla voit esimerkiksi siirtää Velocimakroon argumenttina
tilansa muistavia (stateful) objekteja, kuten objektin joka
generoi värejä peräkkäisessä järjestyksessä taulukon rivien
värien määrittämiseksi.
Jos sinun tarvitsee kiertää tämä ominaisuus, voit hakea arvon
metodista uudeksi viittaukseksi, ja antaa sen argumentiksi:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set( $uusiarvo = $foo.bar() )
#kutsu( $uusiarvo )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Velocimakro ominaisuudet
velocity.properties tiedostossa on useita rivejä
joiden avulla Velocimakrojen toimintaa voidaan muuttaa
joustavasti. Huomaa että nämä arvot on dokumentoitu myös Kehittäjän
oppaassa.
velocimacro.library - Pilkulla eroteltu lista
Velocimakro sivupohjakirjastoja. Oletuksena Velocity etsii yhtä
kirjastoa: VM_global_library.vm. Velocimakro kirjastoja
etsitään määritellystä sivupohjahakemistosta.
velocimacro.permissions.allow.inline - Tämä
ominaisuus päättää voidaanko Velocimakroja määrittää tavallisissa
sivupohjissa. Ominaisuus voi saada arvon true (tosi) tai false
(epätosi). Oletuksena on tosi, jolloin sivusuunnittelijat voivat
määrittää Velocimakroja suoraan omissa sivupohjissaan.
velocimacro.permissions.allow.inline.to.replace.global
- Tämän ominaisuuden avulla voidaan määrittää voivatko
sivupohjassa määritellyt Velocimakrot korvata yleisesti
määritellyt, velocimacro.library ominaisuuden kautta
ladatut Velocimakrot. Ominaisuus voi saada arvon true tai
false. Oletuksena false , epätosi, jolloin
sivupohjassa määritellyt Velocimakrot eivät voi korvata
sivupohjakirjastoista ladattuja makroja.
velocimacro.permissions.allow.inline.local.scope -
Mahdolliset arvot ovat true tai false, oletuksena false. Tämä
ominaisuus päättää ovatko sivupohjassa määritetyt Velocimakrot
'näkyviä' ainoastaan siinä sivupohjassa jossa ne on
määritelty. Toisin sanoen kun tämä ominaisuus on asetettu arvoon
true (tosi), sivupohja voi määrittää inline Velocimakroja jotka
ovat käytettävissä vain sivupohjasta joka ne määritti. Tämän
ominaisuuden avulla voidaan aikaansaada erikoisia vaikutuksia; jos
yleisesti määritelty Velocimakro kutsuu toista yleisesti
määriteltyä makroa, tämän ominaisuuden avulla sivupohja voi
määrittää oman toteutuksensa jälkimmäisestä makrosta, jota
ensimmäinen makro kutsuu. Sivupohjan paikallista makroa käytetään
vain kun ensimmäistä makroa kutsutaan ko. sivupohjasta. Uusi makro
ei vaikuta muihin sivupohjiin.
velocimacro.context.localscope - Mahdolliset arvot
ovat true tai false, oletuksena false. Kun ominaisuuden arvoksi on
asetettu tosi, Velocimakroissa #set() ohjeella tehdyt muutokset
ovat 'paikallisia' eivätkä vaikuta pysyvästi muuttujien sisältöön.
velocimacro.library.autoreload - Tämä ominaisuus
ohjaa Velocimakrokirjaston automaattista uudelleenlatausta. Kun
ominaisuus on asetettu arvoon true kutsutun
Velocimakron koodi tutkitaan mahdollisten muutosten varalta, ja se
ladataan uudelleen mikäli tarpeellista. Näin voit muuttaa ja
testata Velocimakrokirjastoa ilman että sinun tarvitsee käynnistää
uudelleen sovellustasi tai sovellusalustaa, aivan kuten voit tehdä
normaalien sivupohjienkin kanssa. Tämä asetus toimii vain kun
resurssilataajien välimuisti on pois päältä (off,
esim. file.resource.loader.cache = false ). Tämä
ominaisuus on tarkoitettu käytettäväksi vain sovelluksen
kehitysvaiheessa, ei tuotantokäyttöön.
Velocimakro Trivia
Nykyisellään Velocimakrot tulee olla määriteltyinä ennen kuin
niitä käytetään sivupohjissa. Tämä tarkoittaa sitä että #macro()
määritystesi tulee sijaita ennen rivejä joissa käytät Velocimakroja.
Tämä on tärkeää muistaa jos yrität käyttää ohjetta #parse()
sivupohjaan jossa on inline #macro() ohjeita. Koska #parse()
suoritetaan ajon aikana, ja parseri päättää ajon aikana onko
sivupohjassa oleva Velocimakrolta näyttävä elementti Velocimakro,
ei Velocimakrojen #parse():aminen toimi niin kuin
olettaisi. Ongelma voidaan välttää helposti käyttämällä
velocimacro.library toimintoa jonka avulla Velocity
lataa Velocimakrosi käynnistyksen yhteydessä.
|
|
VTL ohjeiden suojaaminen
|
VTL ohjeet voidaan suojata kenoviivalla ("\") samalla tavalla kuin
VTL viittauksetkin.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
## #include( "a.txt" ) tulostuu <tiedoston a.txt sisältö>
#include( "a.txt" )
## \#include( "a.txt" ) tulostuu #include( "a.txt" )
\#include( "a.txt" )
## \\#include ( "a.txt" ) tulostuu \<tiedoston a.txt sisältö>
\\#include ( "a.txt" )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Eritystä tarkkaavaisuutta tarvitaan tapauksissa joissa suojataan VTL
ohjeita jotka sisältävät useita skriptielementtejä samassa ohjeessa
(kuten if-else-end lause). Seuraavassa on tyypillinen VTL if-lause:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#if( $jazz )
Vyacheslav Ganelin
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Jos $jazz on tosi (true), tuloste on
Jos $jazz on epätosi (false), tulostetta ei
tule. Skriptielementtien suojaaminen muuttaa tulostetta. Katso
seuraavaa esimerkkiä:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
\#if( $jazz )
Vyacheslav Ganelin
\#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Riippumatta siitä onko $jazz tosi vai epätosi, tuloste on
aina:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#if($ jazz )
Vyacheslav Ganelin
#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Itse asiassa koska kaikki skriptielementit on suojattu,
$jazz muuttujan totuusarvoa ei edes tutkita. Oletetaan että
kenoviiva edeltää skriptielementtejä jotka on suojattu:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
\\#if( $jazz )
Vyacheslav Ganelin
\\#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Mikäli $jazz on tässä tapauksessa tosi, tuloste on:
Tämän ymmärtämiseksi huomaa, että #if( arg ) rivillä
olevaa rivinvaihtoa (return) ei kopioida tulosteeseen. Tämän vuoksi
#if() lauseen runko ('Vyacheslav Ganelin') on '\\'
merkinnästä saadun ensimmäisen '\' merkin kanssa samalla
rivillä. Jälkimmäinen '\' merkki on toisella rivillä kuin teksti,
koska tekstin lopussa on rivinvaihto ja jälkimmäinen '\\'
merkinnästä saatu '\' merkki on ennen #end ohjetta,
joten merkki kuuluu edelleen #if() lauseen runkoon.
Jos $jazz on epätosi, tuloste on:
Huomaa että
ongelmia tulee mikäli skriptielementtejä ei ole suojattu oikein.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
\\\#if( $jazz )
Vyacheslave Ganelin
\\#end
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Esimerkissä #if on suojattu, mutta #end elementti
on edelleen käytössä. Liian monta lopetuselementtiä sivupohjassa
aiheuttaa virheen sivua luotaessa.
|
|
Muita ominaisuuksia ja sekalaista
|
Yleistä Velocimakroista
|
Tämä osio on Velocimakroaiheinen mini-FAQ. Osio muuttuu ajan myötä,
joten uutta tietoa hakevien kannattanee palata sivulle aika ajoin.
Huom! : Tässä osiossa 'Velocimakro':ihin viitataan usein lyhenteellä
'VM'.
Voinko käyttää ohjetta tai toista VM:a argumenttina
VM:oon?
Esimerkki : #center( #bold("hello") )
Et. Ohje ei ole sallittu argumentti ohjeelle, ja VM on
käytännöllisesti katsoen ohje.
Kuitenkin..., voit kiertää rajoituksen. Yksinkertainen ratkaisu
on käyttää hyväksi sitä että lainausmerkeissä (") oleva teksti
tulkitaan. Tämä ansiosta voit tehdä seuraavasti:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set($stuff = "#bold('hello')" )
#center( $stuff )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Voit myös säästää rivin...
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#center( "#bold( 'hello' )" )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Huomaa että jälkimmäisessä esimerkissä parametri käsitellään VM:n
sisällä, ei kutsun tasolla. Toisin sanoen VM:lle annettu
parametri siirretään kokonaisuudessaan ja käsitellään VM:ssa johon se
siirrettiin. Tämän ansiosta voit tehdä esimerkiksi seuraavaa:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#macro( inner $foo )
inner : $foo
#end
#macro( outer $foo )
#set($bar = "outerlala")
outer : $foo
#end
#set($bar = 'calltimelala')
#outer( "#inner($bar)" )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Tulosteeksi tulee
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Outer : inner : outerlala
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
koska parametrin "#inner($bar)" tulkitseminen tapahtuu lauseen
#outer() sisällä, käytetään muuttujan $bar arvoa joka asetettiin
#outer VM:ssa.
Tämä on tarkoituksellinen ja tarkkaan vaalittu ominaisuus - parametrit
siirretään 'nimen mukaan' ('by name') VM:oon, jotta voit siirtää
VM:oon tilansa muistavia (stateful) viittauksia kuten
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#macro( foo $vari )
<tr bgcolor=$vari><td>Hei</td></tr>
<tr bgcolor=$vari><td>Siellä</td></tr>
#end
#foo( $bar.rivinVari() )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
jossa rivinVari() metodia kutsutaan toistuvasti, ei vain kerran. Sen
välttämiseksi kutsu metodia VM:n ulkopuolelta ja siirrä arvo VM:oon.
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
#set($vari = $bar.rivinVari())
#foo( $vari )
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Voinko rekisteröidä Velocimakroja #parse() :n kautta?
Nykyisellään Velocimakrot tulee olla määriteltyinä ennen
ensimmäistä käyttöä. Tämä tarkoittaa sitä että #macro()
määritystesi tulisi tulla ennen kuin käytät Velocimakroja.
Tämä on tärkeää muistaa jos yrität käyttää ohjetta #parse()
sivupohjaan jossa on inline #macro() ohjeita. Koska #parse()
suoritetaan ajon aikana, ja parseri päättää ajon aikana onko
sivupohjassa oleva Velocimakrolta näyttävä elementti Velocimakro,
ei Velocimakrojen #parse():aminen toimi niin kuin
olettaisi. Ongelma voidaan välttää helposti käyttämällä
velocimacro.library toimintoa jonka avulla Velocity
lataa Velocimakrosi käynnistyksen yhteydessä.
Mitä tarkoittaa Velocimakrojen automaattinen
uudelleenlataus?
On olemassa asetus joka on tarkoitettu käytettäväksi järjestelmän
kehityksen aikana, ei käytössä olevassa järjestelmässä :
velocimacro.library.autoreload
joka on oletuksena pois käytöstä (false). Kun ominaisuus on
asetettu käyttöön (true) yhdessä asetuksen
<type>.resource.loader.cache = false
kanssa (jossa <type> on resurssilataajan nimi jota käytät,
kuten 'file'), silloin Velocity lataa automaattisesti
Velocitymakroihin tekemäsi muutokset silloin kun teet niitä, joten
sinun ei tarvitse käynnistää uudelleen sovellusalustaa (tai
ohjelmaa) tai turvautua johonkin muuhun kikkaan saadaksesi
muuttuneet Velocitymakrosi käyttöön.
Yksinkertainen konfiguraatio saattaisi näyttää seuraavalta:
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
file.resource.loader.path = templates
file.resource.loader.cache = false
velocimacro.library.autoreload = true
|
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
![](/images/void.gif) |
Älä käytä näitä asetuksia tuotantokäytössä.
|
|
|
|
|