StimuliSelector

java.lang.Object
- org.vishia.stimuliSelector.StimuliSelector

public class StimuliSelector
extends java.lang.Object

A Gui Application which reads a JZtxtcmd script containing data, it shows 6 tables for selection. On selection a subroutine from thiz JZtxtcmd script "execSelection(Map line1, ... Map line6)" will be executed.
The script needs

 ==JZtxtcmd==
 List tab1 = ##content of tab1
 [ { name="ident",   descr="...",     var="anyString", anyOtherVar="anyInfo" }
 , { name="ident2",  descr="...",     var="xyz", anyOtherVar="anyInfo" }
 ];
 
 List tab2AnyIdent = ##content of tab2
 [ { name="ident",   descr="...",     var="anyString", anyOtherVar="anyInfo" }
 , { name="ident2",  descr="...",     var="xyz", anyOtherVar="anyInfo" }
 ];
 
 
 class ToGui  ##determines how the tabs named. 
 {
  List tdata1 = tab1;
  List tdata2 = tab2AnyIdent;
 }
 
 ##execute the following routine on selection button:
 sub btnGenSelection ( Map line1, Map line2, Map line3, Map line4, Map line5, Map line6){
   <+out><&scriptdir>/<&scriptfile>: btnGenSelection (<: > <&line1.name>, <&line2.name>) ..... <.+n>;  
     ... here some statements to create any output to use anywhere other from the selection.
   <.+>
 }
 
 sub btnGenTestcases ( String select) {
   if(jztc.envar.soRx) {    ##hint: use definitely the script variable, not the local copy.
   ....
 }

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`StimuliSelector.GralUserActionButton` An user action which calls `execBtnAction(String)`, assigned to some Buttons.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) GralUserAction`	`actionAddTestcases` Action for the button [add sel] invokes `addTestcases()`
`(package private) GralUserAction`	`actionCleanOut` Action for the button [clean] removes the text in the `output` text box.
`(package private) GralUserAction`	`actionDeselectLines` Action for the button [desel] invokes `deselectLines()()`
`(package private) GralUserAction`	`actionGenTestcases` Action for the button [gen test cases] invokes `genTestcases()`
`(package private) GralUserAction`	`actionHelp` Action for the button [help] yet improveable.
`(package private) GralUserAction`	`actionReadConfig` Action for the button [read config] calls `readConfig()`
`(package private) GralUserAction`	`actionSelectInTable` This action is only to remark which tables is last touched (line is selected).
`(package private) GralUserAction`	`actionShowSel` Action for the button [Show] calls `showSelectExpressionPart()`
`(package private) GralUserAction`	`actionTouchLine` Action for a double click on a line invokes `addTestCaseFromTable(org.vishia.gral.base.GralTable.TableLineData)`
`(package private) GralUserAction`	`actionTouchTestcaseString` Action is invoked if the text box was touched or changed, yet not used.
`GralButton`	`btnAddTestcase`
`GralButton`	`btnCleanOut`
`GralButton`	`btnDeselectLines`
`GralButton`	`btnExampleSel`
`GralButton[]`	`btnExecSelection`
`GralButton`	`btnGenSelection`
`GralButton`	`btnGenTestcases`
`GralButton`	`btnHelp`
`GralButton`	`btnReadConfig`
`(package private) java.io.PrintStream`	`errNew`
`(package private) java.io.PrintStream`	`errOld`
`private JZtxtcmdExecuter`	`executer`
`java.io.File`	`fileConfig`
`(package private) GralMng`	`gralMng`
`(package private) boolean`	`isTableInitialized`
`private JZtxtcmd`	`jzcmd`
`(package private) LogMessage`	`log`
`(package private) java.io.PrintStream`	`outNew`
`(package private) java.io.PrintStream`	`outOld`
`GralTextBox`	`output`
`private JZtxtcmdScript`	`script`
`private java.util.Map<java.lang.String,<any>>`	`selectorVariables` container to offer to the JZtxtcmd script.
`private <any>`	`soRxVar` This variable is accessible from JZtxtcmd execution.
`private <any>`	`thisVar` This variable is accessible from JZtxtcmd execution to access all elements in the graphic.
`(package private) java.lang.String`	`version` Version, history and license.
`(package private) GralTable<java.util.Map<java.lang.String,<any>>>`	`wdgLastSelectedTable` Set on selection of a line in a table, the last touched one.
`GralTextBox`	`wdgSelects`
`(package private) GralTable<java.util.Map<java.lang.String,<any>>>[]`	`wdgTables`
`(package private) GralWindow`	`window` The main window

Constructor Summary

Constructors
Constructor and Description

StimuliSelector(java.lang.String fileConfig)
local ctor only from main

Constructors
Constructor and Description
`StimuliSelector(java.lang.String fileConfig)` local ctor only from main

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) int`	`addLineToSegm(java.lang.StringBuilder sbselect, int nCursor, GralTable.TableLineData line, java.util.Map<java.lang.String,java.lang.String> alreadyContained)` Adds the key of the given line in this part of selection string but only if it is not contained.
`(package private) int`	`addTestCaseAllTables(java.lang.StringBuilder sbselect, int nCursor)` Adds the selection from all tables as initial string, called if the selection (part) is empty.
`(package private) void`	`addTestCaseFromTable(GralTable.TableLineData line)` Double click on one line
`(package private) void`	`addTestcases()` routine for Button [add sel] It analyzes the given content in the `wdgSelects` text box and marked lines in the tables and produces the proper part of the selection expression.
`(package private) void`	`deselectLines()` Routine for the button [desel] remove the mark in all table lines.
`(package private) void`	`execBtnAction(java.lang.String subroutine)` This is the common routine for all buttons which should call a sub routine from the JZtxtcmd control script.
`(package private) void`	`genTestcases()` Routine called from the button [gen test cases].
`private java.lang.String`	`getKeyfromLine(GralTable.TableLineData line)` Reads the key from the line of the table, internal.
`(package private) int`	`insertTestCase(java.lang.StringBuilder sbselect, int nCursor, boolean bNewTableEntry, int nTable, GralTable.TableLineData line)` Add the entry for one line of a table exactly on the cursor position.
`static void`	`main(java.lang.String[] args)` Start
`static void`	`openWindow()`
`private void`	`openWindow1(char size)` Initializes/creates the main window
`(package private) int`	`prcTablesInSelectionPart(java.lang.StringBuilder sbselect, int nCursor, int nTable, GralTable.TableLineData lineSel, boolean bMarkLinesInTable)` Processes the selected lines of all tables but only in the found part of the selection expression.
`(package private) void`	`readConfig()` Read and translate the JZtxtcmd to config the GUI It is also invoked from the button [read config] on the opened GUI.
`(package private) void`	`showSelectExpressionPart()` Routine for button [show] shows the lines which are contained in the current part (cursor) of the selection expression.
`void`	`waitForClosePrimaryWindow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
java.lang.String version
```
    Version, history and license.
    - 2021-06-17 renew possibilities to assemble the selection expression
    - 2021-06-12 offer soRxVar and selectorVariables accessible from the jzTc script via envar.
    - 2021-06-09 Hartmut better support for building test cases
    - 2020-07-20 hartmut new If the script contains subroutines "exec1" ... "exec4" Buttons for that will be created, for special functions.
    - 2020-07-20 hartmut new now invokes
      sub execSelection(Map line1, Map line2, Map line3, Map line4, Map line5, Map line6){...\
      it is more simple to build the output.
    - 2016-11-72 Hartmut adaption, System.out redirection to out textarea
    - 2016-01-10 Hartmut Created to create test scripts
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
  - log
```
final LogMessage log
```
  - gralMng
```
GralMng gralMng
```
  - window
```
GralWindow window
```
    The main window
  - wdgTables
```
GralTable<java.util.Map<java.lang.String,<any>>>[] wdgTables
```
  - wdgLastSelectedTable
```
volatile GralTable<java.util.Map<java.lang.String,<any>>> wdgLastSelectedTable
```
    Set on selection of a line in a table, the last touched one.
  - btnReadConfig
```
public GralButton btnReadConfig
```
  - btnGenSelection
```
public GralButton btnGenSelection
```
  - btnCleanOut
```
public GralButton btnCleanOut
```
  - btnGenTestcases
```
public GralButton btnGenTestcases
```
  - btnAddTestcase
```
public GralButton btnAddTestcase
```
  - btnDeselectLines
```
public GralButton btnDeselectLines
```
  - btnExampleSel
```
public GralButton btnExampleSel
```
  - btnHelp
```
public GralButton btnHelp
```
  - btnExecSelection
```
public GralButton[] btnExecSelection
```
  - wdgSelects
```
public GralTextBox wdgSelects
```
  - output
```
public GralTextBox output
```
  - jzcmd
```
private final JZtxtcmd jzcmd
```
  - executer
```
private JZtxtcmdExecuter executer
```
  - script
```
private JZtxtcmdScript script
```
  - isTableInitialized
```
boolean isTableInitialized
```
  - fileConfig
```
public final java.io.File fileConfig
```
  - soRxVar
```
private <any> soRxVar
```
    This variable is accessible from JZtxtcmd execution. It can be uses as an instance to communicate with the test system, especially via org.vishia.communication.SocketCmd_InterProcessComm using emC/soCmd/SocketCmd.exe on the other side as command line program.
    It is from the common type Object to use in JZtxtcmd container. Reason for this variable: Should preserve on re read the JZtxtcmd script. If a simple script variable would be used, it will be destroyed while re-compilation.
  - thisVar
```
private <any> thisVar
```
    This variable is accessible from JZtxtcmd execution to access all elements in the graphic.
  - selectorVariables
```
private final java.util.Map<java.lang.String,<any>> selectorVariables
```
    container to offer to the JZtxtcmd script.
  - outOld
```
java.io.PrintStream outOld
```
  - errOld
```
java.io.PrintStream errOld
```
  - outNew
```
java.io.PrintStream outNew
```
  - errNew
```
java.io.PrintStream errNew
```
  - actionReadConfig
```
GralUserAction actionReadConfig
```
    Action for the button [read config] calls readConfig()
  - actionGenTestcases
```
GralUserAction actionGenTestcases
```
    Action for the button [gen test cases] invokes genTestcases()
  - actionAddTestcases
```
GralUserAction actionAddTestcases
```
    Action for the button [add sel] invokes addTestcases()
  - actionDeselectLines
```
GralUserAction actionDeselectLines
```
    Action for the button [desel] invokes deselectLines()()
  - actionCleanOut
```
GralUserAction actionCleanOut
```
    Action for the button [clean] removes the text in the output text box.
  - actionTouchLine
```
GralUserAction actionTouchLine
```
    Action for a double click on a line invokes addTestCaseFromTable(org.vishia.gral.base.GralTable.TableLineData)
  - actionSelectInTable
```
GralUserAction actionSelectInTable
```
    This action is only to remark which tables is last touched (line is selected).
  - actionTouchTestcaseString
```
GralUserAction actionTouchTestcaseString
```
    Action is invoked if the text box was touched or changed, yet not used.
  - actionShowSel
```
GralUserAction actionShowSel
```
    Action for the button [Show] calls showSelectExpressionPart()
  - actionHelp
```
GralUserAction actionHelp
```
    Action for the button [help] yet improveable.
- Constructor Detail
  - StimuliSelector
```
StimuliSelector(java.lang.String fileConfig)
```
    local ctor only from main
    
    Parameters:
    
    fileConfig - immediately the command line argument
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Start
    
    Parameters:
    
    args - only the JZtxcmd script path/to/config.jzt.cmd
  - openWindow
```
public static void openWindow()
```
  - openWindow1
```
private void openWindow1(char size)
```
    Initializes/creates the main window
    
    Parameters:
    
    size -
  - waitForClosePrimaryWindow
```
public void waitForClosePrimaryWindow()
```
  - readConfig
```
void readConfig()
```
    Read and translate the JZtxtcmd to config the GUI It is also invoked from the button [read config] on the opened GUI.
  - execBtnAction
```
void execBtnAction(java.lang.String subroutine)
```
    This is the common routine for all buttons which should call a sub routine from the JZtxtcmd control script. It is used also for gen Stimuli and the exec buttons.
    
    Parameters:
    
    subroutine - name of the sub routine in the JZtxtcmd script for this button.
  - genTestcases
```
void genTestcases()
```
    Routine called from the button [gen test cases]. It searches and calls the JZtxtcmd sub btnGenTestCases(select) with a JZtxtcmd variable as argument with the select string.
  - addTestcases
```
void addTestcases()
```
    routine for Button [add sel] It analyzes the given content in the wdgSelects text box and marked lines in the tables and produces the proper part of the selection expression. Calls addTestCaseAllTables(StringBuilder, int) for an empty part in the expression or calls prcTablesInSelectionPart(StringBuilder, int, int, org.vishia.gral.base.GralTable.TableLineData, boolean) if some info are contained already.
    A part in the select string is the text area from start or from : + & to end or to one of this operators.
  - prcTablesInSelectionPart
```
int prcTablesInSelectionPart(java.lang.StringBuilder sbselect,
                             int nCursor,
                             int nTable,
                             GralTable.TableLineData lineSel,
                             boolean bMarkLinesInTable)
```
    Processes the selected lines of all tables but only in the found part of the selection expression. It searches which tables are contained in that part and processes only content from this tables. But for bMarkLinesInTable = false: If the table is given (nTable >0), this table content is added in this part as a new table too.
    This routine has 2 different functions:
    - use marked lines or the current line for selection: bMarkLinesInTable==false.
    - Mark the lines which are contained in the part of selection expression: bMarkLinesInTable==true.
      Both algorithm are widely similar, hence done in this routine and distinct by bMarkLinesInTable.
    Parameters:
    
    sbselect - contains the content of the select textbox
    
    nCursor - position of the cursor there
    
    nTable - if given (>=0) then only this table is handled (because of double clicked of its line). if -1, then check any table of selection
    
    lineSel - only used if nTable >=0, then this line.
    
    bMarkLinesInTable - true then the found keys marks the lines in the table (other direction).
    
    Returns:
    
    new cursor position
  - getKeyfromLine
```
private java.lang.String getKeyfromLine(GralTable.TableLineData line)
```
    Reads the key from the line of the table, internal.
    
    Parameters:
    
    line -
    
    Returns:
    
    The key in the line, often field "name"
  - addLineToSegm
```
int addLineToSegm(java.lang.StringBuilder sbselect,
                  int nCursor,
                  GralTable.TableLineData line,
                  java.util.Map<java.lang.String,java.lang.String> alreadyContained)
```
    Adds the key of the given line in this part of selection string but only if it is not contained.
    
    Parameters:
    
    sbselect - contains the select expression, will be changed
    
    nCursor - cursor position where exactly should be inserted.
    
    line -
    
    alreadyContained - Map of all found keys (contained in the part of the select expression)
    
    Returns:
    
    The new cursor position proper for a next entry.
  - addTestCaseAllTables
```
int addTestCaseAllTables(java.lang.StringBuilder sbselect,
                         int nCursor)
```
    Adds the selection from all tables as initial string, called if the selection (part) is empty. This routine is called from addTestcases() if there is detected that the part is empty. If some lines are marked, only this lines are used. If no mark is given, the current lines of all tables are added.
    
    Parameters:
    
    sbselect - contains the select expression, will be changed
    
    nCursor - cursor position where exactly should be inserted. It is 0 if the field is empty, or it can be after a ':' character.
  - insertTestCase
```
int insertTestCase(java.lang.StringBuilder sbselect,
                   int nCursor,
                   boolean bNewTableEntry,
                   int nTable,
                   GralTable.TableLineData line)
```
    Add the entry for one line of a table exactly on the cursor position.
    
    Parameters:
    
    sbselect - The StringBuffer contains the current content, will be changed
    
    nCursor - position where to insert
    
    bNewTableEntry - true then write "<&nTable>=" for a new table, false then write ", "
    
    nTable - The table number counted from 1 for the first.
    
    line - The line of table, get key from there
  - addTestCaseFromTable
```
void addTestCaseFromTable(GralTable.TableLineData line)
```
    Double click on one line
    
    Parameters:
    
    line -
  - deselectLines
```
void deselectLines()
```
    Routine for the button [desel] remove the mark in all table lines.
  - showSelectExpressionPart
```
void showSelectExpressionPart()
```
    Routine for button [show] shows the lines which are contained in the current part (cursor) of the selection expression.

Class StimuliSelector

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

log

gralMng

window

wdgTables

wdgLastSelectedTable

btnReadConfig

btnGenSelection

btnCleanOut

btnGenTestcases

btnAddTestcase

btnDeselectLines

btnExampleSel

btnHelp

btnExecSelection

wdgSelects

output

jzcmd

executer

script

isTableInitialized

fileConfig

soRxVar

thisVar

selectorVariables

outOld

errOld

outNew

errNew

actionReadConfig

actionGenTestcases

actionAddTestcases

actionDeselectLines

actionCleanOut

actionTouchLine

actionSelectInTable

actionTouchTestcaseString

actionShowSel

actionHelp

Constructor Detail

StimuliSelector

Method Detail

main

openWindow

openWindow1

waitForClosePrimaryWindow

readConfig

execBtnAction

genTestcases

addTestcases

prcTablesInSelectionPart

getKeyfromLine

addLineToSegm

addTestCaseAllTables

insertTestCase

addTestCaseFromTable

deselectLines

showSelectExpressionPart