SDDS.java.SDDS
Class SDDSFile

java.lang.Object
  |
  +--SDDS.java.SDDS.SDDSFile

public class SDDSFile

extends java.lang.Object

The SDDS File object is used to read and write Self Describing Data Sets. It creates and manages SDDS Parameter objects and SDDS Column objects. A brief introduction to the SDDS concept can be found here.

Since:

JDK 1.2

Version:

1.0 (November 1, 1999)

Author:

Robert Soliday soliday@aps.anl.gov

Field Summary

boolean	asciiFile
boolean	bigEndian
java.lang.String	descriptionContents
java.lang.String	descriptionText
java.lang.String	fileName
boolean	isURL
int	layoutVersion
boolean	noRowCount
java.net.URL	URLName

Constructor Summary

SDDSFile()
Create a new SDDS file that can be used to read and write SDDS files.

SDDSFile(boolean binary)
Create a new SDDS file that can be used to read and write SDDS files.

SDDSFile(java.lang.String filename)
Create a new SDDS file that can be used to read and write SDDS files.

SDDSFile(java.lang.String filename, boolean binary)
Create a new SDDS file that can be used to read and write SDDS files.

SDDSFile(java.net.URL filename)
Create a new SDDS file that can be used to read and write SDDS files.

Method Summary

boolean	addColumnElement(int column, char v) add a single element to a column of data
boolean	addColumnElement(int column, double v) add a single element to a column of data
boolean	addColumnElement(int column, float v) add a single element to a column of data
boolean	addColumnElement(int column, long v) add a single element to a column of data
boolean	addColumnElement(int column, short v) add a single element to a column of data
boolean	addColumnElement(int column, java.lang.String v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, char v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, double v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, float v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, long v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, short v) add a single element to a column of data
boolean	addColumnElement(java.lang.String name, java.lang.String v) add a single element to a column of data
boolean	closeInput() Close the SDDS input file
boolean	closeOutput() Close the SDDS output file
int	defineArray(java.lang.String name, int type, int dimensions) Creates a new array with the specified settings.
int	defineArray(java.lang.String name, java.lang.String type, int dimensions) Creates a new array with the specified settings.
int	defineArray(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, java.lang.String group_name, int type, int field_length, int dimensions) Creates a new array with the specified settings.
int	defineArray(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, java.lang.String group_name, java.lang.String type, int field_length, int dimensions) Creates a new array with the specified settings.
boolean	defineArrays(java.lang.String[] names, int[] types, int[] dimensions) Creates new arrays with the specified settings.
boolean	defineArrays(java.lang.String[] names, java.lang.String[] types, int[] dimensions) Creates new arrays with the specified settings.
boolean	defineArrays(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, java.lang.String[] group_names, int[] types, int[] field_lengths, int[] dimensions) Creates new arrays with the specified settings.
boolean	defineArrays(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, java.lang.String[] group_names, java.lang.String[] types, int[] field_lengths, int[] dimensions) Creates new arrays with the specified settings.
int	defineColumn(java.lang.String name, int type) Creates a new column with the specified settings.
int	defineColumn(java.lang.String name, java.lang.String type) Creates a new column with the specified settings.
int	defineColumn(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, int type, int field_length) Creates a new column with the specified settings.
int	defineColumn(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, java.lang.String type, int field_length) Creates a new column with the specified settings.
boolean	defineColumns(java.lang.String[] names, int[] types) Creates new columns with the specified settings.
boolean	defineColumns(java.lang.String[] names, java.lang.String[] types) Creates new columns with the specified settings.
boolean	defineColumns(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, int[] types, int[] field_lengths) Creates new columns with the specified settings.
boolean	defineColumns(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, java.lang.String[] types, int[] field_lengths) Creates new columns with the specified settings.
int	defineParameter(java.lang.String name, int type) Creates a new parameter with the specified settings.
int	defineParameter(java.lang.String name, java.lang.String type) Creates a new parameter with the specified settings.
int	defineParameter(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, int type, java.lang.String fixed_value) Creates a new parameter with the specified settings.
int	defineParameter(java.lang.String name, java.lang.String symbol, java.lang.String units, java.lang.String description, java.lang.String format_string, java.lang.String type, java.lang.String fixed_value) Creates a new parameter with the specified settings.
boolean	defineParameters(java.lang.String[] names, int[] types) Creates new parameters with the specified settings.
boolean	defineParameters(java.lang.String[] names, java.lang.String[] types) Creates new parameters with the specified settings.
boolean	defineParameters(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, int[] types, java.lang.String[] fixed_values) Creates new parameters with the specified settings.
boolean	defineParameters(java.lang.String[] names, java.lang.String[] symbols, java.lang.String[] units, java.lang.String[] descriptions, java.lang.String[] format_strings, java.lang.String[] types, java.lang.String[] fixed_values) Creates new parameters with the specified settings.
void	deleteArray(java.lang.String name) Delete array
void	deleteColumn(java.lang.String name) Delete column
boolean	deletePage(int page) Delete page at index specifed
void	deleteParameter(java.lang.String name) Delete parameter
void	deleteRow(int page, int row) Deletes the value of the column at a chosen page and at a chosen row
boolean	duplicateCopy(SDDSFile file, boolean parameters, boolean arrays, boolean columns) Duplicate an SDDSFile object copying over appropriate header information and data.
java.lang.String[]	getAllArrayUnits() Get all array units
java.lang.String[]	getAllColumnUnits() Get all column units
java.lang.String[]	getAllParameterUnits() Get all parameter units
java.lang.String	getArrayDescription(int index) Get array description
java.lang.String[]	getArrayDescriptions() Get array descriptions
int[]	getArrayDim(int index) Returns the number of elements in each dimension of the array
int	getArrayDimensions(int index) Get array dimensions
int	getArrayFieldLength(int index) Get array field length
int[]	getArrayFieldLengths() Get field lengths
java.lang.String	getArrayFormatString(int index) Get array format string
java.lang.String[]	getArrayFormatStrings() Get array format strings
java.lang.String	getArrayGroupName(int index) Get array group name
java.lang.String[]	getArrayGroupNames() Get array group names
int	getArrayIndex(java.lang.String name) Return the index of the specified array.
int[]	getArrayIndexes(java.lang.String[] names) Return the indexes of the specified arrays.
java.lang.String	getArrayName(int index) Get array name
java.lang.String[]	getArrayNames() Get array names
java.lang.String	getArraySymbol(int index) Get array symbol
java.lang.String[]	getArraySymbols() Get array symbols
int	getArrayType(int index) Get array type
int[]	getArrayTypes() Get array types
java.lang.String	getArrayUnits(int index) Get array units
java.lang.Object[]	getArrayValues(int index, int page, boolean string_quotes) Get the values of the array for a chosen page
java.lang.String	getColumnDescription(int index) Get column description
java.lang.String[]	getColumnDescriptions() Get column descriptions
int	getColumnFieldLength(int index) Get column field length
int[]	getColumnFieldLengths() Get field lengths
java.lang.String	getColumnFormatString(int index) Get column format string
java.lang.String[]	getColumnFormatStrings() Get column format strings
int	getColumnIndex(java.lang.String name) Return the index of the specified column.
int[]	getColumnIndexes(java.lang.String[] names) Return the indexes of the specified columns.
java.lang.String	getColumnName(int index) Get column name
java.lang.String[]	getColumnNames() Get column names
java.lang.String	getColumnSymbol(int index) Get column symbol
java.lang.String[]	getColumnSymbols() Get column symbols
int	getColumnType(int index) Get column type
int[]	getColumnTypes() Get column types
java.lang.String	getColumnUnits(int index) Get column units
java.lang.Object[]	getColumnValues(int index, int page, boolean string_quotes) Get the values of the column for a chosen page
java.lang.String	getErrors() Return all the error messages.
java.lang.String	getParameterDescription(int index) Get parameter description
java.lang.String[]	getParameterDescriptions() Get parameter descriptions
java.lang.String	getParameterFixedValue(int index) Get parameter fixed value
java.lang.String	getParameterFormatString(int index) Get parameter format string
java.lang.String[]	getParameterFormatStrings() Get parameter format strings
int	getParameterIndex(java.lang.String name) Return the index of the specified parameter.
int[]	getParameterIndexes(java.lang.String[] names) Return the indexes of the specified parameter.
java.lang.String	getParameterName(int index) Get parameter name
java.lang.String[]	getParameterNames() Get parameter names
java.lang.String	getParameterSymbol(int index) Get parameter symbol
java.lang.String[]	getParameterSymbols() Get parameter symbols
int	getParameterType(int index) Get parameter type
int[]	getParameterTypes() Get parameter types
java.lang.String	getParameterUnits(int index) Get parameter units
java.lang.Object	getParameterValue(int index, int page, boolean string_quotes) Get the value of the parameter for a chosen page
int	getRowCount(int page) Get the number of rows on a page.
boolean	insertPage(int page) Insert blank page at index specifed
void	makeBlankPages(int lastpage) Create blank pages up to the last page specified
boolean	openInputFile() Open SDDS input file
boolean	openOutputFile() Open a file for writting.
int	pageCount() Get the number of pages in the SDDS object
boolean	parseHeaders() Parse SDDS input file header lines
void	printErrors() Print the error messages to standard error.
boolean	readAsciiData() Read SDDS input file ascii data
boolean	readBinaryData() Read SDDS input file binary data
boolean	readFile() Read the SDDS file
void	renameArray(java.lang.String oldname, java.lang.String newname) Rename array
void	renameColumn(java.lang.String oldname, java.lang.String newname) Rename column
void	renameParameter(java.lang.String oldname, java.lang.String newname) Rename parameter
boolean	setArray(int arrayIndex, char[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, double[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, float[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, int[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, long[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, short[] values, int page) Set the values of the array at the specified page.
boolean	setArray(int arrayIndex, java.lang.String[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, char[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, double[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, float[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, int[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, long[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, short[] values, int page) Set the values of the array at the specified page.
boolean	setArray(java.lang.String name, java.lang.String[] values, int page) Set the values of the array at the specified page.
void	setArrayDescription(int index, java.lang.String description) Set array description
void	setArrayDim(int index, int[] dim) Returns the number of elements in each dimension of the array
void	setArrayFieldLength(int index, int field_length) Set array field length
void	setArrayFormatString(int index, java.lang.String format_string) Set array format string
void	setArrayGroupName(int index, java.lang.String group_name) Set array group name
void	setArraySymbol(int index, java.lang.String symbol) Set array symbol
void	setArrayUnits(int index, java.lang.String units) Set array units
boolean	setColumn(int columnIndex, char[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, char[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, double[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, double[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, float[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, float[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, int[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, int[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, long[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, long[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, short[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, short[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(int columnIndex, java.lang.String[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(int columnIndex, java.lang.String[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, char[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, char[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, double[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, double[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, float[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, float[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, int[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, int[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, long[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, long[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, short[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, short[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
boolean	setColumn(java.lang.String name, java.lang.String[] values, int page) Set the values of the column at the specified page.
boolean	setColumn(java.lang.String name, java.lang.String[] values, int page, int startRow) Set the values of the column at the specified page starting at the specified row.
void	setColumnDescription(int index, java.lang.String description) Set column description
boolean	setColumnElement(int columnIndex, char value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, double value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, float value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, int value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, long value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, short value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(int columnIndex, java.lang.String value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, char value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, double value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, float value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, int value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, long value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, short value, int page, int row) Set the value of the column element at the specified page and row.
boolean	setColumnElement(java.lang.String name, java.lang.String value, int page, int row) Set the value of the column element at the specified page and row.
void	setColumnFieldLength(int index, int field_length) Set column field length
void	setColumnFormatString(int index, java.lang.String format_string) Set column format string
void	setColumnSymbol(int index, java.lang.String symbol) Set column symbol
void	setColumnUnits(int index, java.lang.String units) Set column units
void	setDescription(java.lang.String text, java.lang.String contents) Set the description text and contents.
void	setEndian(boolean little_endian) Set endian mode for accessing files.
void	setError(java.lang.String error_text) Append to the error description array.
boolean	setFileName(java.lang.String filename) Set the file name for input and output.
void	setMode(boolean binary) Set binary mode for accessing files.
boolean	setNoRowCount(boolean norowcount) Set for fixed number of rows in column data or dynamic.
boolean	setParameter(int parameterIndex, char[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, char value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, double[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, double value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, float[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, float value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, int[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, int value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, long[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, long value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, short[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, short value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(int parameterIndex, java.lang.String[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(int parameterIndex, java.lang.String value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, char[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, char value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, double[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, double value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, float[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, float value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, int[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, int value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, long[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, long value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, short[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, short value, int page) Set the value of the parameter at the specified page.
boolean	setParameter(java.lang.String name, java.lang.String[] values, int startPage) Set the values of the parameter starting from the specified page.
boolean	setParameter(java.lang.String name, java.lang.String value, int page) Set the value of the parameter at the specified page.
void	setParameterDescription(int index, java.lang.String description) Set parameter description
void	setParameterFixedValue(int index, java.lang.String fixed_value) Set parameter fixed value
void	setParameterFormatString(int index, java.lang.String format_string) Set parameter format string
boolean	setParameters(int[] parameterIndexes, char[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, char[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, double[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, double[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, float[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, float[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, int[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, int[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, long[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, long[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, short[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, short[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(int[] parameterIndexes, java.lang.String[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(int[] parameterIndexes, java.lang.String[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, char[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, char[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, double[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, double[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, float[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, float[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, int[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, int[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, long[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, long[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, short[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, short[] values, int page) Set the values of the parameters at the specified page.
boolean	setParameters(java.lang.String[] names, java.lang.String[][] values, int startPage) Set the values of the parameters starting at the specified page.
boolean	setParameters(java.lang.String[] names, java.lang.String[] values, int page) Set the values of the parameters at the specified page.
void	setParameterSymbol(int index, java.lang.String symbol) Set parameter symbol
void	setParameterUnits(int index, java.lang.String units) Set parameter units
boolean	switchToNewFile(java.lang.String fileName) Switch writing of column data from one file to a new file without having to redefine parameters, arrays and columns.
boolean	writeArrayHeader(int index) Write the specified array header to a file.
boolean	writeArrayHeaders() Write the array headers to a file.
boolean	writeColumnHeader(int index) Write the specified column header to a file.
boolean	writeColumnHeaders() Write the column headers to a file.
boolean	writeDescription() Write the description to a file.
boolean	writeFile() Write out the SDDS file
boolean	writeLayout() Write the layout to a file.
boolean	writePage(int page) Write specified the page to a file.
boolean	writePages() Write all the pages to a file.
boolean	writePages(int startPage, int endPage) Write specified the pages to a file.
boolean	writeParameterHeader(int index) Write the specified parameter header to a file.
boolean	writeParameterHeaders() Write the parameter headers to a file.
boolean	writeRow() Write a new row of column data.

Methods inherited from class java.lang.Object

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

Field Detail

fileName

public java.lang.String fileName

URLName

public java.net.URL URLName

descriptionText

public java.lang.String descriptionText

descriptionContents

public java.lang.String descriptionContents

asciiFile

public boolean asciiFile

noRowCount

public boolean noRowCount

bigEndian

public boolean bigEndian

layoutVersion

public int layoutVersion

isURL

public boolean isURL

Constructor Detail

SDDSFile

public SDDSFile()

Create a new SDDS file that can be used to read and write SDDS files.

SDDSFile

public SDDSFile(java.lang.String filename)

Create a new SDDS file that can be used to read and write SDDS files.

Parameters:

filename - file name to read or write data

SDDSFile

public SDDSFile(java.net.URL filename)

Create a new SDDS file that can be used to read and write SDDS files.

Parameters:

filename - file name to read or write data

SDDSFile

public SDDSFile(boolean binary)

Create a new SDDS file that can be used to read and write SDDS files.

Parameters:

binary - true if binary output, false if ascii output

SDDSFile

public SDDSFile(java.lang.String filename,
                boolean binary)

Create a new SDDS file that can be used to read and write SDDS files.

Parameters:

filename - file name to read or write data

binary - true if binary output, false if ascii output

Method Detail

setFileName

public boolean setFileName(java.lang.String filename)

Set the file name for input and output.

Parameters:

filename - file name to read or write data

Returns:

true if successful
false if an error occurs

setMode

public void setMode(boolean binary)

Set binary mode for accessing files.

Parameters:

binary - true if binary output, false if ascii output

setEndian

public void setEndian(boolean little_endian)

Set endian mode for accessing files.

Parameters:

little_endian - true if little endian input and output, false if big endian input and output. Not used with ascii files.

setNoRowCount

public boolean setNoRowCount(boolean norowcount)

Set for fixed number of rows in column data or dynamic. This method will have no effect if called after header is written.

Parameters:

noRowCount - true dynamic column data false fixed number of rows in column data

Returns:

true if successful
false if an error occurs

switchToNewFile

public boolean switchToNewFile(java.lang.String fileName)

Switch writing of column data from one file to a new file without having to redefine parameters, arrays and columns. This is useful for when noRowCount is set and the number of rows has grown rather large and continuing the data in a new file would seem appropriate. The parameter and array data is duplicated in the new file and the column data headers are duplicated in the new file without carrying the actual column data from the old file over. Fresh row data can be added one row at a time to the new file.

Parameters:

fileName - fileName The new file to be written into

Returns:

true If success
false If an error occurs

duplicateCopy

public boolean duplicateCopy(SDDSFile file,
                             boolean parameters,
                             boolean arrays,
                             boolean columns)

Duplicate an SDDSFile object copying over appropriate header information and data.

Parameters:

file - SDDSFile object to be copied

parameters - true copy parameter information
false ignore parameter data

arrays - true copy array information
false ignore array data

columns - true copy column information
false ignore column data

Returns:

true if successful
false if error occurs

openOutputFile

public boolean openOutputFile()

Open a file for writting.

Returns:

true if successful
false if error occurs

writeFile

public boolean writeFile()

Write out the SDDS file

Returns:

true if successful
false if an error occurs

readFile

public boolean readFile()

Read the SDDS file

Returns:

true if successful
false if an error occurs

openInputFile

public boolean openInputFile()

Open SDDS input file

Returns:

true if successful
false if an error occurs

parseHeaders

public boolean parseHeaders()

Parse SDDS input file header lines

Returns:

true if successful
false if an error occurs

readBinaryData

public boolean readBinaryData()

Read SDDS input file binary data

Returns:

true if successful
false if an error occurs

readAsciiData

public boolean readAsciiData()

Read SDDS input file ascii data

Returns:

true if successful
false if an error occurs

makeBlankPages

public void makeBlankPages(int lastpage)

Create blank pages up to the last page specified

Parameters:

lastpage - last page to create blank page

insertPage

public boolean insertPage(int page)

Insert blank page at index specifed

Parameters:

page - index of page to create;

deletePage

public boolean deletePage(int page)

Delete page at index specifed

Parameters:

page - index of page to delete;

closeOutput

public boolean closeOutput()

Close the SDDS output file

Returns:

true if successful
false if error occurs

closeInput

public boolean closeInput()

Close the SDDS input file

Returns:

true if successful
false if error occurs

setDescription

public void setDescription(java.lang.String text,
                           java.lang.String contents)

Set the description text and contents.

Parameters:

text - may be null

contents - may be null

deleteParameter

public void deleteParameter(java.lang.String name)

Delete parameter

Parameters:

name - name of the parameter

deleteArray

public void deleteArray(java.lang.String name)

Delete array

Parameters:

name - name of the array

deleteColumn

public void deleteColumn(java.lang.String name)

Delete column

Parameters:

name - name of the column

renameParameter

public void renameParameter(java.lang.String oldname,
                            java.lang.String newname)

Rename parameter

Parameters:

oldname - old name of the parameter

newname - new name of the parameter

renameArray

public void renameArray(java.lang.String oldname,
                        java.lang.String newname)

Rename array

Parameters:

oldname - old name of the array

newname - new name of the array

renameColumn

public void renameColumn(java.lang.String oldname,
                         java.lang.String newname)

Rename column

Parameters:

oldname - old name of the column

newname - new name of the column

setColumnSymbol

public void setColumnSymbol(int index,
                            java.lang.String symbol)

Set column symbol

Parameters:

index - index of the column

symbol - symbol for the column

setArraySymbol

public void setArraySymbol(int index,
                           java.lang.String symbol)

Set array symbol

Parameters:

index - index of the array

symbol - symbol for the array

setParameterSymbol

public void setParameterSymbol(int index,
                               java.lang.String symbol)

Set parameter symbol

Parameters:

index - index of the parameter

symbol - symbol for the parameter

setColumnUnits

public void setColumnUnits(int index,
                           java.lang.String units)

Set column units

Parameters:

index - index of the column

units - units for the column

setArrayUnits

public void setArrayUnits(int index,
                          java.lang.String units)

Set array units

Parameters:

index - index of the array

units - units for the array

setParameterUnits

public void setParameterUnits(int index,
                              java.lang.String units)

Set parameter units

Parameters:

index - index of the parameter

units - units for the parameter

setColumnDescription

public void setColumnDescription(int index,
                                 java.lang.String description)

Set column description

Parameters:

index - index of the column

description - description for the column

setArrayDescription

public void setArrayDescription(int index,
                                java.lang.String description)

Set array description

Parameters:

index - index of the array

description - description for the array

setParameterDescription

public void setParameterDescription(int index,
                                    java.lang.String description)

Set parameter description

Parameters:

index - index of the parameter

description - description for the parameter

setColumnFormatString

public void setColumnFormatString(int index,
                                  java.lang.String format_string)

Set column format string

Parameters:

index - index of the column

format_string - format string for the column

setArrayFormatString

public void setArrayFormatString(int index,
                                 java.lang.String format_string)

Set array format string

Parameters:

index - index of the array

format_string - format string for the array

setParameterFormatString

public void setParameterFormatString(int index,
                                     java.lang.String format_string)

Set parameter format string

Parameters:

index - index of the parameter

format_string - format string for the parameter

setArrayGroupName

public void setArrayGroupName(int index,
                              java.lang.String group_name)

Set array group name

Parameters:

index - index of the array

group_name - group name for the array

setColumnFieldLength

public void setColumnFieldLength(int index,
                                 int field_length)

Set column field length

Parameters:

index - index of the column

field_length - field length for the column

setArrayFieldLength

public void setArrayFieldLength(int index,
                                int field_length)

Set array field length

Parameters:

index - index of the array

field_length - field length for the array

setParameterFixedValue

public void setParameterFixedValue(int index,
                                   java.lang.String fixed_value)

Set parameter fixed value

Parameters:

index - index of the parameter

fixed_value - fixed_value for the parameter

getParameterNames

public java.lang.String[] getParameterNames()

Get parameter names

Returns:

string array of parameter names

getParameterName

public java.lang.String getParameterName(int index)

Get parameter name

Parameters:

index - index of the parameter

Returns:

parameter name

getArrayNames

public java.lang.String[] getArrayNames()

Get array names

Returns:

string of array names

getArrayName

public java.lang.String getArrayName(int index)

Get array name

Parameters:

index - index of the array

Returns:

array name

getColumnNames

public java.lang.String[] getColumnNames()

Get column names

Returns:

string array of column names

getColumnName

public java.lang.String getColumnName(int index)

Get column name

Parameters:

index - index of the column

Returns:

column name

getAllParameterUnits

public java.lang.String[] getAllParameterUnits()

Get all parameter units

Returns:

string array of parameter units

getParameterUnits

public java.lang.String getParameterUnits(int index)

Get parameter units

Parameters:

index - index of the parameter

Returns:

parameter units

getAllArrayUnits

public java.lang.String[] getAllArrayUnits()

Get all array units

Returns:

string array of array units

getArrayUnits

public java.lang.String getArrayUnits(int index)

Get array units

Parameters:

index - index of the array

Returns:

array units

getAllColumnUnits

public java.lang.String[] getAllColumnUnits()

Get all column units

Returns:

string array of column units

getColumnUnits

public java.lang.String getColumnUnits(int index)

Get column units

Parameters:

index - index of the column

Returns:

column units

getParameterSymbols

public java.lang.String[] getParameterSymbols()

Get parameter symbols

Returns:

string array of parameter symbols

getParameterSymbol

public java.lang.String getParameterSymbol(int index)

Get parameter symbol

Parameters:

index - index of the parameter

Returns:

parameter symbol

getArraySymbols

public java.lang.String[] getArraySymbols()

Get array symbols

Returns:

string array of array symbols

getArraySymbol

public java.lang.String getArraySymbol(int index)

Get array symbol

Parameters:

index - index of the array

Returns:

array symbol

getColumnSymbols

public java.lang.String[] getColumnSymbols()

Get column symbols

Returns:

string array of column symbols

getColumnSymbol

public java.lang.String getColumnSymbol(int index)

Get column symbol

Parameters:

index - index of the column

Returns:

column symbol

getParameterFormatStrings

public java.lang.String[] getParameterFormatStrings()

Get parameter format strings

Returns:

string array of parameter format strings

getParameterFormatString

public java.lang.String getParameterFormatString(int index)

Get parameter format string

Parameters:

index - index of the parameter

Returns:

parameter format string

getArrayFormatStrings

public java.lang.String[] getArrayFormatStrings()

Get array format strings

Returns:

string array of array format strings

getArrayFormatString

public java.lang.String getArrayFormatString(int index)

Get array format string

Parameters:

index - index of the array

Returns:

array format string

getColumnFormatStrings

public java.lang.String[] getColumnFormatStrings()

Get column format strings

Returns:

string array of column format strings

getColumnFormatString

public java.lang.String getColumnFormatString(int index)

Get column format string

Parameters:

index - index of the column

Returns:

column format string

getArrayGroupNames

public java.lang.String[] getArrayGroupNames()

Get array group names

Returns:

string array of array group names

getArrayGroupName

public java.lang.String getArrayGroupName(int index)

Get array group name

Parameters:

index - index of the array

Returns:

array group name

getParameterTypes

public int[] getParameterTypes()

Get parameter types

Returns:

int array of parameter types

getParameterType

public int getParameterType(int index)

Get parameter type

Parameters:

index - index of the parameter

Returns:

parameter type

getArrayTypes

public int[] getArrayTypes()

Get array types

Returns:

int array of array types

getArrayType

public int getArrayType(int index)

Get array type

Parameters:

index - index of the array

Returns:

array type

getColumnTypes

public int[] getColumnTypes()

Get column types

Returns:

int array of column types

getColumnType

public int getColumnType(int index)

Get column type

Parameters:

index - index of the column

Returns:

column type

getColumnFieldLengths

public int[] getColumnFieldLengths()

Get field lengths

Returns:

int array of column field lengths

getArrayFieldLengths

public int[] getArrayFieldLengths()

Get field lengths

Returns:

int array of array field lengths

getColumnFieldLength

public int getColumnFieldLength(int index)

Get column field length

Parameters:

index - index of the column

Returns:

column field length

getArrayFieldLength

public int getArrayFieldLength(int index)

Get array field length

Parameters:

index - index of the array

Returns:

array field length

getArrayDimensions

public int getArrayDimensions(int index)

Get array dimensions

Parameters:

index - index of the array

Returns:

array dimensions

getArrayDim

public int[] getArrayDim(int index)

Returns the number of elements in each dimension of the array

Parameters:

index - index of the array

Returns:

array of sdds array dimensions

setArrayDim

public void setArrayDim(int index,
                        int[] dim)

Returns the number of elements in each dimension of the array

Parameters:

index - index of the array

dim - array of sdds array dimensions

Returns:

array of sdds array dimensions

getParameterDescriptions

public java.lang.String[] getParameterDescriptions()

Get parameter descriptions

Returns:

string array of parameter descriptions

getParameterDescription

public java.lang.String getParameterDescription(int index)

Get parameter description

Parameters:

index - index of the parameter

Returns:

parameter description

getArrayDescriptions

public java.lang.String[] getArrayDescriptions()

Get array descriptions

Returns:

string array of array descriptions

getArrayDescription

public java.lang.String getArrayDescription(int index)

Get array description

Parameters:

index - index of the array

Returns:

array description

getColumnDescriptions

public java.lang.String[] getColumnDescriptions()

Get column descriptions

Returns:

string array of column descriptions

getColumnDescription

public java.lang.String getColumnDescription(int index)

Get column description

Parameters:

index - index of the column

Returns:

column description

getParameterFixedValue

public java.lang.String getParameterFixedValue(int index)

Get parameter fixed value

Parameters:

index - index of the parameter

Returns:

parameter's fixed value

getColumnValues

public java.lang.Object[] getColumnValues(int index,
                                          int page,
                                          boolean string_quotes)

Get the values of the column for a chosen page

Parameters:

index - index of the column

string_quotes - true if quotes are to be added around strings
false if raw strings are to be outputed.

page - the page of the column, must be greater then 0

Returns:

Object array of data

getArrayValues

public java.lang.Object[] getArrayValues(int index,
                                         int page,
                                         boolean string_quotes)

Get the values of the array for a chosen page

Parameters:

index - index of the array

string_quotes - true if quotes are to be added around strings
false if raw strings are to be outputed.

page - the page of the array, must be greater then 0

Returns:

Object array of data

getParameterValue

public java.lang.Object getParameterValue(int index,
                                          int page,
                                          boolean string_quotes)

Get the value of the parameter for a chosen page

Parameters:

index - index of the parameter

string_quotes - true if quotes are to be added around strings
false if raw strings are to be outputed.

page - the page of the parameter, must be greater then 0

Returns:

Object containing parameter data

defineParameter

public int defineParameter(java.lang.String name,
                           java.lang.String symbol,
                           java.lang.String units,
                           java.lang.String description,
                           java.lang.String format_string,
                           int type,
                           java.lang.String fixed_value)

Creates a new parameter with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

fixed_value - may be null

Returns:

index of the parameter
-1 if an error occurs

defineParameter

public int defineParameter(java.lang.String name,
                           java.lang.String symbol,
                           java.lang.String units,
                           java.lang.String description,
                           java.lang.String format_string,
                           java.lang.String type,
                           java.lang.String fixed_value)

Creates a new parameter with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

type - valid values are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

fixed_value - may be null

Returns:

index of the parameter
-1 if an error occurs

defineParameter

public int defineParameter(java.lang.String name,
                           int type)

Creates a new parameter with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

Returns:

index of the parameter
-1 if an error occurs

defineParameter

public int defineParameter(java.lang.String name,
                           java.lang.String type)

Creates a new parameter with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

Returns:

index of the parameter
-1 if an error occurs

defineParameters

public boolean defineParameters(java.lang.String[] names,
                                java.lang.String[] symbols,
                                java.lang.String[] units,
                                java.lang.String[] descriptions,
                                java.lang.String[] format_strings,
                                int[] types,
                                java.lang.String[] fixed_values)

Creates new parameters with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

fixed_values - elements may be null

Returns:

true if successful
false if an error occurs

defineParameters

public boolean defineParameters(java.lang.String[] names,
                                java.lang.String[] symbols,
                                java.lang.String[] units,
                                java.lang.String[] descriptions,
                                java.lang.String[] format_strings,
                                java.lang.String[] types,
                                java.lang.String[] fixed_values)

Creates new parameters with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

fixed_values - elements may be null

Returns:

true if successful
false if an error occurs

defineParameters

public boolean defineParameters(java.lang.String[] names,
                                int[] types)

Creates new parameters with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

Returns:

true if successful
false if an error occurs

defineParameters

public boolean defineParameters(java.lang.String[] names,
                                java.lang.String[] types)

Creates new parameters with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

Returns:

true if successful
false if an error occurs

defineArray

public int defineArray(java.lang.String name,
                       java.lang.String symbol,
                       java.lang.String units,
                       java.lang.String description,
                       java.lang.String format_string,
                       java.lang.String group_name,
                       int type,
                       int field_length,
                       int dimensions)

Creates a new array with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

group_name - may be null

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

field_length - has no effect currently

dimensions - integer

Returns:

-1 if error occurs
index of the array

defineArray

public int defineArray(java.lang.String name,
                       java.lang.String symbol,
                       java.lang.String units,
                       java.lang.String description,
                       java.lang.String format_string,
                       java.lang.String group_name,
                       java.lang.String type,
                       int field_length,
                       int dimensions)

Creates a new array with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

group_name - may be null

type - valid values are:

• "double" for double
• "float" for float
• "long" for long
• "short" for short
• "string" for string
• "character" for character

field_length - has no effect currently

dimensions - integer

Returns:

index of the array
-1 if an error occurs

defineArray

public int defineArray(java.lang.String name,
                       int type,
                       int dimensions)

Creates a new array with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• "double" for double
• "float" for float
• "long" for long
• "short" for short
• "string" for string
• "character" for character

dimensions - integer

Returns:

index of the array
-1 if an error occurs

defineArray

public int defineArray(java.lang.String name,
                       java.lang.String type,
                       int dimensions)

Creates a new array with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

dimensions - integer

Returns:

index of the array
-1 if an error occurs

defineArrays

public boolean defineArrays(java.lang.String[] names,
                            java.lang.String[] symbols,
                            java.lang.String[] units,
                            java.lang.String[] descriptions,
                            java.lang.String[] format_strings,
                            java.lang.String[] group_names,
                            int[] types,
                            int[] field_lengths,
                            int[] dimensions)

Creates new arrays with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

group_names - elements may be null

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

field_lengths - elements have no effect currently

dimensions - integer elements

Returns:

true if successful
false if an error occurs

defineArrays

public boolean defineArrays(java.lang.String[] names,
                            java.lang.String[] symbols,
                            java.lang.String[] units,
                            java.lang.String[] descriptions,
                            java.lang.String[] format_strings,
                            java.lang.String[] group_names,
                            java.lang.String[] types,
                            int[] field_lengths,
                            int[] dimensions)

Creates new arrays with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

group_names - elements may be null

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

field_lengths - elements have no effect currently

dimensions - integer elements

Returns:

true if successful
false if an error occurs

defineArrays

public boolean defineArrays(java.lang.String[] names,
                            int[] types,
                            int[] dimensions)

Creates new arrays with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

dimensions - integer elements

Returns:

true if successful
false if an error occurs

defineArrays

public boolean defineArrays(java.lang.String[] names,
                            java.lang.String[] types,
                            int[] dimensions)

Creates new arrays with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

dimensions - integer elements

Returns:

true if successful
false if an error occurs

defineColumn

public int defineColumn(java.lang.String name,
                        java.lang.String symbol,
                        java.lang.String units,
                        java.lang.String description,
                        java.lang.String format_string,
                        int type,
                        int field_length)

Creates a new column with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

field_length - has no effect currently

Returns:

index of the column
-1 if an error occurs

defineColumn

public int defineColumn(java.lang.String name,
                        java.lang.String symbol,
                        java.lang.String units,
                        java.lang.String description,
                        java.lang.String format_string,
                        java.lang.String type,
                        int field_length)

Creates a new column with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

symbol - may be null

units - may be null

description - may be null

format_string - may be null

type - valid values are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

field_length - has no effect currently

Returns:

index of the column
-1 if an error occurs

defineColumn

public int defineColumn(java.lang.String name,
                        int type)

Creates a new column with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

Returns:

index of the column
-1 if an error occurs

defineColumn

public int defineColumn(java.lang.String name,
                        java.lang.String type)

Creates a new column with the specified settings.

Parameters:

name - should be a valid name as defined by SDDSUtil.isValidName

type - valid values are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

Returns:

index of the column
-1 if an error occurs

defineColumns

public boolean defineColumns(java.lang.String[] names,
                             java.lang.String[] symbols,
                             java.lang.String[] units,
                             java.lang.String[] descriptions,
                             java.lang.String[] format_strings,
                             int[] types,
                             int[] field_lengths)

Creates new columns with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

fixed_values - has no effect currently

Returns:

true if successful
false if an error occurs

defineColumns

public boolean defineColumns(java.lang.String[] names,
                             java.lang.String[] symbols,
                             java.lang.String[] units,
                             java.lang.String[] descriptions,
                             java.lang.String[] format_strings,
                             java.lang.String[] types,
                             int[] field_lengths)

Creates new columns with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

symbols - elements may be null

units - elements may be null

descriptions - elements may be null

format_strings - elements may be null

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

fixed_values - has no effect currently

Returns:

true if successful
false if an error occurs

defineColumns

public boolean defineColumns(java.lang.String[] names,
                             int[] types)

Creates new columns with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• 1 for double
• 2 for float
• 3 for long
• 4 for short
• 5 for string
• 6 for character

Returns:

true if successful
false if an error occurs

defineColumns

public boolean defineColumns(java.lang.String[] names,
                             java.lang.String[] types)

Creates new columns with the specified settings.

Parameters:

names - should be an array with valid names as defined by SDDSUtil.isValidName

types - valid values or the elements are:

• "double"
• "float"
• "long"
• "short"
• "string"
• "character"

Returns:

true if successful
false if an error occurs

getParameterIndex

public int getParameterIndex(java.lang.String name)

Return the index of the specified parameter.

Parameters:

name - name of an existing parameter

Returns:

index of parameter
-1 if the parameter does not exist

getParameterIndexes

public int[] getParameterIndexes(java.lang.String[] names)

Return the indexes of the specified parameter.

Parameters:

names - names of an existing parameters

Returns:

indexes of parameters
elements may contain -1 if the parameter does not exist

getArrayIndex

public int getArrayIndex(java.lang.String name)

Return the index of the specified array.

Parameters:

name - name of an existing array

Returns:

index of array
-1 if the array does not exist

getArrayIndexes

public int[] getArrayIndexes(java.lang.String[] names)

Return the indexes of the specified arrays.

Parameters:

names - names of an existing arrays

Returns:

indexes of arrays
elements may contain -1 if the array does not exist

getColumnIndex

public int getColumnIndex(java.lang.String name)

Return the index of the specified column.

Parameters:

name - name of an existing column

Returns:

index of column
-1 if the column does not exist

getColumnIndexes

public int[] getColumnIndexes(java.lang.String[] names)

Return the indexes of the specified columns.

Parameters:

names - names of an existing columns

Returns:

indexes of columns
elements may contain -1 if the column does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            short[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            short[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            int[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            int[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            long[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            long[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            float[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            float[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            double[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            double[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            java.lang.String[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            java.lang.String[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            char[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

name - name of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            char[] values,
                            int startPage)

Set the values of the parameter starting from the specified page.

Parameters:

parameterIndex - index of an existing parameter

values - array of values

startPage - page to start setting values

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            short value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            short value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            int value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            int value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            long value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            long value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            float value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            float value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            double value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            double value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            java.lang.String value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            java.lang.String value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(java.lang.String name,
                            char value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

name - name of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameter

public boolean setParameter(int parameterIndex,
                            char value,
                            int page)

Set the value of the parameter at the specified page.

Parameters:

parameterIndex - index of an existing parameter

value - value to be set

page - page to set value

Returns:

true if successful false if index does not exist

setParameters

public boolean setParameters(java.lang.String[] names,
                             short[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             short[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             int[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             int[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             long[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             long[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             float[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             float[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             double[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             double[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             java.lang.String[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             java.lang.String[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             char[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

names - names of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             char[] values,
                             int page)

Set the values of the parameters at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - array of values to be set

page - page to set values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             short[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             short[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             int[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             int[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             long[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             long[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             float[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             float[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             double[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             double[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             java.lang.String[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             java.lang.String[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(java.lang.String[] names,
                             char[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

names - names of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setParameters

public boolean setParameters(int[] parameterIndexes,
                             char[][] values,
                             int startPage)

Set the values of the parameters starting at the specified page.

Parameters:

parameterIndexes - indexes of an existing parameters

values - two dimensional array of values to be set

startPage - page to start setting the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        short[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        short[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        int[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        int[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        long[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        long[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        float[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        float[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        double[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        double[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        java.lang.String[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        java.lang.String[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(java.lang.String name,
                        char[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setArray

public boolean setArray(int arrayIndex,
                        char[] values,
                        int page)

Set the values of the array at the specified page.

Parameters:

name - name of an existing array

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         short[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         short[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         short[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         short[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         int[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         int[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         int[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         int[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         long[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         long[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         long[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         long[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         float[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         float[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         float[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         float[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         double[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         double[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         double[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         double[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         java.lang.String[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         java.lang.String[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         java.lang.String[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         java.lang.String[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         char[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(java.lang.String name,
                         char[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

name - name of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         char[] values,
                         int page)

Set the values of the column at the specified page.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

Returns:

true if successful false if an error occurs

setColumn

public boolean setColumn(int columnIndex,
                         char[] values,
                         int page,
                         int startRow)

Set the values of the column at the specified page starting at the specified row.

Parameters:

columnIndex - index of an existing column

values - array of values to be set

page - page to set the values

startRow - row to start setting the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                short value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                short value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                int value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                int value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                long value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                long value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                float value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                float value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                double value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                double value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                java.lang.String value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                java.lang.String value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(java.lang.String name,
                                char value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

name - name of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

setColumnElement

public boolean setColumnElement(int columnIndex,
                                char value,
                                int page,
                                int row)

Set the value of the column element at the specified page and row.

Parameters:

columIndex - index of an existing column

value - value to be set

page - page to set the values

row - row to set the values

Returns:

true if successful false if an error occurs

writeLayout

public boolean writeLayout()

Write the layout to a file.

Returns:

true if the layout was successfully written
false if an error occured

writeDescription

public boolean writeDescription()

Write the description to a file.

Returns:

true if the description was successfully written
false if an error occured

writeParameterHeaders

public boolean writeParameterHeaders()

Write the parameter headers to a file.

Returns:

true if the headers were successfully written
false if an error occured

writeParameterHeader

public boolean writeParameterHeader(int index)

Write the specified parameter header to a file.

Parameters:

index - index of an existing parameter

Returns:

true if the header was successfully written
false if an error occured

writeArrayHeaders

public boolean writeArrayHeaders()

Write the array headers to a file.

Returns:

true if the headers were successfully written
false if an error occurred

writeArrayHeader

public boolean writeArrayHeader(int index)

Write the specified array header to a file.

Parameters:

index - index of an existing array

Returns:

true if the header was successfully written
false if an error occured

writeColumnHeaders

public boolean writeColumnHeaders()

Write the column headers to a file.

Returns:

true if the headers were successfully written
false if an error occured

writeColumnHeader

public boolean writeColumnHeader(int index)

Write the specified column header to a file.

Parameters:

index - index of an existing column

Returns:

true if the header was successfully written
false if an error occured

writePages

public boolean writePages()

Write all the pages to a file.

Returns:

true if successful
false if an error occurs

pageCount

public int pageCount()

Get the number of pages in the SDDS object

Returns:

number of pages

writePages

public boolean writePages(int startPage,
                          int endPage)

Write specified the pages to a file.

Parameters:

startPage - first page to write

endPage - last page to write

Returns:

true if successful
false if an error occurs

deleteRow

public void deleteRow(int page,
                      int row)

Deletes the value of the column at a chosen page and at a chosen row

Parameters:

page - the page of the column, must be greater then 0

row - the row of the column, must be greater then 0

getRowCount

public int getRowCount(int page)

Get the number of rows on a page.

Parameters:

page - page of sdds file

Returns:

number of rows on the specified page

writePage

public boolean writePage(int page)

Write specified the page to a file.

Parameters:

page - page to write

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                java.lang.String v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                java.lang.String v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                char v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                char v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                double v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                double v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                float v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                float v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                long v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                long v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(int column,
                                short v)

add a single element to a column of data

Parameters:

column - Column number (first column is 1)

v - value to add to the column

Returns:

true if successful
false if an error occurs

addColumnElement

public boolean addColumnElement(java.lang.String name,
                                short v)

add a single element to a column of data

Parameters:

column - Column name

v - value to add to the column

Returns:

true if successful
false if an error occurs

writeRow

public boolean writeRow()

Write a new row of column data. Will write the latest data added to each column.

Returns:

true if successful
false if an error occurs

setError

public void setError(java.lang.String error_text)

Append to the error description array.

Parameters:

error_text - error message

getErrors

public java.lang.String getErrors()

Return all the error messages.

printErrors

public void printErrors()

Print the error messages to standard error.