ITI0011:Säuts - koodijuhend - Redigeerimiste ajalugu

Ago: /* Kirjeldus */

2015-04-04T13:56:12Z

Kirjeldus

Ago: /* Koodi käivitamine */

2015-04-04T00:11:30Z

Koodi käivitamine

Ago – 4. aprill 2015, kell 00:05

2015-04-04T00:05:06Z

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T22:38:19Z

Sammud põhiosa tegemiseks

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T22:22:24Z

Sammud põhiosa tegemiseks

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T15:33:32Z

Sammud põhiosa tegemiseks

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T15:30:47Z

Sammud põhiosa tegemiseks

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T15:27:06Z

Sammud põhiosa tegemiseks

Ago: /* Sammud põhiosa tegemiseks */

2015-04-03T15:25:17Z

Sammud põhiosa tegemiseks

Ago: /* Failide paigutamine */

2015-04-01T13:46:59Z

Failide paigutamine

@@ 3. rida: / 3. rida: @@
 Siin lehel on kirjeldatud, kuidas koodi kirjutada 2. kodutöö "Säuts" jaoks. Ülesande kirjeldust loe [[ITI0011:Säuts|siit (Säuts)]].
-Kui tõmbate alla malli, siis see sisaldab päris mitut interface'i. Interface'id on antud ette seepärast, et meil oleks võimalik teie koodi testida. Teine variant oleks see, et oleksime andnud ette n-ö mallid (klassid), kus peate meetodite sisud ära kirjeldama. Interface on selle jaoks sobiv, kui tahame kokku leppida meetodite nimetuses ja struktuuris. Teie peate looma klassid, mis implementeerivad neid interface'e. Kui kogu ülesande lahendate ära, peaks teil arvatavasti 11 java faili tekkima (lisaks interface'i failidele). Esialgu on nõue, et interface'ide failid oleksid samas kaustas (paketis) kogu ülejäänud lahendusega. Võimalik, et jõuame tehniliselt valmis lahenduse, mis oskaks interface'e ka mujalt otsida.
+Kui tõmbate alla malli, siis see sisaldab päris mitut interface'i. Interface'id on antud ette seepärast, et meil oleks võimalik teie koodi testida. Teine variant oleks see, et oleksime andnud ette n-ö mallid (klassid), kus peate meetodite sisud ära kirjeldama. Interface on selle jaoks sobiv, kui tahame kokku leppida meetodite nimetuses ja struktuuris. Teie peate looma klassid, mis implementeerivad neid interface'e. Kui kogu ülesande lahendate ära, peaks teil arvatavasti 11 java faili tekkima (lisaks interface'i failidele). <strike>Esialgu on nõue, et interface'ide failid oleksid samas kaustas (paketis) kogu ülejäänud lahendusega. Võimalik, et jõuame tehniliselt valmis lahenduse, mis oskaks interface'e ka mujalt otsida.</strike> Võite interface'ide jaoks eraldi alamkausta (ehk package'i) luua. Kui lahendus on teil pakis "twitter", siis interface'id võib panna näiteks "twitter.interfaces".
 Nagu selles juhendis näete, on ülesanne jagatud väga väikesteks osadeks. See ei pruugi alati praktiline olla. Kindlasti veendute ise, et selle ülesande lahendamise teeb liigne tükeldamine palju egamugavamaks ja võib-olla isegi ebaloogiliseks. Tükeldamine on aga hea testimise jaoks. Kui teil oleks vaid üks meetod "main", mis saab ette linna nime ja tagastab selles linnas viimased säutsud, siis me saaksime hinnata teie lahendust vaid meetodi väljundi põhjal. Kui te eksite ühe sammuga selles meetodis, on kogu tulemus vale. Automaatselt hinnates võiks tulemus olla 0. Kui me aga jagame ülesande väikesteks tükkideks, saame igat väikest tükki (ehk sammu) eraldi testida. Kui ülejäänud sammud töötavad, viga on ühes sammus, on võimalik kokku saada näiteks 95%. See number on suvaline, aga mõte on ehk arusaadav. Samamoodi on mõistlik päris projektides jagada mingi funktsionaalsus väiksemateks osadeks, et seda testida ning avastada võimalikke vigu.

@@ 211. rida: / 211. rida: @@
      ... execute query action
+}
 </pre>

←Vanem redaktsioon		Redaktsioon: 4. aprill 2015, kell 00:05
132. rida:		132. rida:

	Vaata ka materjalid.git alt praktikum15 koodinäiteid.		Vaata ka materjalid.git alt praktikum15 koodinäiteid.
		+
		+	== Koodi käivitamine ==
		+
		+	''sequence diagram'':
		+
		+	[[Pilt:ITI0011-hw2_main_flow.png]]
		+
		+	Kui programm käima panna, siis kuidas täielikult lahendatud põhiosa töötamine välja näeb (kõik interface'e realiseerivate klasside nimes on esimene täht A, millele järgneb interface'i nimi):
		+	<pre>
		+
		+
		+	staatiline meetod ATwitterApplication.main
		+	argumendiks "args" on käsurealt tulevad parameetrid
		+	meetodi sees luuakse uus instants ATwitterApplication klassist.
		+
		+	1.0)
		+	konstruktor ATwitterApplication
		+	argumente pole
		+	meetodi sees luuakse instantsid erinevatest "teenustest", vt 2.1, 2.2
		+
		+	1.1)
		+	konstruktor ALocationSearch
		+	argumente pole
		+	kutsutakse välja ATWitterApplication konstruktori seest
		+	meetodil sisu ei pea olema (ehk siis konstruktorit ei peagi eraldi kirjutama)
		+
		+	1.2)
		+	konstruktor ATwitterSearch
		+	argumente pole
		+	kutsutakse välja ATwitterApplication konstruktori seest
		+	meetodil sisu ei pea olema (ehk siis konstruktorit ei pea eraldi kirjutama)
		+
		+	1.3)
		+	(ATwitterApplication konstruktor lõpetas ära, jätkub main meetod)
		+	ATwitterApplication.run(args) (siin ja edaspidi väljakutse pole staatiline,
		+	klassi nimi annab märku, et seda tüüpi objekti küljest tuleb meetod "run" välja kutsuda.
		+	Muutuja nimi sõltub sellest, kuidas te selle nimetanud olete.)
		+	Meetodi sisu (olemas interfaces'is) vaatab, kas argumente oli või ei olnud (args.length > 0). Kui argumendid on, pannakse käsurea variant käima
		+
		+	1.4)
		+	ATwitterApplication.runWithArgs(args)
		+	meetodi sisu parsib argumendid tegevuste nimekirjaks (1.5); seejärel käivitab tegevused (1.9).
		+
		+	1.5)
		+	ATwitterApplication.getActionsFromArguments(args)
		+	meetodi sisu: parsib läbi kõik argumendid ja koostab nende põhjal tegevuste nimekirja (List<Action>).
		+	Kuna põhiosas saab tulla vaid tavapäring, loob QueryActioni ja paneb selle listi.
		+	Kui parsimisel tekib viga, tuleb näidata kasutajale juhiseid programmi käivitamiseks.
		+
		+	1.6)
		+	new AQueryAction() (konstruktor)
		+
		+	1.7)
		+	AQueryAction set params (konkreetselt setLocation, setCount)
		+
		+	1.8)
		+	return List<Action>
		+	Konkreetsemalt arvatavasti: return actions;
		+	Kõik actionid pannakse listi ja see tagastatakse.
		+	Kuna põhiosas on vaid üks action, tuleb see sellegipoolest listi panna.
		+
		+	1.9)
		+	ATwitterApplication.executeActions(List<Action>)
		+	Meetod saab ette nimekirja tegevustest ja paneb need käima.
		+	Lahendatud on see nii, et iga elemendi kohta rakendatakse meetodit.
		+	See on default realisatsiooniga interface'is olemas -
		+	arvatavasti seda ei pea muutma
		+	ATwitterApplication.executeAction(Action)
		+
		+	1.10)
		+	ATwitterApplication.executeAction(Action)
		+	Meetod saab ette ühe tegevuse objekti (kus on vajaliku tegevuse jaoks kõik väärtused olemas)
		+	ja käivitab selle tegevuse.
		+	Selle meetodi sisu pead täiesti ise kirjutama.
		+	Tasub kontrollida kõigepealt seda, millist tegevust käivitatakse.
		+	Selleks kasuta instenceof'i:
		+	if (action instanceof QueryAction) {
		+	... execute query action
		+	}
		+	</pre>

@@ 63. rida: / 63. rida: @@
 Loogika põhiosa lahendamiseks:
-# Loo klass, mis implementeerib TwitterApplication'it (see tähendab näiteks <code>public class RocketTwitterApplication implements TwitterApplication</code>). Kuna TwitterApplication on interface, peab kõiki temas kirjeldatud abstraktseid meetodeid kirjeldama loodud klassis. Eclipse suudab seda automaatselt teha nii, et kõik vajalikud meetodid on tühjad. Esialgu sellest piisab, et need on tühjad - hakkad neid ükshaaval täitma.
+<ol>
-# Tee loodud klassi sisse static main, mille sisu on:
-#: TwitterApplication t = new [siia sinu loodud klassi nimi, näiteks RocketTwitterApplication]();
+<li> Loo klass, mis implementeerib TwitterApplication'it (see tähendab näiteks <code>public class RocketTwitterApplication implements TwitterApplication</code>). Kuna TwitterApplication on interface, peab kõiki temas kirjeldatud abstraktseid meetodeid kirjeldama loodud klassis. Eclipse suudab seda automaatselt teha nii, et kõik vajalikud meetodid on tühjad. Esialgu sellest piisab, et need on tühjad - hakkad neid ükshaaval täitma.
-#: t.run(args); <- main meetodisse antav argumentide massiiv, mis tuleb edasi anda run meetodisse
+</li>
-# Loo klassid, mis implementeerivad järgmisi interface'e: LocationSearch, TwitterSearch, TwitterQuery, QueryAction, Tweet. Samamoodi, näiteks <code>public class SuperLocationSearch implements LocationSearch</code> jne. Iga loodav klass peab implementeerima kõiki abstraktseid meetodeid, mis on kirjeldatud vastavas interface'is - esialgu las jäävad tühjaks, jooksvalt hakkad neile sisu kirjutama.
-# Sinu TwitterApplication (edaspidi nimetan klasse, mis implementeerivad mingit interface'i X järgmiselt: Sinu X) klassi konstruktoris loo uus instants Sinu LocationSearch klassist ja Sinu TwitterSearch klassist. Need tuleb ära salvestada Sinu TwitterApplicationi külge vastavalt setLocationSearch ja setTwitterSearch meetoditega.
+<li>
-# Kirjuta sisu meetoditele setLocationSearch, getLocationSearch, setTwitterSearch, getTwitterSearch. Selleks tee kaks muutujat oma loodud TwitterApplication alamklassi, millest üks on vastavalt LocationSearch tüüpi, teine on TwitterSearch tüüpi. set-meetodid võtavad argumendina sisse vastavalt LocationSearch ning TwitterSearch tüüpi objekti. Meetodi sisus toimub näiteks järgmine tegevus: <code>this.myLocationSearchInstance = locationSearch;</code>, ehk siis etteantud objekt salvestatakse teie loodud instantsi muutujasse - sama siis mõlemas set-meetodis.
+Tee loodud klassi sisse static main, mille sisu on (kui näiteks sinu loodud klassi nimi on RocketTwitterApplication):
-# Sinu TwitterApplication'is meetodisse runWithArgs kirjuta umbes selline kood:
+<source lang="java">
-#: List<Action> actions = getActionsFromArguments(args);
+TwitterApplication t = new RocketTwitterApplication();
-#: executeActions(actions);
+t.run(args); // main meetodisse antav argumentide massiiv, mis tuleb edasi anda run meetodisse
-# Sinu TwitterApplication'is meetodisse getActionsFromArguments peaks minema käsurea argumentide töötlemine. Töötlemise tulemusel peaks tekkima nimekiri Action-tüüpi objektidest. Põhiosas on ainuke action QueryAction. Seega, kui päring on korrektne, loo uus instants Sinu QueryAction klassist ja pane see List'i. Selle listi tagastadki. <br />
+</source>
-Arvesta, et QueryAction'ile tuleb külge anda ka parameetrid kasutades setLocation, setCount meetodeid (linn ja säutsude kogus).<source lang="java">List<Action> actions = new ArrayList<Action>();<br />return null;</source>
+</li>
-# Selleks, et eelnevalt juttu olnud QueryAction'i parameetrid saaksid salvestatud, on vaja vastavad meetodid valmis kirjutada. Selleks võta lahti oma loodud QueryAciton'i realisatsioon (näiteks UnrealQueryAction) ja loo sinna kaks muutujat: int count, String location. set-meetodid määravad vastavad väärtused (this.location = location), get-meetodid tagastavad vastavad väärtused (return location).
-# Kui programmi saadud argumendid pole korrektsed või need puuduvad, peaks väljastama abiteksti, kuidas programmi käivitada. Selleks prindi välja vajalikud juhised. Peale juhiste väljaprintimist programm peab lõpetama. Programmi lõpetamiseks kasuta järgmist koodi: <code>System.exit(1);</code>. See lõpetab programmi töö. Etteantav argument (antud juhul 1) tähendab programmi lõpetamise koodi. Vaikimisi, kui programm lõpetab töö tavapäraselt, on selle väärtus 0 (seda kõikide programmide puhul). Kui see arv on 0-st erinev, on tekkinud mingi viga. Erinevate numbritega saab märku anda, mis viga tekkis. Me tahame oma programmi puhul eristada lihtsalt korrektset lõpetamist (kood oleks 0, seda ei pea eraldi programmis ütlema, või kui on vaja, siis <code>System.exit(0);</code>) või ebakorrektset lõpetamist (kood 1).
+<li>
-# Sinu TwitterApplication'is meetodisse executeAction (ainsuses) peaks minema kood, mis oskab etteantud action'it käivitada. See, kuidas sa selle lahendad, on sinu otsustada. Aga üldiselt võiks olla nii, et tingimuse
+Loo klassid, mis implementeerivad järgmisi interface'e: LocationSearch, TwitterSearch, TwitterQuery, QueryAction, Tweet. Samamoodi, näiteks <code>public class SuperLocationSearch implements LocationSearch</code> jne. Iga loodav klass peab implementeerima kõiki abstraktseid meetodeid, mis on kirjeldatud vastavas interface'is - esialgu las jäävad tühjaks, jooksvalt hakkad neile sisu kirjutama.
-#: if (action instanceof QueryAction)
+</li>
-#:korral tehakse umbes järgmised sammud:
-#: Sinu TwitterQuery twitterQuery = getLocationSearch().getQueryFromLocation([location action'i küljest]);
+<li>
-#: List<Sinu Tweet> tweets = getTwitterSearch().getTweets(twitterQuery);
+Sinu TwitterApplication (edaspidi nimetan klasse, mis implementeerivad mingit interface'i X järgmiselt: Sinu X) klassi konstruktoris loo uus instants Sinu LocationSearch klassist ja Sinu TwitterSearch klassist. Need tuleb ära salvestada Sinu TwitterApplicationi külge vastavalt setLocationSearch ja setTwitterSearch meetoditega.
-#: põhiosa puhul võib säutsud nüüd välja printida:
+</li>
-#: for (Tweet tweet : tweets) { ...
 Vaata ka materjalid.git alt praktikum15 koodinäiteid.

@@ 73. rida: / 73. rida: @@
 #: List<Action> actions = getActionsFromArguments(args);
 #: executeActions(actions);
-# Sinu TwitterApplication'is meetodisse getActionsFromArguments peaks minema käsurea argumentide töötlemine. Töötlemise tulemusel peaks tekkima nimekiri Action-tüüpi objektidest. Põhiosas on ainuke action QueryAction. Seega, kui päring on korrektne, loo uus instants Sinu QueryAction klassist ja pane see List'i. Selle listi tagastadki. Arvesta, et QueryAction'ile tuleb külge anda ka parameetrid kasutades setLocation, setCount meetodeid (linn ja säutsude kogus).<source lang="java">List<Action> actions = new ArrayList<Action>();return null;</source>
+# Sinu TwitterApplication'is meetodisse getActionsFromArguments peaks minema käsurea argumentide töötlemine. Töötlemise tulemusel peaks tekkima nimekiri Action-tüüpi objektidest. Põhiosas on ainuke action QueryAction. Seega, kui päring on korrektne, loo uus instants Sinu QueryAction klassist ja pane see List'i. Selle listi tagastadki. <br />
 # Selleks, et eelnevalt juttu olnud QueryAction'i parameetrid saaksid salvestatud, on vaja vastavad meetodid valmis kirjutada. Selleks võta lahti oma loodud QueryAciton'i realisatsioon (näiteks UnrealQueryAction) ja loo sinna kaks muutujat: int count, String location. set-meetodid määravad vastavad väärtused (this.location = location), get-meetodid tagastavad vastavad väärtused (return location).
 # Kui programmi saadud argumendid pole korrektsed või need puuduvad, peaks väljastama abiteksti, kuidas programmi käivitada. Selleks prindi välja vajalikud juhised. Peale juhiste väljaprintimist programm peab lõpetama. Programmi lõpetamiseks kasuta järgmist koodi: <code>System.exit(1);</code>. See lõpetab programmi töö. Etteantav argument (antud juhul 1) tähendab programmi lõpetamise koodi. Vaikimisi, kui programm lõpetab töö tavapäraselt, on selle väärtus 0 (seda kõikide programmide puhul). Kui see arv on 0-st erinev, on tekkinud mingi viga. Erinevate numbritega saab märku anda, mis viga tekkis. Me tahame oma programmi puhul eristada lihtsalt korrektset lõpetamist (kood oleks 0, seda ei pea eraldi programmis ütlema, või kui on vaja, siis <code>System.exit(0);</code>) või ebakorrektset lõpetamist (kood 1).

@@ 73. rida: / 73. rida: @@
 #: List<Action> actions = getActionsFromArguments(args);
 #: executeActions(actions);
-# Sinu TwitterApplication'is meetodisse getActionsFromArguments peaks minema käsurea argumentide töötlemine. Töötlemise tulemusel peaks tekkima nimekiri Action-tüüpi objektidest. Põhiosas on ainuke action QueryAction. Seega, kui päring on korrektne, loo uus instants Sinu QueryAction klassist ja pane see List'i. Selle listi tagastadki. Arvesta, et QueryAction'ile tuleb külge anda ka parameetrid kasutades setLocation, setCount meetodeid (linn ja säutsude kogus).
+# Sinu TwitterApplication'is meetodisse getActionsFromArguments peaks minema käsurea argumentide töötlemine. Töötlemise tulemusel peaks tekkima nimekiri Action-tüüpi objektidest. Põhiosas on ainuke action QueryAction. Seega, kui päring on korrektne, loo uus instants Sinu QueryAction klassist ja pane see List'i. Selle listi tagastadki. Arvesta, et QueryAction'ile tuleb külge anda ka parameetrid kasutades setLocation, setCount meetodeid (linn ja säutsude kogus).<br />
-#: <source lang="java">List<Action> actions = new ArrayList<Action>();
+<source lang="java">List<Action> actions = new ArrayList<Action>();</source>
-FakeQueryAction queryAction = new FakeQueryAction();
+<source lang="java">FakeQueryAction queryAction = new FakeQueryAction(); </source>
 // TODO: add values to queryAction using queryAction.setLocation etc.
 actions.add(queryAction);
 return actions;
-</source>
 # Selleks, et eelnevalt juttu olnud QueryAction'i parameetrid saaksid salvestatud, on vaja vastavad meetodid valmis kirjutada. Selleks võta lahti oma loodud QueryAciton'i realisatsioon (näiteks UnrealQueryAction) ja loo sinna kaks muutujat: int count, String location. set-meetodid määravad vastavad väärtused (this.location = location), get-meetodid tagastavad vastavad väärtused (return location).
 # Kui programmi saadud argumendid pole korrektsed või need puuduvad, peaks väljastama abiteksti, kuidas programmi käivitada. Selleks prindi välja vajalikud juhised. Peale juhiste väljaprintimist programm peab lõpetama. Programmi lõpetamiseks kasuta järgmist koodi: <code>System.exit(1);</code>. See lõpetab programmi töö. Etteantav argument (antud juhul 1) tähendab programmi lõpetamise koodi. Vaikimisi, kui programm lõpetab töö tavapäraselt, on selle väärtus 0 (seda kõikide programmide puhul). Kui see arv on 0-st erinev, on tekkinud mingi viga. Erinevate numbritega saab märku anda, mis viga tekkis. Me tahame oma programmi puhul eristada lihtsalt korrektset lõpetamist (kood oleks 0, seda ei pea eraldi programmis ütlema, või kui on vaja, siis <code>System.exit(0);</code>) või ebakorrektset lõpetamist (kood 1).

@@ 54. rida: / 54. rida: @@
 == Failide paigutamine ==
-Tõmba alla zip-fail, mis sisaldab etteantud malli (interface'ide failid). Loo endale projekt "HW2". Tee sinna sisse näiteks package "rename". Selleks parem klick "src" kausta peal -> new -> package, avanevasse aknasse kirjutad sobiva nime. Sinna alla hakkad oma koodi kirjutama. Põhimõtteliselt võib ka kõik interface'id sinna kopeerida, aga sedasi võivad nad segama hakata. Pigem pane need eraldi pakki/kausta. Selleks tee uuesti parem klikk näiteks "src" või loodud package'i "rename" peal -> new -> package, avanevasse aknasse kirjuta nüüd sobiv nimi koos eelnevalt loodud paketi nimega, näiteks "rename.interfaces". Seejärel kopeeri kõik zip-failis olevad java failid sinna. Kuna zip-failis olevatel failidel "package" puudub, siis peab igale failile vastava "package" info juurde panema (Eclipse saab siin ka aidata, aga saate seda üks fail haaval teha).
+Tõmba alla zip-fail, mis sisaldab etteantud malli (interface'ide failid). Loo endale projekt "HW2". Tee sinna sisse näiteks package "rename". Selleks parem klick "src" kausta peal -> new -> package, avanevasse aknasse kirjutad sobiva nime. Sinna alla hakkad oma koodi kirjutama. Põhimõtteliselt võib ka kõik interface'id sinna kopeerida, aga sedasi võivad nad segama hakata. Pigem pane need eraldi alampakki/alamkausta (pakk asub eelnevalt loodud paki sees). Selleks tee uuesti parem klikk näiteks "src" või loodud package'i "rename" peal -> new -> package, avanevasse aknasse kirjuta nüüd sobiv nimi koos eelnevalt loodud paketi nimega, näiteks "rename.interfaces". Seejärel kopeeri kõik zip-failis olevad java failid sinna. Kuna zip-failis olevatel failidel "package" puudub, siis peab igale failile vastava "package" info juurde panema (Eclipse saab siin ka aidata, aga saate seda üks fail haaval teha).
 ''rename asemel peaks kasutama mingit mõistlikku nime.''