tech.tablesaw.io.fixed.FixedWidthReader Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package tech.tablesaw.io.fixed;
import java.io.IOException;
import java.io.Reader;
import java.util.List;
import javax.annotation.concurrent.Immutable;
import org.apache.commons.math3.util.Pair;
import com.google.common.io.CharStreams;
import com.univocity.parsers.common.AbstractParser;
import com.univocity.parsers.fixed.FixedWidthFormat;
import com.univocity.parsers.fixed.FixedWidthParser;
import com.univocity.parsers.fixed.FixedWidthParserSettings;
import tech.tablesaw.api.ColumnType;
import tech.tablesaw.api.Table;
import tech.tablesaw.io.DataReader;
import tech.tablesaw.io.FileReader;
import tech.tablesaw.io.ReaderRegistry;
import tech.tablesaw.io.Source;
@Immutable
public class FixedWidthReader extends FileReader implements DataReader {
private static final FixedWidthReader INSTANCE = new FixedWidthReader();
static {
register(Table.defaultReaderRegistry);
}
public static void register(ReaderRegistry registry) {
registry.registerOptions(FixedWidthReadOptions.class, INSTANCE);
}
/**
* Constructs a FixedWidthReader
*/
public FixedWidthReader() {
super();
}
/**
* Constructs a FixedWidthReader with the given list of ColumnTypes
*
* These are the only types that the FixedWidthReader can detect and parse
*/
public FixedWidthReader(List typeDetectionList) {
super(typeDetectionList);
}
/**
* Determines column types if not provided by the user
* Reads all input into memory unless File was provided
*/
private Pair getReaderAndColumnTypes(FixedWidthReadOptions options) throws IOException {
ColumnType[] types = options.columnTypes();
byte[] bytesCache = null;
if (types == null) {
Reader reader = options.source().createReader(bytesCache);
if (options.source().file() == null) {
bytesCache = CharStreams.toString(reader).getBytes();
// create a new reader since we just exhausted the existing one
reader = options.source().createReader(bytesCache);
}
types = detectColumnTypes(reader, options);
}
return Pair.create(options.source().createReader(bytesCache), types);
}
public Table read(FixedWidthReadOptions options) throws IOException {
return read(options, false);
}
private Table read(FixedWidthReadOptions options, boolean headerOnly) throws IOException {
Pair pair = getReaderAndColumnTypes(options);
Reader reader = pair.getKey();
ColumnType[] types = pair.getValue();
FixedWidthParser parser = fixedWidthParser(options);
try {
return parseRows(options, headerOnly, reader, types, parser);
} finally {
if (options.source().reader() == null) {
// if we get a reader back from options it means the client opened it, so let the client close it
// if it's null, we close it here.
parser.stopParsing();
reader.close();
}
}
}
/**
* Returns a string representation of the column types in file {@code fixed widthFilename},
* as determined by the type-detection algorithm
*
* This method is intended to help analysts quickly fix any erroneous types, by printing out the types in a format
* such that they can be edited to correct any mistakes, and used in an array literal
*
* For example:
*
* LOCAL_DATE, // 0 date
* SHORT, // 1 approval
* STRING, // 2 who
*
* Note that the types are array separated, and that the index position and the column name are printed such that
* they would be interpreted as comments if you paste the output into an array:
*
*
* @throws IOException if file cannot be read
*/
public String printColumnTypes(FixedWidthReadOptions options) throws IOException {
Table structure = read(options, true).structure();
return getTypeString(structure);
}
/**
* Estimates and returns the type for each column in the delimited text file {@code file}
*
* The type is determined by checking a sample of the data in the file. Because only a sample of the data is
* checked,
* the types may be incorrect. If that is the case a Parse Exception will be thrown.
*
* The method {@code printColumnTypes()} can be used to print a list of the detected columns that can be
* corrected and
* used to explicitly specify the correct column types.
*/
public ColumnType[] detectColumnTypes(Reader reader, FixedWidthReadOptions options) {
boolean header = options.header();
int linesToSkip = header ? 1 : 0;
AbstractParser parser = fixedWidthParser(options);
try {
return getTypes(reader, options, linesToSkip, parser);
} finally {
parser.stopParsing();
// we don't close the reader since we didn't create it
}
}
private FixedWidthParser fixedWidthParser(FixedWidthReadOptions options) {
FixedWidthParserSettings settings = new FixedWidthParserSettings();
if (options.columnSpecs() != null) {
settings = new FixedWidthParserSettings(options.columnSpecs());
}
settings.setFormat(fixedWidthFormat(options));
if (options.skipTrailingCharsUntilNewline()) {
settings.setSkipTrailingCharsUntilNewline(options.skipTrailingCharsUntilNewline());
}
if (options.maxNumberOfColumns() != null) {
settings.setMaxColumns(options.maxNumberOfColumns());
}
if (options.recordEndsOnNewline()) {
settings.setRecordEndsOnNewline(true);
}
return new FixedWidthParser(settings);
}
private FixedWidthFormat fixedWidthFormat(FixedWidthReadOptions options) {
FixedWidthFormat format = new FixedWidthFormat();
if (options.padding() != ' ') {
format.setPadding(options.padding());
}
if (options.lookupWildcard() != '?') {
format.setLookupWildcard(options.lookupWildcard());
}
if (options.lineEnding() != null) {
format.setLineSeparator(options.lineEnding());
}
return format;
}
@Override
public Table read(Source source) throws IOException {
return read(FixedWidthReadOptions.builder(source).build());
}
}