Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
C
- canImport(DataFlavor) - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- canStream() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- CFORMAT_INFO - Static variable in class uk.ac.starlink.ecsv.EcsvStarTable
-
Metadata for ECSV format item.
- close() - Method in class uk.ac.starlink.ecsv.EcsvReader
- close() - Method in class uk.ac.starlink.ecsv.LineReader
- COMMA_WRITER - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Instance using commas for delimiters.
- createArrayLineReader(String[]) - Static method in class uk.ac.starlink.ecsv.LineReader
-
Returns a LineReader instance that reads lines from an array.
- createAsciiLineReader(InputStream) - Static method in class uk.ac.starlink.ecsv.LineReader
-
Returns a LineReader instance that just uses the lower 7 bits of each input byte for character values.
- createDecoder(String, String) - Static method in class uk.ac.starlink.ecsv.EcsvDecoder
-
Returns an instance of this class given a datatype and optional subtype.
- createEncoder(ColumnInfo, char) - Static method in class uk.ac.starlink.ecsv.EcsvEncoder
-
Returns an encoder suitable for encoding data from a column with given metadata.
- createTable(String) - Method in class uk.ac.starlink.table.TestTableScheme
D
- decode(String) - Method in class uk.ac.starlink.ecsv.EcsvDecoder
-
Attempts to decode the supplied string to a value of this decoder's type.
- docIncludesExample() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- docIncludesExample() - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
E
- EcsvColumn<T> - Interface in uk.ac.starlink.ecsv
-
Represents column metadata from an ECSV table.
- EcsvDecoder<T> - Class in uk.ac.starlink.ecsv
-
Decodes values in the body of an ECSV file for a given data type.
- EcsvDecoder(Class<T>, int[], String) - Constructor for class uk.ac.starlink.ecsv.EcsvDecoder
-
Constructor.
- EcsvEncoder - Class in uk.ac.starlink.ecsv
-
Converts values for a given column into strings suitable for inclusion in the body of an ECSV file.
- EcsvEncoder(String, String) - Constructor for class uk.ac.starlink.ecsv.EcsvEncoder
-
Constructor.
- EcsvFormatException - Exception Class in uk.ac.starlink.ecsv
-
Exception thrown if an attempt to read an ECSV file fails because the input does not appear to conform to the ECSV format.
- EcsvFormatException(String) - Constructor for exception class uk.ac.starlink.ecsv.EcsvFormatException
-
Constructs an exception with a given message.
- EcsvFormatException(String, Throwable) - Constructor for exception class uk.ac.starlink.ecsv.EcsvFormatException
-
Constructs an exception with a given message and cause.
- EcsvHeader - Class in uk.ac.starlink.ecsv
-
Represents the part of an ECSV file preceding the actual data lines.
- EcsvHeader(String[], String) - Constructor for class uk.ac.starlink.ecsv.EcsvHeader
-
Constructor.
- EcsvMeta - Interface in uk.ac.starlink.ecsv
-
Metadata structure read from an ECSV file.
- EcsvReader - Class in uk.ac.starlink.ecsv
-
Parser for the metadata and data of an ECSV file.
- EcsvReader(InputStream, YamlParser, MessagePolicy) - Constructor for class uk.ac.starlink.ecsv.EcsvReader
-
Constructor.
- EcsvStarTable - Class in uk.ac.starlink.ecsv
-
Partial StarTable implementation for ECSV tables.
- EcsvStarTable(EcsvMeta) - Constructor for class uk.ac.starlink.ecsv.EcsvStarTable
-
Constructor.
- EcsvTableBuilder - Class in uk.ac.starlink.ecsv
-
TableBuilder implementation for ECSV tables.
- EcsvTableBuilder() - Constructor for class uk.ac.starlink.ecsv.EcsvTableBuilder
-
Constructor.
- EcsvTableWriter - Class in uk.ac.starlink.ecsv
-
TableWriter for ECSV output format.
- EcsvTableWriter() - Constructor for class uk.ac.starlink.ecsv.EcsvTableWriter
-
Constructs a writer with default characteristics.
- EcsvTableWriter(char, String) - Constructor for class uk.ac.starlink.ecsv.EcsvTableWriter
-
Constructs a writer with a given delimiter character.
- encode(Object) - Method in class uk.ac.starlink.ecsv.EcsvEncoder
-
Formats a value of this encoder's datatype for insertion into the body of an ECSV file.
F
- FAIL - Enum constant in enum class uk.ac.starlink.ecsv.MessagePolicy
-
Throws an IOException.
G
- getCell(int) - Method in class uk.ac.starlink.ecsv.EcsvReader
-
Returns the contents of a cell in the current row.
- getColcheck() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
-
Returns the column checking message policy.
- getColumnCount() - Method in class uk.ac.starlink.ecsv.EcsvStarTable
- getColumnInfo(int) - Method in class uk.ac.starlink.ecsv.EcsvStarTable
- getColumns() - Method in interface uk.ac.starlink.ecsv.EcsvMeta
-
Returns an array of column metadata items for the columns in the table.
- getContentClass() - Method in class uk.ac.starlink.ecsv.EcsvDecoder
-
Returns the class to which input values will be decoded.
- getDatatype() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns the declared datatype for this column.
- getDatatype() - Method in class uk.ac.starlink.ecsv.EcsvEncoder
-
Returns the ECSV datatype handled by this encoder.
- getDecoder() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns a decoder that can be used to make sense of cell values in the body of the ECSV file corresponding to this column.
- getDelimiter() - Method in interface uk.ac.starlink.ecsv.EcsvMeta
-
Returns the delimiter character used for this file.
- getDelimiter() - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Returns the delimiter character, either a space or a comma.
- getDescription() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns the column description text if available.
- getExampleSpecification() - Method in class uk.ac.starlink.table.TestTableScheme
- getFormat() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns the column format string if available.
- getFormatName() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- getFormatName() - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
- getHeader() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
-
Returns the location of a header file which will be prepended to any file read by this handler.
- getMeta() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns a map containing miscellaneous metadata declared for this column, if available.
- getMeta() - Method in class uk.ac.starlink.ecsv.EcsvReader
-
Returns the ECSV metadata object used by this reader.
- getMimeType() - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Returns "text/plain".
- getName() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns the column name.
- getNamesLine() - Method in class uk.ac.starlink.ecsv.EcsvHeader
-
Returns the CSV-formatted line supposed to contain column names.
- getRow() - Method in class uk.ac.starlink.ecsv.EcsvReader
-
Returns the contents of the current row, as an array with one element per column.
- getRowCount() - Method in class uk.ac.starlink.ecsv.EcsvStarTable
- getSchema() - Method in interface uk.ac.starlink.ecsv.EcsvMeta
-
Returns the schema string if present.
- getSchemeName() - Method in class uk.ac.starlink.table.TestTableScheme
- getSchemeUsage() - Method in class uk.ac.starlink.table.TestTableScheme
- getShape() - Method in class uk.ac.starlink.ecsv.EcsvDecoder
-
Returns the shape of the object that is decoded, in STIL format.
- getSubtype() - Method in class uk.ac.starlink.ecsv.EcsvEncoder
-
Returns the ECSV subtype for this decoder.
- getTableMeta() - Method in interface uk.ac.starlink.ecsv.EcsvMeta
-
Returns a structure giving per-table metadata, as read from the ECSV header.
- getUnit() - Method in interface uk.ac.starlink.ecsv.EcsvColumn
-
Returns the column unit string if available.
- getWarning() - Method in class uk.ac.starlink.ecsv.EcsvDecoder
-
Returns any warning message concerning the behaviour of this decoder.
- getXmlDescription() - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- getXmlDescription() - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
- getXmlDescription() - Method in class uk.ac.starlink.table.TestTableScheme
- getYamlLines() - Method in class uk.ac.starlink.ecsv.EcsvHeader
-
Returns the lines of YAML containing header information.
I
- IGNORE - Enum constant in enum class uk.ac.starlink.ecsv.MessagePolicy
-
Does nothing.
- isMagic(byte[]) - Static method in class uk.ac.starlink.ecsv.EcsvHeader
-
Indicates whether a byte sequence indicates the start of an ECSV file.
L
- LineReader - Class in uk.ac.starlink.ecsv
-
Reads lines of text from an input stream.
- LineReader(InputStream) - Constructor for class uk.ac.starlink.ecsv.LineReader
-
Constructor.
M
- makeStarTable(DataSource, boolean, StoragePolicy) - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- MessagePolicy - Enum Class in uk.ac.starlink.ecsv
-
Defines how to deliver a message to the user.
N
- next() - Method in class uk.ac.starlink.ecsv.EcsvReader
-
Attempts to advance the current row to the next one.
P
- parseMeta(String[]) - Method in class uk.ac.starlink.ecsv.SnakeYamlParser
- parseMeta(String[]) - Method in interface uk.ac.starlink.ecsv.YamlParser
-
Extracts ECSV header information from lines of YAML.
Q
- quoteString(String, char) - Static method in class uk.ac.starlink.ecsv.EcsvEncoder
-
Returns a suitably escaped value of a string, ensuring that no ECSV control characters are present in the result.
R
- readHeader(LineReader) - Static method in class uk.ac.starlink.ecsv.EcsvHeader
-
Constructs an EcsvHeader instance by reading lines from a file.
- readLine() - Method in class uk.ac.starlink.ecsv.LineReader
-
Returns the next non-empty line of text from the input stream.
S
- setColcheck(MessagePolicy) - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
- setDelimiter(String) - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Sets the delimiter.
- setHeader(String) - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
-
Sets the location of a header file which will be prepended to any file read by this handler.
- SnakeYamlParser - Class in uk.ac.starlink.ecsv
-
YamlParser implementation based on the SnakeYAML library
- SnakeYamlParser() - Constructor for class uk.ac.starlink.ecsv.SnakeYamlParser
- SPACE_WRITER - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Instance using spaces for delimiters.
- streamStarTable(InputStream, TableSink, String) - Method in class uk.ac.starlink.ecsv.EcsvTableBuilder
T
- TABLENAME_METAKEY - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Meta map key for table name string value.
- TestTableScheme - Class in uk.ac.starlink.table
-
TableScheme implementation for test data.
- TestTableScheme() - Constructor for class uk.ac.starlink.table.TestTableScheme
U
- UCD_METAKEY - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Meta map key for UCD string value.
- uk.ac.starlink.ecsv - package uk.ac.starlink.ecsv
- uk.ac.starlink.table - package uk.ac.starlink.table
- UTYPE_METAKEY - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Meta map key for Utype string value.
V
- valueOf(String) - Static method in enum class uk.ac.starlink.ecsv.MessagePolicy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class uk.ac.starlink.ecsv.MessagePolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARN - Enum constant in enum class uk.ac.starlink.ecsv.MessagePolicy
-
Logs through logging system as a WARNING.
- writeStarTable(StarTable, OutputStream) - Method in class uk.ac.starlink.ecsv.EcsvTableWriter
X
- XTYPE_METAKEY - Static variable in class uk.ac.starlink.ecsv.EcsvTableWriter
-
Meta map key for Xtype string value.
Y
- YamlParser - Interface in uk.ac.starlink.ecsv
-
Defines an object that can extract ECSV header information from YAML.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form