Class DatasetUtilities
- java.lang.Object
-
- com.inductiveautomation.ignition.common.script.builtin.DatasetUtilities
-
public class DatasetUtilities extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DatasetUtilities.PyDataSet
-
Constructor Summary
Constructors Constructor Description DatasetUtilities()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Dataset
addColumn(Dataset ds, int colId, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType)
static Dataset
addColumn(Dataset ds, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType)
static Dataset
addRow(Dataset ds, int rowId, org.python.core.PySequence row)
static Dataset
addRow(Dataset ds, org.python.core.PySequence row)
static Dataset
addRows(Dataset ds, int rowId, org.python.core.PySequence[] rows)
static Dataset
addRows(Dataset ds, org.python.core.PySequence[] rows)
static Dataset
appendDataset(Dataset ds1, Dataset ds2)
static Dataset
clearDataset(Dataset ds)
static java.lang.String
dataSetToCSV(boolean headerRow, Dataset ds)
Deprecated.static java.lang.String
dataSetToExcel(boolean headerRow, java.lang.Object[] datasets)
static java.lang.String
dataSetToExcel(boolean headerRow, java.lang.Object[] datasets, boolean nullsEmpty)
Deprecated.static byte[]
dataSetToExcelBytes(boolean headerRow, java.lang.Object[] objects, boolean nullsEmpty)
static void
dataSetToExcelStreaming(boolean headerRow, java.lang.Object[] objects, java.io.OutputStream out, boolean nullsEmpty)
static void
dataSetToExcelStreaming(boolean headerRow, java.lang.Object[] datasets, java.io.Writer out, boolean nullsEmpty)
Deprecated.static java.lang.String
dataSetToHTML(boolean headerRow, Dataset ds, java.lang.String title)
static void
dataSetToHTMLStreaming(boolean headerRow, Dataset ds, java.lang.String title, java.io.Writer fw)
static Dataset
deleteRow(Dataset ds, int row)
static Dataset
deleteRows(Dataset ds, int[] rows)
static Dataset
filterColumns(Dataset dataset, org.python.core.PySequence columns)
static Dataset
formatDates(Dataset dataset, java.lang.String format)
static Dataset
formatDates(Dataset dataset, java.lang.String format, java.util.Locale locale)
Returns a new dataset with all date columns changed to Strings, and the dates formatted as stringsstatic Dataset
fromCSV(java.lang.String csv)
static Dataset
fromCSVJava(java.lang.String csv)
A special version of fromCSV that throws Java exceptions rather than wrapped, uncaught python exceptionsstatic org.python.core.PyList
getColumnHeaders(Dataset ds)
static Dataset
insertColumn(Dataset ds, int colId, java.lang.Object[] col, java.lang.String colName, java.lang.Class colType)
static Dataset
insertColumn(Dataset ds, int colId, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType)
static Dataset
insertColumn(Dataset ds, org.python.core.PySequence row, java.lang.String colName, org.python.core.PyType colType)
static Dataset
insertRow(Dataset ds, int rowId, org.python.core.PySequence row)
static Dataset
insertRow(Dataset ds, org.python.core.PySequence row)
static Dataset
removeRow(Dataset ds, int row)
static Dataset
setValue(Dataset ds, int row, int col, java.lang.Object value)
static Dataset
setValue(Dataset ds, int row, int col, org.python.core.PyObject value)
static Dataset
setValue(Dataset ds, int row, java.lang.String col, org.python.core.PyObject value)
static Dataset
sort(Dataset dataset, int keyColumn)
static Dataset
sort(Dataset dataset, int keyColumn, boolean ascending)
static Dataset
sort(Dataset dataset, java.lang.String keyColumn)
static Dataset
sort(Dataset dataset, java.lang.String keyColumn, boolean ascending)
static java.lang.String
toCSV(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
static java.lang.String
toCSVJava(Dataset ds, boolean showHeaders, boolean forExport)
static java.lang.String
toCSVJava(Dataset ds, boolean showHeaders, boolean forExport, boolean localized)
static void
toCSVJavaStreaming(Dataset ds, java.lang.Boolean showHeaders, boolean forExport, java.io.Writer sw, boolean localized)
static Dataset
toDataSet(DatasetUtilities.PyDataSet pds)
static Dataset
toDataSet(org.python.core.PySequence headers, org.python.core.PySequence pyData)
static byte[]
toExcel(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
Exports 1 or moreDataset
s to excel.static JSONObject
toJSONObject(Dataset data)
Returns a JSON object in the format of:static DatasetUtilities.PyDataSet
toPyDataSet(Dataset dataset)
static Dataset
updateRow(Dataset ds, int row, org.python.core.PyDictionary changes)
-
-
-
Method Detail
-
formatDates
public static Dataset formatDates(Dataset dataset, java.lang.String format) throws java.lang.IllegalArgumentException
- Throws:
java.lang.IllegalArgumentException
-
formatDates
public static Dataset formatDates(Dataset dataset, java.lang.String format, java.util.Locale locale) throws java.lang.IllegalArgumentException
Returns a new dataset with all date columns changed to Strings, and the dates formatted as strings- Parameters:
dataset
- Dataset to formatformat
- Date format to uselocale
- Locale to use. If null, default will be used.- Returns:
- New dataset, formatted. If there are no date columns, original dataset is returned.
- Throws:
java.lang.IllegalArgumentException
- is date format is not valid
-
toPyDataSet
public static DatasetUtilities.PyDataSet toPyDataSet(Dataset dataset)
-
toDataSet
public static Dataset toDataSet(DatasetUtilities.PyDataSet pds)
-
toDataSet
public static Dataset toDataSet(org.python.core.PySequence headers, org.python.core.PySequence pyData)
-
filterColumns
public static Dataset filterColumns(Dataset dataset, org.python.core.PySequence columns) throws java.lang.Exception
- Throws:
java.lang.Exception
-
fromCSV
public static Dataset fromCSV(java.lang.String csv)
-
fromCSVJava
public static Dataset fromCSVJava(java.lang.String csv) throws java.io.IOException, java.lang.ClassNotFoundException, java.lang.IllegalArgumentException
A special version of fromCSV that throws Java exceptions rather than wrapped, uncaught python exceptions- Throws:
java.io.IOException
java.lang.ClassNotFoundException
java.lang.IllegalArgumentException
-
toCSV
public static java.lang.String toCSV(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords)
-
toCSVJava
public static java.lang.String toCSVJava(Dataset ds, boolean showHeaders, boolean forExport)
-
toCSVJava
public static java.lang.String toCSVJava(Dataset ds, boolean showHeaders, boolean forExport, boolean localized)
-
toCSVJavaStreaming
public static void toCSVJavaStreaming(Dataset ds, java.lang.Boolean showHeaders, boolean forExport, java.io.Writer sw, boolean localized)
-
toJSONObject
public static JSONObject toJSONObject(Dataset data)
Returns a JSON object in the format of:{ "columns": [ { "name": "col_1", "type": "java.lang.Integer" }, { "name": "col_2", "type": "java.lang.Integer" }, { "name": "col_3", "type": "java.lang.Integer" }], "rows": [ [ 1, 2, "hello" ], [ 3, 8, "whatever" ]] }
-
dataSetToCSV
@Deprecated public static java.lang.String dataSetToCSV(boolean headerRow, Dataset ds)
Deprecated.
-
dataSetToHTML
public static java.lang.String dataSetToHTML(boolean headerRow, Dataset ds, java.lang.String title)
-
dataSetToHTMLStreaming
public static void dataSetToHTMLStreaming(boolean headerRow, Dataset ds, java.lang.String title, java.io.Writer fw) throws java.io.IOException
- Throws:
java.io.IOException
-
dataSetToExcel
@Deprecated public static java.lang.String dataSetToExcel(boolean headerRow, java.lang.Object[] datasets, boolean nullsEmpty)
Deprecated.Exports 1 or more datasets to excel.- Parameters:
datasets
- An array of Datasets or PyDataSets. Each dataset will be on a separate sheet.
-
dataSetToExcel
public static java.lang.String dataSetToExcel(boolean headerRow, java.lang.Object[] datasets)
-
toExcel
public static byte[] toExcel(org.python.core.PyObject[] pyArgs, java.lang.String[] keywords) throws java.io.IOException
Exports 1 or moreDataset
s to excel.- Throws:
java.io.IOException
-
dataSetToExcelStreaming
@Deprecated public static void dataSetToExcelStreaming(boolean headerRow, java.lang.Object[] datasets, java.io.Writer out, boolean nullsEmpty) throws java.io.IOException
Deprecated.- Throws:
java.io.IOException
-
dataSetToExcelStreaming
public static void dataSetToExcelStreaming(boolean headerRow, java.lang.Object[] objects, java.io.OutputStream out, boolean nullsEmpty)
-
dataSetToExcelBytes
public static byte[] dataSetToExcelBytes(boolean headerRow, java.lang.Object[] objects, boolean nullsEmpty)
-
addRow
public static Dataset addRow(Dataset ds, org.python.core.PySequence row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
addRow
public static Dataset addRow(Dataset ds, int rowId, org.python.core.PySequence row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
insertRow
public static Dataset insertRow(Dataset ds, org.python.core.PySequence row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
insertRow
public static Dataset insertRow(Dataset ds, int rowId, org.python.core.PySequence row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
addRows
public static Dataset addRows(Dataset ds, org.python.core.PySequence[] rows) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
addRows
public static Dataset addRows(Dataset ds, int rowId, org.python.core.PySequence[] rows) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
appendDataset
public static Dataset appendDataset(Dataset ds1, Dataset ds2) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
addColumn
public static Dataset addColumn(Dataset ds, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
addColumn
public static Dataset addColumn(Dataset ds, int colId, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
insertColumn
public static Dataset insertColumn(Dataset ds, org.python.core.PySequence row, java.lang.String colName, org.python.core.PyType colType) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
insertColumn
public static Dataset insertColumn(Dataset ds, int colId, org.python.core.PySequence col, java.lang.String colName, org.python.core.PyType colType) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
insertColumn
public static Dataset insertColumn(Dataset ds, int colId, java.lang.Object[] col, java.lang.String colName, java.lang.Class colType) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
getColumnHeaders
public static org.python.core.PyList getColumnHeaders(Dataset ds) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
removeRow
public static Dataset removeRow(Dataset ds, int row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
deleteRow
public static Dataset deleteRow(Dataset ds, int row) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
deleteRows
public static Dataset deleteRows(Dataset ds, int[] rows) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
updateRow
public static Dataset updateRow(Dataset ds, int row, org.python.core.PyDictionary changes) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
setValue
public static Dataset setValue(Dataset ds, int row, java.lang.String col, org.python.core.PyObject value) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
setValue
public static Dataset setValue(Dataset ds, int row, int col, org.python.core.PyObject value) throws org.python.core.PyException
- Throws:
org.python.core.PyException
-
-