org.neo4j.csv.reader

Class Extractors

java.lang.Object

org.neo4j.csv.reader.Extractors

public class Extractors
extends Object

Common implementations of Extractor. Since array values can have a delimiter of user choice that isn't an enum, but a regular class with a constructor where that delimiter can be specified. The common extractors can be accessed using the accessor methods, like string(), long_() and others. Specific classes are declared as return types for those providing additional value accessors, f.ex Extractors.LongExtractor.longValue(). Typically an instance of Extractors would be instantiated along side a BufferedCharSeeker, assumed to be used by a single thread, since each Extractor it has is stateful. Example:

 CharSeeker seeker = ...
 Mark mark = new Mark();
 Extractors extractors = new Extractors( ';' );

 // ... seek a value, then extract like this
 int boxFreeIntValue = seeker.extract( mark, extractors.int_() ).intValue();
 // ... or using any other type of extractor.
 

Custom extractors can also be implemented and used, if need arises:

 CharSeeker seeker = ...
 Mark mark = new Mark();
 MyStringDateToLongExtractor dateExtractor = new MyStringDateToLongExtractor();

 // ... seek a value, then extract like this
 long timestamp = seeker.extract( mark, dateExtractor ).dateAsMillis();
 

... even added to an Extractors instance, where its toString value is used as key for lookup in valueOf(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Extractors.BooleanExtractor
static class	Extractors.ByteExtractor
static class	Extractors.CharExtractor
static class	Extractors.DoubleExtractor
static class	Extractors.FloatExtractor
static class	Extractors.IntExtractor
static class	Extractors.LongExtractor
static class	Extractors.ShortExtractor
static class	Extractors.StringExtractor

Constructor Summary

Constructors

Constructor and Description
Extractors(char arrayDelimiter)
Extractors(char arrayDelimiter, boolean emptyStringsAsNull)
Extractors(char arrayDelimiter, boolean emptyStringsAsNull, boolean trimStrings) Why do we have a public constructor here and why isn't this class an enum? It's because the array extractors can be configured with an array delimiter, something that would be impossible otherwise.

Method Summary

Modifier and Type	Method and Description
void	add(Extractor<?> extractor)
Extractors.BooleanExtractor	boolean_()
Extractor<boolean[]>	booleanArray()
Extractors.ByteExtractor	byte_()
Extractor<byte[]>	byteArray()
Extractors.CharExtractor	char_()
Extractors.DoubleExtractor	double_()
Extractor<double[]>	doubleArray()
Extractors.FloatExtractor	float_()
Extractor<float[]>	floatArray()
Extractors.IntExtractor	int_()
Extractor<int[]>	intArray()
Extractors.LongExtractor	long_()
Extractor<long[]>	longArray()
Extractors.ShortExtractor	short_()
Extractor<short[]>	shortArray()
Extractor<String>	string()
Extractor<String[]>	stringArray()
Extractor<?>	valueOf(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Extractors

public Extractors(char arrayDelimiter)

Extractors

public Extractors(char arrayDelimiter,
                  boolean emptyStringsAsNull)

Extractors

public Extractors(char arrayDelimiter,
                  boolean emptyStringsAsNull,
                  boolean trimStrings)

Why do we have a public constructor here and why isn't this class an enum? It's because the array extractors can be configured with an array delimiter, something that would be impossible otherwise. There's an equivalent valueOf(String) method to keep the feel of an enum.

Method Detail

add

public void add(Extractor<?> extractor)

valueOf

public Extractor<?> valueOf(String name)

string

public Extractor<String> string()

long_

public Extractors.LongExtractor long_()

int_

public Extractors.IntExtractor int_()

char_

public Extractors.CharExtractor char_()

short_

public Extractors.ShortExtractor short_()

byte_

public Extractors.ByteExtractor byte_()

boolean_

public Extractors.BooleanExtractor boolean_()

float_

public Extractors.FloatExtractor float_()

double_

public Extractors.DoubleExtractor double_()

stringArray

public Extractor<String[]> stringArray()

booleanArray

public Extractor<boolean[]> booleanArray()

byteArray

public Extractor<byte[]> byteArray()

shortArray

public Extractor<short[]> shortArray()

intArray

public Extractor<int[]> intArray()

longArray

public Extractor<long[]> longArray()

floatArray

public Extractor<float[]> floatArray()

doubleArray

public Extractor<double[]> doubleArray()