org.canova.api.records.reader.impl.jackson

Class FieldSelection

java.lang.Object

org.canova.api.records.reader.impl.jackson.FieldSelection

public class FieldSelection
extends Object

FieldSelection is used in conjunction with the JacksonRecordReader (and the subclasses). The are a few motivations here:
- Formats such as XML, JSON and YAML can contain arbitrarily nested components, and we need to flatten them somehow
- These formats can vary in terms of order (for example, JSON is unordered), so we need to define the exact order of outputs for the record reader
- In any given JSON/XML/YAML file, there might not be a particular value present (but: we still want it to be represented in the output)
- In any given JSON/XML/YAML file, we might want to totally ignore certain fields

Author:

Alex Black

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldSelection.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Writable	DEFAULT_MISSING_VALUE

Method Summary

Modifier and Type	Method and Description
List<String[]>	getFieldPaths()
int	getNumFields()
List<Writable>	getValueIfMissing()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MISSING_VALUE

public static final Writable DEFAULT_MISSING_VALUE

Method Detail

getFieldPaths

public List<String[]> getFieldPaths()

getValueIfMissing

public List<Writable> getValueIfMissing()

getNumFields

public int getNumFields()