com.mware.ge.csv

Interface Extractor<T>

All Superinterfaces:

Cloneable

All Known Implementing Classes:

Extractors.BooleanExtractor, Extractors.ByteExtractor, Extractors.CharExtractor, Extractors.DateExtractor, Extractors.DateTimeExtractor, Extractors.DoubleExtractor, Extractors.DurationExtractor, Extractors.FloatExtractor, Extractors.IntExtractor, Extractors.LocalDateTimeExtractor, Extractors.LocalTimeExtractor, Extractors.LongExtractor, Extractors.PointExtractor, Extractors.ShortExtractor, Extractors.StringExtractor, Extractors.TimeExtractor

public interface Extractor<T>
extends Cloneable

Extracts a value from a part of a char[] into any type of value, f.ex. a Extractors.string(), long or Extractors.intArray(). An Extractor is mutable for the single purpose of ability to reuse its value instance. Consider extracting a primitive int - Sub-interfaces and implementations can and should specify specific accessors for the purpose of performance and less garbage, f.ex. where an IntExtractor could have an accessor method for getting the extracted value as primitive int, to avoid auto-boxing which would arise from calling value().

See Also:

for a collection of very common extractors.

Method Summary

Modifier and Type	Method and Description
Extractor<T>	clone()
boolean	extract(char[] data, int offset, int length, boolean hadQuotes) Extracts value of type T from the given character data.
boolean	extract(char[] data, int offset, int length, boolean hadQuotes, CSVHeaderInformation optionalData) Extracts value of type T from the given character data.
String	name()
T	value()

Method Detail

extract

boolean extract(char[] data,
                int offset,
                int length,
                boolean hadQuotes,
                CSVHeaderInformation optionalData)

Extracts value of type T from the given character data.

Parameters:

data - characters in a buffer.

offset - offset into the buffer where the value starts.

length - number of characters from the offset to extract.

hadQuotes - whether or not there were skipped characters, f.ex. quotation.

optionalData - optional data to be used for spatial or temporal values or null if csv header did not use it

Returns:

true if a value was extracted, otherwise false.

extract

boolean extract(char[] data,
                int offset,
                int length,
                boolean hadQuotes)

Extracts value of type T from the given character data.

Parameters:

data - characters in a buffer.

offset - offset into the buffer where the value starts.

length - number of characters from the offset to extract.

hadQuotes - whether or not there were skipped characters, f.ex. quotation.

Returns:

true if a value was extracted, otherwise false.

value

T value()

Returns:

the most recently extracted value.

name

String name()

Returns:

string representation of what type of value of produces. Also used as key in Extractors.

clone

Extractor<T> clone()