public class TextLine extends CompressorScheme<java.io.LineNumberReader,java.io.PrintWriter> implements FileFormat
Scheme
for plain text files. Files are broken into
lines. Either line-feed or carriage-return are used to signal end of line.
By default, this scheme returns a Tuple
with two fields, "num" and "line". Where "num"
is the line number for "line".
Many of the constructors take both "sourceFields" and "sinkFields". sourceFields denote the field names
to be used instead of the names "num" and "line". sinkFields is a selector and is by default Fields.ALL
.
Any available field names can be given if only a subset of the incoming fields should be used.
If a Fields
instance is passed on the constructor as sourceFields having only one field, the return tuples
will simply be the "line" value using the given field name.
Note that TextLine will concatenate all the Tuple values for the selected fields with a TAB delimiter before writing out the line.
By default, all text is encoded/decoded as UTF-8. This can be changed via the charsetName
constructor
argument.
In order to read or write a compressed files, pass a CompressorScheme.Compressor
instance to the appropriate constructors. See Compressors
for provided compression algorithms.
TextDelimited
,
Compressors
,
Serialized FormCompressorScheme.Compressor
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_CHARSET |
static Fields |
DEFAULT_SOURCE_FIELDS |
compressor, NO_COMPRESSOR
Constructor and Description |
---|
TextLine()
Creates a new TextLine instance that sources "num" and "line" fields, and sinks all incoming fields, where
"num" is the line number of the line in the input file.
|
TextLine(CompressorScheme.Compressor compressor)
Creates a new TextLine instance that sources "num" and "line" fields, and sinks all incoming fields, where
"num" is the line number of the line in the input file.
|
TextLine(Fields sourceFields)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
CompressorScheme.Compressor compressor)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
CompressorScheme.Compressor compressor,
java.lang.String charsetName)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
Fields sinkFields)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
Fields sinkFields,
CompressorScheme.Compressor compressor)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
Fields sinkFields,
CompressorScheme.Compressor compressor,
java.lang.String charsetName)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
Fields sinkFields,
java.lang.String charsetName)
Creates a new TextLine instance.
|
TextLine(Fields sourceFields,
java.lang.String charsetName)
Creates a new TextLine instance.
|
Modifier and Type | Method and Description |
---|---|
java.io.LineNumberReader |
createInput(java.io.InputStream inputStream) |
java.io.PrintWriter |
createOutput(java.io.OutputStream outputStream) |
java.lang.String |
getCharsetName() |
java.lang.String |
getExtension() |
void |
presentSinkFields(FlowProcess<? extends java.util.Properties> process,
Tap tap,
Fields fields) |
void |
presentSourceFields(FlowProcess<? extends java.util.Properties> process,
Tap tap,
Fields fields) |
protected void |
setCharsetName(java.lang.String charsetName) |
void |
sink(FlowProcess<? extends java.util.Properties> flowProcess,
SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) |
void |
sinkCleanup(FlowProcess<? extends java.util.Properties> flowProcess,
SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) |
void |
sinkConfInit(FlowProcess<? extends java.util.Properties> flowProcess,
Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap,
java.util.Properties conf) |
void |
sinkPrepare(FlowProcess<? extends java.util.Properties> flowProcess,
SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) |
boolean |
source(FlowProcess<? extends java.util.Properties> flowProcess,
SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) |
void |
sourceCleanup(FlowProcess<? extends java.util.Properties> flowProcess,
SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) |
void |
sourceConfInit(FlowProcess<? extends java.util.Properties> flowProcess,
Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap,
java.util.Properties conf) |
void |
sourcePrepare(FlowProcess<? extends java.util.Properties> flowProcess,
SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) |
void |
sourceRePrepare(FlowProcess<? extends java.util.Properties> flowProcess,
SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) |
protected void |
verify(Fields sourceFields) |
setCompressor, sinkWrap, sourceWrap
equals, getNumSinkParts, getSinkFields, getSourceFields, getTrace, hashCode, isSink, isSource, isSymmetrical, presentSinkFieldsInternal, presentSourceFieldsInternal, retrieveSinkFields, retrieveSourceFields, setNumSinkParts, setSinkFields, setSourceFields, toString
public static final java.lang.String DEFAULT_CHARSET
public static final Fields DEFAULT_SOURCE_FIELDS
public TextLine()
@ConstructorProperties(value="sourceFields") public TextLine(Fields sourceFields)
sourceFields
- of Fields@ConstructorProperties(value={"sourceFields","charsetName"}) public TextLine(Fields sourceFields, java.lang.String charsetName)
sourceFields
- of FieldscharsetName
- of type String@ConstructorProperties(value={"sourceFields","sinkFields"}) public TextLine(Fields sourceFields, Fields sinkFields)
sourceFields
- of FieldssinkFields
- of Fields@ConstructorProperties(value={"sourceFields","sinkFields","charsetName"}) public TextLine(Fields sourceFields, Fields sinkFields, java.lang.String charsetName)
sourceFields
- of FieldssinkFields
- of FieldscharsetName
- of type Stringpublic TextLine(CompressorScheme.Compressor compressor)
@ConstructorProperties(value={"sourceFields","compressor"}) public TextLine(Fields sourceFields, CompressorScheme.Compressor compressor)
sourceFields
- of Fieldscompressor
- of type Compressor@ConstructorProperties(value={"sourceFields","compressor","charsetName"}) public TextLine(Fields sourceFields, CompressorScheme.Compressor compressor, java.lang.String charsetName)
sourceFields
- of Fieldscompressor
- of type CompressorcharsetName
- of type String@ConstructorProperties(value={"sourceFields","sinkFields","compressor"}) public TextLine(Fields sourceFields, Fields sinkFields, CompressorScheme.Compressor compressor)
sourceFields
- of FieldssinkFields
- of Fieldscompressor
- of type Compressor@ConstructorProperties(value={"sourceFields","sinkFields","compressor","charsetName"}) public TextLine(Fields sourceFields, Fields sinkFields, CompressorScheme.Compressor compressor, java.lang.String charsetName)
sourceFields
- of FieldssinkFields
- of Fieldscompressor
- of type CompressorcharsetName
- of type Stringprotected void setCharsetName(java.lang.String charsetName)
public java.lang.String getCharsetName()
public java.io.LineNumberReader createInput(java.io.InputStream inputStream)
public java.io.PrintWriter createOutput(java.io.OutputStream outputStream)
public void presentSourceFields(FlowProcess<? extends java.util.Properties> process, Tap tap, Fields fields)
presentSourceFields
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
public void presentSinkFields(FlowProcess<? extends java.util.Properties> process, Tap tap, Fields fields)
presentSinkFields
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
public void sourceConfInit(FlowProcess<? extends java.util.Properties> flowProcess, Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap, java.util.Properties conf)
sourceConfInit
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
public void sinkConfInit(FlowProcess<? extends java.util.Properties> flowProcess, Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap, java.util.Properties conf)
sinkConfInit
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
public void sourcePrepare(FlowProcess<? extends java.util.Properties> flowProcess, SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) throws java.io.IOException
sourcePrepare
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
java.io.IOException
public void sourceRePrepare(FlowProcess<? extends java.util.Properties> flowProcess, SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) throws java.io.IOException
sourceRePrepare
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
java.io.IOException
public boolean source(FlowProcess<? extends java.util.Properties> flowProcess, SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) throws java.io.IOException
public void sourceCleanup(FlowProcess<? extends java.util.Properties> flowProcess, SourceCall<java.io.LineNumberReader,java.io.InputStream> sourceCall) throws java.io.IOException
sourceCleanup
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
java.io.IOException
public void sinkPrepare(FlowProcess<? extends java.util.Properties> flowProcess, SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) throws java.io.IOException
sinkPrepare
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
java.io.IOException
public void sink(FlowProcess<? extends java.util.Properties> flowProcess, SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) throws java.io.IOException
public void sinkCleanup(FlowProcess<? extends java.util.Properties> flowProcess, SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall) throws java.io.IOException
sinkCleanup
in class Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>
java.io.IOException
public java.lang.String getExtension()
getExtension
in interface FileFormat
Copyright © 2007-2017 Cascading Maintainers. All Rights Reserved.