Package shell

Class Branch

java.lang.Object

shell.Node

shell.Command

shell.Branch

All Implemented Interfaces:

Condition

Direct Known Subclasses:

All, Any, App, Contains, Detail, GroupMin, Max, Min, Mover, Place, Placer

public class Branch
extends Command

Nadtřída všech ovladačů uzlů. Rozvětvení nadřazeného uzlu na více podřízených. Zavádí obecný kontejner vnořených uzlů nodes, které bude ovládat. Rozšiřuje metodu procházení go() o práci s tímto kontejnerem. Překládá "lidskou" slovní identifikaci (slovo z příkazové řádky) vnořeného uzlu na identifikaci strojovou (odkaz na objekt/uzel node). Podporuje ovládání vnořeného uzlu node podle módu aktivity metodou nodeCover(), která v případě neaktivity jen předává zpracování metodě nodeGo(), která se stará o údržbu aktuální úrovně Node.level. Vyhodnocení módu aktivity řeší už metoda Command.active() předka Command, která jej z Node.level odvozuje. Metoda nodeGo() vstupuje do vnořeného uzlu (předává mu řízení voláním jeho metody Node.go()). Metody go() všech objektů tvoří základní rozhraní procházení stromovou strukturou uzlů. V aktivním módu (Command.active()) je otestováno metodou nodeCondition(), zda jsou splněny podmínky pro vykonání akce nebo ne. Pokud ano, je zpracování předáno metodě nodeAction() a poté metodě outDone(), která informuje o úspěšném provedení. Pokud ne, metoda outError() informuje o chybě. Metody nodeCondition() a nodeAction() jsou určeny k vlastím implementacím v potomcích. Ve výchozí implementaci nodeCondition() jen vrací true (žádné podmínky) a nodeAction() provádí jen nodeGo(). Tak je zajištěno, že je nutné v potomcích implemetovat jen to skutečně potřebné, nebo před implementací vlastních akcí nejprve ladit splnění podmínek ve vlastní metodě nodeCondition() a až poté implementovat vlastní nodeAction(). Protože výchozí nodeAction() je implementována jako přesměrování na nodeGo(), bude se objekt i v nodeAction() chovat stejně jako v módu nodeGo(), dokud nebude v potomcích implementována nodeAction() vlastní. Třída podporuje dvě možnosti zpracování vnořených uzlů. Nejprve se pokusí vzít slovo ze vstupu (Prompt.hasNext()) jako "lidský" identifikátor uzlu. Pokud slovo ve vstupu je, odebere jej metodou Prompt.next() a pokusí se jej přeložit na strojovou identifikaci (hledá podle slova odkaz na node v kontejneru nodes metodou findFirst(java.lang.String)). Pokud je uzel nalezen, zpracuje jej. Pokud ne, tiskne se chyba metodou outErrorPath(). Pokud slovo chybí úplně, standardně se mají zpracovat vnořené uzly nodes všechny. Povinnost identifikovat jeden konkrétní uzel z nodes je možné zapnout parametrem levelNodePath. Pak se v řípadě chybějící identifikace v Prompt tiskne chyba metodou outErrorWord(). levelNodePath je potřeba nastavit například u ovladače všech příkazů App, aby jeho metoda go() nezpracovala všechny najednou, nebo u konkrétních příkazů: (Placer - aby šlo jít jen do jednoho východu, "pick" - aby šlo jedním příkazem sebrat jen jeden předmět, atd.). Naopak, výchozí hodnota parametru levelNodePath poskytuje možnost procházení celým stromem uzlů, nebo jen určitým podstromem, pokud je v Prompt zadána alespoň část "cesty". Command.levelActive i levelNodePath jsou "úrovňové" atributy, které říkají, na jaké úrovni se má chování změnit. "Úrovňové" chování Branch objektů je tedy možné jednoduše ovlivnit nastavováním těchto atributů. Veškeré textové podklady pro komponování výstupních textů, jsou standardizovány parametry masterDelimiter, nodesBegin, nodesEmpty, nodesDelimiter, nodesEnd a recurse. Metody nodeCover(), nodeCondition() a nodeAction() odpovídají stejné koncepci, jakou mají metody Command.cover(), Command.condition() a Command.action() v třídě předka Command.

Field Summary

Fields

Modifier and Type	Field	Description
boolean	dNode	vypisovat za hláškou úspěchu název uzlu a tečku
boolean	eNode	vypisovat za chybovou hláškou název uzlu a tečku
java.lang.String	errorPath	odpověď v případě chyby při nesplnění povinnosti identifikovat jeden konkrétní uzel z nodes podle levelNodePath
java.lang.String	errorPathDelimiter	oddělovač zprávy od uzlu
java.lang.String	errorWord	odpověď v případě chyby nenalezeného identifikátoru ze vstupu načerpaného metodou Prompt.next(); hledá se v nodes metodou findFirst(java.lang.String)
boolean	extName	vypisovat za hláškou úspěchu rozšířený název uzlu (Node.outExtName() namísto Node.outName())
int	levelNodePath	úroveň zanoření, na které platí povinnost uvést slovo/cestu; pokud není tímto parametrem zapnuta a uživatel slovo neuvede, zpracují se všechny nodes v kontejneru
java.lang.String	masterDelimiter	oddělovač uzlu od svého kontejneru, není-li noPrint
Node	node	pracovní ukazatel na uzel, který se má zpracovat
Nodes	nodes	kontejner vnořených uzlů třídy Nodes; hodnota null přepíná chování objektu na chování předka; je to výchozí stav
java.lang.String	nodesBegin	uvaděč kontejneru vnořených uzlů
java.lang.String	nodesDelimiter	oddělovač uzlů v kontejneru, je-li jich zpracováváno více než jeden
java.lang.String	nodesEmpty	nahrazovač výpisu kontejneru vnořených uzlů, je-li kontejner prázdný
java.lang.String	nodesEnd	ukončovač kontejneru vnořených uzlů
boolean	noGoEmpty	do rozvětvení (s tiskem uzlu) se v případě prázdného kontejneru nemá vůbec vstupovat; standardně se vstoupí do rozvětvení i v případě prázdného kontejneru a namísto kontejneru se tiskne nodesEmpty
boolean	noPathNoAll	pokud není uvedena cesta, která je povinná a není tímto příznakem zakázano, přepne se procházení na výpisy všech uzlů - jen se mód aktivity zablokuje, aby se namísto provedení vypsal seznam všech možností
boolean	noPrint	před rozvětvením uzlu se uzel nemá tisknout
static java.util.ArrayList<Node>	passed	pole aktuální cesty uzlů při stromovém zpracování; plní ho metoda nodeGo() a je primárně použito v metodě go() k prevenci zacyklení.
static Prompt	prompt	vstupní příkazová řádka - dávkovač slov (uzlů cesty), ze kterého čerpají instance kmenu Branch a instance Test, která čerpá vlastní "nestromový" parametr - název souboru
java.lang.String	recurse	nahrazovač rekurzívní smyčky; pokud má hierarchie smyčku, nevstupuje se do kontejneru nodes, ale vypíše se náhrada, aby to bylo zřejmé

Fields inherited from class shell.Command

comment, done, error, levelActive

Fields inherited from class shell.Node

comparable, level, name, noActive

Constructor Summary

Constructors

Constructor	Description
Branch(java.lang.String name, java.lang.String comment)
Branch(java.lang.String name, java.lang.String comment, int levelActive, java.lang.String done, boolean extName, boolean dNode, java.lang.String error, boolean eNode, Nodes nodes, int levelNodePath)
Branch(java.lang.String name, java.lang.String comment, int levelActive, java.lang.String done, java.lang.String error)
Branch(java.lang.String name, java.lang.String comment, java.lang.String done, boolean extName, boolean dNode, java.lang.String error, boolean eNode, Nodes nodes)
Branch(java.lang.String name, java.lang.String comment, java.lang.String done, java.lang.String error)
Branch(java.lang.String name, java.lang.String comment, Nodes nodes)
Branch(java.lang.String name, java.lang.String comment, Nodes nodes, boolean noPrint)
Branch(java.lang.String name, java.lang.String comment, Nodes nodes, boolean noPrint, int levelNodePath)
Branch(java.lang.String name, java.lang.String comment, Nodes nodes, java.lang.String nodesBegin, java.lang.String nodesDelimiter)

Method Summary

Modifier and Type	Method	Description
void	defPrompt()	Standardní nastavení poskytovatele cest z příkazových řádkek z klávesnice
boolean	findFirst(java.lang.String s)	Hledá node v nodes podle "s".
void	go()	Rozšiřuje metodu Command.go() předka o práci s kontejnerem uzlů nodes.
void	nodeAction()	Je určená ke zpracování node v Command.active() módu.
boolean	nodeCondition()	Je určená k otestování podmínek, zda se může vykonat nodeAction.
void	nodeCover()	Ovladač zpracování jednoho vnořeného uzlu.
void	nodeGo()	Vrstvička zanoření při průchodu do nižší úrovně.
boolean	nodePath()	Povinnost volby uzlu node z nodes je standardně řízena urovní zanoření Node.level.
void	nodesCover()	Zpracování všech vnořených nodes.
void	outDone()	Tiskne potvrzující odpověď.
void	outError()	Tiskne chybovou odpověď.
void	outErrorPath()	Vytiskne text, když ve vstupu chybí povinná slovní identifikace.
void	outErrorWord()	Vytiskne text při špatně zadané slovní identifikaci.
static java.lang.String	plural(int i)
void	setNodes(Nodes nodes)	Změní/nastaví odkaz nodes na jiný/nový kontejner.
void	setNoPrint(boolean noPrint)	Změní příznak výpisu noPrint.

Methods inherited from class shell.Command

action, active, condition, cover, print

Methods inherited from class shell.Node

getComparable, getExtName, getName, mes, met, out, outExtName, outName, setName, toComparable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

passed

public static final java.util.ArrayList<Node> passed

pole aktuální cesty uzlů při stromovém zpracování; plní ho metoda nodeGo() a je primárně použito v metodě go() k prevenci zacyklení.

prompt

public static Prompt prompt

vstupní příkazová řádka - dávkovač slov (uzlů cesty), ze kterého čerpají instance kmenu Branch a instance Test, která čerpá vlastní "nestromový" parametr - název souboru

nodes

public Nodes nodes

kontejner vnořených uzlů třídy Nodes; hodnota null přepíná chování objektu na chování předka; je to výchozí stav

noGoEmpty

public boolean noGoEmpty

do rozvětvení (s tiskem uzlu) se v případě prázdného kontejneru nemá vůbec vstupovat; standardně se vstoupí do rozvětvení i v případě prázdného kontejneru a namísto kontejneru se tiskne nodesEmpty

noPrint

public boolean noPrint

před rozvětvením uzlu se uzel nemá tisknout

masterDelimiter

public java.lang.String masterDelimiter

oddělovač uzlu od svého kontejneru, není-li noPrint

errorPathDelimiter

public java.lang.String errorPathDelimiter

oddělovač zprávy od uzlu

nodesBegin

public java.lang.String nodesBegin

uvaděč kontejneru vnořených uzlů

nodesEmpty

public java.lang.String nodesEmpty

nahrazovač výpisu kontejneru vnořených uzlů, je-li kontejner prázdný

nodesDelimiter

public java.lang.String nodesDelimiter

oddělovač uzlů v kontejneru, je-li jich zpracováváno více než jeden

nodesEnd

public java.lang.String nodesEnd

ukončovač kontejneru vnořených uzlů

recurse

public java.lang.String recurse

nahrazovač rekurzívní smyčky; pokud má hierarchie smyčku, nevstupuje se do kontejneru nodes, ale vypíše se náhrada, aby to bylo zřejmé

levelNodePath

public int levelNodePath

úroveň zanoření, na které platí povinnost uvést slovo/cestu; pokud není tímto parametrem zapnuta a uživatel slovo neuvede, zpracují se všechny nodes v kontejneru

errorPath

public java.lang.String errorPath

odpověď v případě chyby při nesplnění povinnosti identifikovat jeden konkrétní uzel z nodes podle levelNodePath

errorWord

public java.lang.String errorWord

odpověď v případě chyby nenalezeného identifikátoru ze vstupu načerpaného metodou Prompt.next(); hledá se v nodes metodou findFirst(java.lang.String)

noPathNoAll

public boolean noPathNoAll

pokud není uvedena cesta, která je povinná a není tímto příznakem zakázano, přepne se procházení na výpisy všech uzlů - jen se mód aktivity zablokuje, aby se namísto provedení vypsal seznam všech možností

node

public Node node

pracovní ukazatel na uzel, který se má zpracovat

dNode

public boolean dNode

vypisovat za hláškou úspěchu název uzlu a tečku

eNode

public boolean eNode

vypisovat za chybovou hláškou název uzlu a tečku

extName

public boolean extName

vypisovat za hláškou úspěchu rozšířený název uzlu (Node.outExtName() namísto Node.outName())

Constructor Detail

Branch

public Branch(java.lang.String name,
              java.lang.String comment)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              Nodes nodes)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              Nodes nodes,
              boolean noPrint)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              Nodes nodes,
              boolean noPrint,
              int levelNodePath)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              Nodes nodes,
              java.lang.String nodesBegin,
              java.lang.String nodesDelimiter)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              int levelActive,
              java.lang.String done,
              java.lang.String error)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              java.lang.String done,
              java.lang.String error)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              int levelActive,
              java.lang.String done,
              boolean extName,
              boolean dNode,
              java.lang.String error,
              boolean eNode,
              Nodes nodes,
              int levelNodePath)

Branch

public Branch(java.lang.String name,
              java.lang.String comment,
              java.lang.String done,
              boolean extName,
              boolean dNode,
              java.lang.String error,
              boolean eNode,
              Nodes nodes)

Method Detail

plural

public static java.lang.String plural(int i)

defPrompt

public void defPrompt()

Standardní nastavení poskytovatele cest z příkazových řádkek z klávesnice

setNodes

public void setNodes(Nodes nodes)

Změní/nastaví odkaz nodes na jiný/nový kontejner.

setNoPrint

public void setNoPrint(boolean noPrint)

Změní příznak výpisu noPrint.

outErrorPath

public void outErrorPath()

Vytiskne text, když ve vstupu chybí povinná slovní identifikace.

outErrorWord

public void outErrorWord()

Vytiskne text při špatně zadané slovní identifikaci.

findFirst

public boolean findFirst(java.lang.String s)

Hledá node v nodes podle "s". Pokud najde první vyhovující, nastaví jej do node a vrátí true, jinak false.

Parameters:

s - slovo ze vstupu

Returns:

příznak nalezení

See Also:

nodes, node, Node.toComparable(java.lang.String), Node.getComparable()

nodeCondition

public boolean nodeCondition()

Je určená k otestování podmínek, zda se může vykonat nodeAction. Výchozí výsledek testu je true, ale v případě, že objekt potřebuje nějak podmínit vykonání nodeAction(), je potřeba implementovat potomka s vlastní metodou nodeCondition. Například při umisťování míčků do batohu se kontroluje, zda je ještě místo, nebo jde-li míček sebrat apod.

nodeGo

public void nodeGo()

Vrstvička zanoření při průchodu do nižší úrovně. Stará se o nastavení aktuální úrovně, podle které metoda out odsadí výstup.

See Also:

Node.level, node, Node.go()

nodeAction

public void nodeAction()

Je určená ke zpracování node v Command.active() módu. Provede se jen pokud je tato Branch aktivní a nodeCondition vrátí true. Výchozí chování je vstup do uzlu (procházení stromem uzlů), ale například potomek této třídy Mover, namísto vstupu do uzlu, uzel přesouvá z nodes do Mover.targetNodes. Tato i rozšířené metody potomků mají tvořit veškerou funkci ovladačů vnořených uzlů. Metodu volá metoda nodeCover(). Tato výchozí nodeAction() volá metodu nodeGo()

outError

public void outError()

Tiskne chybovou odpověď. Pokud eNode, přidává uzel Node.outName(), kterého se chyba týká a tečku.

Overrides:

outError in class Command

See Also:

eNode, Node.outName()

outDone

public void outDone()

Tiskne potvrzující odpověď. Pokud dNode, přidává uzel, kterého se odpověď týká a tečku. extName příznak rozhoduje, zda se pro tisk node použije Node.outExtName() nebo jen Node.outName().

Overrides:

outDone in class Command

See Also:

dNode, Node.outExtName(), Node.outName()

nodePath

public boolean nodePath()

Povinnost volby uzlu node z nodes je standardně řízena urovní zanoření Node.level. Ve výchozím stavu levelNodePath==-1 nebude platit povinnost zvolit uzel na žádné urovni.

Returns:

příznak, zda je volba uzlu na aktuální úrovni zanoření povinná.

nodeCover

public void nodeCover()

Ovladač zpracování jednoho vnořeného uzlu. Pokud je ovladač uzlů aktivní (Command.active()), metoda s uzlem node provede akci nodeAction(). Pokud aktivní není, do uzlu jen vstoupí nodeGo(). Balí volání nodeCondition() a nodeAction() do jednotné metodiky zpracování nastaveného node. Standardizuje tisk odpovědí. K tomu používá metodu outDone() (po úspěšném testu nodeCondition()) nebo outError() (po testu neúspěšném).

See Also:

Command.active(), nodeCondition(), nodeAction(), outDone(), outError(), nodeGo()

nodesCover

public void nodesCover()

Zpracování všech vnořených nodes. Mezi jednotlivými uzly tiskne oddělovač nodesDelimiter. Pro zpracování každého uzlu pak volá nodeCover().

See Also:

nodes, nodesDelimiter, nodeCover()

go

public void go()

Rozšiřuje metodu Command.go() předka o práci s kontejnerem uzlů nodes. Testuje, zda je povolena rozšiřující metodika oproti předkovi (Command, který ještě nezná nodes). Zde je to právě test, je-li atribut nodes nastavený. Rozšiřující metodiku je možné operativně zapínat/vypínat a třída se pak bude/nebude chovat jako předek. Tento jediný test umožní objektům oboje chování. Pokud je zadán slovní identifikátor vnořeného uzlu z příkazové řádky (Prompt.hasNext(),Prompt.next()), objekt Branch se pokusí podle něj uzel identifikovat (findFirst(java.lang.String)). Potvrzení o úspěšné identifikaci uzlu se netiskne. Tiskne jen chybu při neúspěšné identifikaci outErrorWord(), pokud je identifikátor zadán chybně. Pokud slovní identifikace není zadána vůbec (Prompt.hasNext() == false), objekt Branch provede akci se všemi nodes. Vyjímkou je povinnost slovní identifikátor zadat (např. při levelNodePath==1 pro první úroveň). Pak se při chybějící identifikaci tiskne chyba. Při úspěšné identifikaci podřízeného uzlu node je volána metoda nodeCover(),která se zabývá již podřízeným uzlem, přičemž tento nadřízený se netiskne (zadanou cestu není nutné opakovat). Tento nadřízený Branch uzel se tiskne jen v případě následného zpracování všech nodes metodou nodesCover(), ovšem pokud není jeho tisk před kontejnerem podřízených nodes parametrem noPrint vypnut. K tisku oddělení nadřízeného s podřízenými je použit řetězec masterDelimiter. Pokud je kontejner nodes v tomto objektu již zpracováván průchodem z vyšší úrovně (poznámka v passed), není přistoupeno k jeho opětovnému zpracování jako prevence zacyklení. Namísto vstupu do kontejneru metodou nodesCover() se tiskne řetězec recurse.

Overrides:

go in class Command

See Also:

nodes, Command.go(), prompt, Prompt.hasNext(), Prompt.next(), findFirst(java.lang.String), nodeCover(), outErrorWord(), levelNodePath, nodePath(), errorPathDelimiter, outErrorPath(), noPathNoAll, Node.noActive, noPrint, Command.print(), Node.out(java.lang.String), masterDelimiter, nodesBegin, nodesEmpty, passed, recurse, nodesCover(), nodesEnd