| <?xml version="1.0" encoding="UTF-8"?> |
| <ecore:EPackage xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" name="commands" nsURI="http://www.eclipse.org/ecl/data/commands.ecore" |
| nsPrefix="dataCommands"> |
| <eClassifiers xsi:type="ecore:EClass" name="ReadCsvFile" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Parses given csv file. Fails if file is not found or format is invalid.
Learn more about <a href = "http://xored.freshdesk.com/solution/articles/78219-assert-the-whole-table">Asserting the whole table contents.</a>"/> |
| <details key="returns" value="<code>Table</code> EMF Object. "/> |
| <details key="example" value="with [get-window Preferences] {
	get-tree | select "Java/Installed JREs"
	get-table | get-table-data | eq [read-csv-file "workspace:/assertData/table.csv"] | 
		assert-true "Data in table does not match input file" 
	get-button OK | click
}

//Let's say we need to write ErrorLog info to csv file 'table.csv'.
//ECL script should look like this:
 
get-view "Error Log" | get-tree | expand-all
get-view "Error Log" | get-tree | get-table-data | write-csv-file "workspace:/MyProject/AssertData/table.csv
 
//Note: 
//<a href="#expand-all">Expand-all</a>command may be useful in case of hierarchical tree - otherwise non-expanded levels won't be written. 
//You should have MyProject/AssertData on your workspace (you may do it easily with a workspace context) to let you csv file to be created there. 
 
//In case you want to specify which columns/rows should be written you may use 
//<a href="#select-columns">select-columns</a>/<a href="#exclude-columns">exclude-columns</a> and <a href="#select-rows">select-rows</a>/<a href="#exclude-rows">exclude-rows</a> commands:
 
get-view "Error Log" | get-tree | get-table-data | select-columns "Message" | write-csv-file "workspace:/MyProject/AssertData/table.csv" 
get-view "Error Log" | get-tree | get-table-data | exclude-columns "Message" "Plug-in" | write-csv-file "workspace:/MyProject/AssertData/table.csv"
get-view "Error Log" | get-tree | get-table-data | select-rows -column "Message" -value "Execution of early startup handlers completed." | write-csv-file "workspace:/MyProject/AssertData/table.csv"
 
//To compare table data to already written csv file you may use <a href="#read-csv-file">read-csv-file</a> command:
 
get-view "Error Log" | get-tree | get-table-data | select-columns "Plug-in" | eq [read-csv-file "workspace:/MyProject/AssertData/table.csv"] | assert-true "Data in table does not match input file" "/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="URI to a file to read. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="Print" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Takes a list of objects from input pipe and prints them as a plain-text table into output pipe."/> |
| <details key="returns" value="Series of string objects"/> |
| </eAnnotations> |
| <eAnnotations source="http://www.eclipse.org/ecl/internal"/> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="input" unique="false" upperBound="-1" |
| eType="ecore:EClass platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EObject"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="WriteCsvFile" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Writes given table into csv file. Fails if file is not accessible.
Learn more about <a href = "http://xored.freshdesk.com/solution/articles/78219-assert-the-whole-table">Asserting the whole table contents.</a>"/> |
| <details key="returns" value="The value of <code>table</code> argument."/> |
| <details key="example" value="with [get-window Preferences] {
	get-tree | select "Java/Installed JREs"
	get-table | get-table-data | write-csv-file "workspace:/assertData/table.csv"
	get-button OK | click
}

//Let's say we need to write ErrorLog info to csv file 'table.csv'.
//ECL script should look like this:
 
get-view "Error Log" | get-tree | expand-all
get-view "Error Log" | get-tree | get-table-data | write-csv-file "workspace:/MyProject/AssertData/table.csv
 
//Note: 
//<a href="#expand-all">Expand-all</a>command may be useful in case of hierarchical tree - otherwise non-expanded levels won't be written. 
//You should have MyProject/AssertData on your workspace (you may do it easily with a workspace context) to let you csv file to be created there. 
 
//In case you want to specify which columns/rows should be written you may use 
//<a href="#select-columns">select-columns</a>/<a href="#exclude-columns">exclude-columns</a> and <a href="#select-rows">select-rows</a>/<a href="#exclude-rows">exclude-rows</a> commands:
 
get-view "Error Log" | get-tree | get-table-data | select-columns "Message" | write-csv-file "workspace:/MyProject/AssertData/table.csv" 
get-view "Error Log" | get-tree | get-table-data | exclude-columns "Message" "Plug-in" | write-csv-file "workspace:/MyProject/AssertData/table.csv"
get-view "Error Log" | get-tree | get-table-data | select-rows -column "Message" -value "Execution of early startup handlers completed." | write-csv-file "workspace:/MyProject/AssertData/table.csv"
 
//To compare table data to already written csv file you may use <a href="#read-csv-file">read-csv-file</a> command:
 
get-view "Error Log" | get-tree | get-table-data | select-columns "Plug-in" | eq [read-csv-file "workspace:/MyProject/AssertData/table.csv"] | assert-true "Data in table does not match input file" "/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="table" eType="ecore:EClass objects.ecore#//Table"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Table to write"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="URI to write CSV data to. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="ExcludeColumns" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Takes a table from input and returns the same table which has some columns excluded. "/> |
| <details key="returns" value="Copy of input table object without columns with names listed in <code>columns</code>"/> |
| <details key="example" value="get-view "Error Log" | get-tree | get-table-data | exclude-columns "Message" "Plug-in" | write-csv-file "workspace:/MyProject/AssertData/table.csv""/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="table" eType="ecore:EClass objects.ecore#//Table"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Table to exclude columns from"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="columns" upperBound="-1" |
| eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Column names to exclude from table. It is OK to pass column names which are not present in table"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="SelectColumns" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Takes a table from input and returns the table containing only columns passed into <code>columns</code> argument."/> |
| <details key="returns" value="Copy of input table object with only columns with names listed in <code>columns</code>"/> |
| <details key="example" value="get-view "Error Log" | get-tree | get-table-data | select-columns "Message" | write-csv-file "workspace:/MyProject/AssertData/table.csv" "/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="table" eType="ecore:EClass objects.ecore#//Table"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Table to take columns from"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="columns" upperBound="-1" |
| eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Column names to take from table. If given column name is not present in input table, command fails"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="AssertTablesMatch" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Compares contents of two tables. If contents are not the same, fails with a descriptive message"/> |
| <details key="example" value="assert-tables-match [get-editor "context" | get-section Parameters | get-table | get-table-data ]
 [get-editor "context2" | get-section Parameters | get-table | get-table-data]"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="left" eType="ecore:EClass objects.ecore#//Table"/> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="right" eType="ecore:EClass objects.ecore#//Table"/> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="ignoreColumnOrder" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EBoolean" |
| defaultValueLiteral="false"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="When true, column order is not taken into account"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="ignoreMissingColumns" eType="#//IgnoreColumnsMode" |
| defaultValueLiteral="NONE"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Describes the comparison behaviour in case when one of tables contains a column which is not present in other table:
<ul>
<li><b>NONE</b> &ndash; all columns must be present in both tables</li>
<li><b>LEFT</b> &ndash; columns from right table which are not present in left, are ignored</li>
<li><b>RIGHT</b> &ndash; columns from left table which are not present in right, are ignored</li>
<li><b>BOTH</b> &ndash; comparison performed only on columns present in both tables</li>
<p>Another way to interpret this argument is that it is an answer on question &quot;Which column can have less columns?&quot;</p>
<p>The primary reasoning for this argument is to provide smooth migration when presentation is changed – consider this scenario: we have a CSV file with table data, and we have UI table. If we add or remove extra columns in the UI, we can keep existing sample data file and just correct the <code>ignoreMissingColumns</code> argument</p>
"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EEnum" name="IgnoreColumnsMode"> |
| <eLiterals name="NONE"/> |
| <eLiterals name="LEFT" value="1"/> |
| <eLiterals name="RIGHT" value="2"/> |
| <eLiterals name="BOTH" value="3"/> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="WriteLines" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Reads objects from input pipe and writes them into file line-by-line as strings"/> |
| <details key="example" value="//writes a list of launch configuration into a file line-by-line
list-launch-configurations | write-lines -uri "workspace:/Project/Folder/file.txt"
// appends "New line" into a file. 
str "New line" | write-lines -uri "workspace:/Project/Folder/file.txt" -append
"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="URI to write lines to. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="append" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EBoolean" |
| defaultValueLiteral="false"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Whether to append given lines into file. Default value is false"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="ReadLines" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Reads lines from file identified by uri and writes them one-by-one into output pipe"/> |
| <details key="example" value="//Displays alert with lines count
show-alert [concat "The number of lines is "[read-lines -uri "workspace:/Project/Folder/file.txt" | length | str]]

"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" lowerBound="1" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="URI to read lines from. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system"/> |
| </eAnnotations> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="SelectRows" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Takes a table from input and returns the table with rows filtered by column and criteria."/> |
| <details key="returns" value="Copy of input table object with filtered rows."/> |
| <details key="example" value="select-rows -column "columnName" -value "value" -match exact|glob|regex"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="table" eType="ecore:EClass objects.ecore#//Table"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Table to take columns from"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="column" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Column named to filter rows by."/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="value" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Pattern to match rows to."/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="match" eType="#//RowMatchMode"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Describes the matching behaviour for rows.
<ul>
<li><b>glob</b> &ndash; wildcard matching</li>
<li><b>exact</b> &ndash; value should be equals to pattern</li>
<li><b>regext</b> &ndash; value must match java regular expression</li>
</ul>"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EEnum" name="RowMatchMode"> |
| <eLiterals name="exact"/> |
| <eLiterals name="glob" value="1"/> |
| <eLiterals name="regexp" value="2"/> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="ExcludeRows" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Takes a table from input and returns the table with rows filtered by column and criteria."/> |
| <details key="returns" value="Copy of input table object with filtered rows."/> |
| <details key="example" value="exclude-rows -column "columnName" -value "value" -match exact|glob|regex"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="table" eType="ecore:EClass objects.ecore#//Table"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Table to take columns from"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="column" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Column named to filter rows by."/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="value" eType="ecore:EDataType platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Pattern to match rows to."/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="match" eType="#//RowMatchMode"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Describes the matching behaviour for rows.
<ul>
<li><b>glob</b> &ndash; wildcard matching</li>
<li><b>exact</b> &ndash; value should be equals to pattern</li>
<li><b>regext</b> &ndash; value must match java regular expression</li>
</ul>"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="AsTableData" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Converts its input to table data format, exactly the same as <code>get-table-data</code> returns."/> |
| <details key="returns" value="Table data."/> |
| <details key="example" value="get-log -levels error | as-table-data | write-csv-file "workspace:/Project/file2.csv""/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EReference" name="input" upperBound="-1" |
| eType="ecore:EClass platform:/plugin/org.eclipse.emf.ecore/model/Ecore.ecore#//EObject"> |
| <eAnnotations source="http://www.eclipse.org/ecl/input"/> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Object(s) to convert from."/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| <eClassifiers xsi:type="ecore:EClass" name="ReadProperties" eSuperTypes="../../org.eclipse.rcptt.ecl.core/model/ecl.ecore#//Command"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="Parses given .properties file. Fails if file is not found or format is invalid"/> |
| <details key="returns" value="ECL map with values from properties file"/> |
| <details key="example" value="...get-item "General Registers/pc" | get-property "values[\'Value\']"
| matches [format "%s.*" [read-properties -uri "file:/C:/Users/Administrator/Desktop/p.properties" | get myKey]] | verify-true
"/> |
| </eAnnotations> |
| <eStructuralFeatures xsi:type="ecore:EAttribute" name="uri" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"> |
| <eAnnotations source="http://www.eclipse.org/ecl/docs"> |
| <details key="description" value="URI to a file to read. Currently supported schemes are workspace:/ for files in workspace and file:/ for files on local file system"/> |
| </eAnnotations> |
| </eStructuralFeatures> |
| </eClassifiers> |
| </ecore:EPackage> |
