org.icij.spewer

Class Spewer

java.lang.Object

org.icij.spewer.Spewer

All Implemented Interfaces:

Serializable, AutoCloseable

Direct Known Subclasses:

FileSpewer, PrintStreamSpewer, RESTSpewer

public abstract class Spewer
extends Object
implements AutoCloseable, Serializable

Base class for Spewer superclasses that write text output from a ParsingReader to specific endpoints.

Since:

1.0.0-beta

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Spewer.MapValueConsumer
protected static class	Spewer.MapValuesConsumer

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldNames	fields
protected boolean	outputMetadata
protected Map<String,String>	tags

Constructor Summary

Constructors

Constructor and Description
Spewer()
Spewer(FieldNames fields)

Method Summary

Modifier and Type	Method and Description
void	close()
Spewer	configure(Options<String> options)
protected void	copy(Reader input, OutputStream output)
static void	copy(Reader input, Writer output)
FieldNames	getFields()
protected Map<String,Object>	getMetadata(TikaDocument document)
Charset	getOutputEncoding()
boolean	outputMetadata()
void	outputMetadata(boolean outputMetadata)
void	setOutputEncoding(Charset outputEncoding)
void	setTags(Map<String,String> tags)
static String	toString(Reader reader)
TikaDocument[]	write(Path path)
void	write(TikaDocument document, Reader reader)
protected abstract void	writeDocument(TikaDocument doc, Reader reader, TikaDocument parent, TikaDocument root, int level)

Methods inherited from class java.lang.Object

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

Field Detail

outputMetadata

protected boolean outputMetadata

tags

protected final Map<String,String> tags

fields

protected final FieldNames fields

Constructor Detail

Spewer

public Spewer()

Spewer

public Spewer(FieldNames fields)

Method Detail

configure

public Spewer configure(Options<String> options)

writeDocument

protected abstract void writeDocument(TikaDocument doc,
                                      Reader reader,
                                      TikaDocument parent,
                                      TikaDocument root,
                                      int level)
                               throws IOException

Throws:

IOException

write

public void write(TikaDocument document,
                  Reader reader)
           throws IOException

Throws:

IOException

write

public TikaDocument[] write(Path path)
                     throws IOException,
                            ClassNotFoundException

Throws:

IOException

ClassNotFoundException

getFields

public FieldNames getFields()

setOutputEncoding

public void setOutputEncoding(Charset outputEncoding)

getOutputEncoding

public Charset getOutputEncoding()

outputMetadata

public void outputMetadata(boolean outputMetadata)

outputMetadata

public boolean outputMetadata()

setTags

public void setTags(Map<String,String> tags)

copy

protected void copy(Reader input,
                    OutputStream output)
             throws IOException

Throws:

IOException

copy

public static void copy(Reader input,
                        Writer output)
                 throws IOException

Throws:

IOException

toString

public static String toString(Reader reader)
                       throws IOException

Throws:

IOException

getMetadata

protected Map<String,Object> getMetadata(TikaDocument document)
                                  throws IOException

Throws:

IOException

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception