org.aksw.gerbil.io.nif

Interface NIFWriter

All Known Implementing Classes:

AbstractNIFWriter, TurtleNIFWriter

public interface NIFWriter

This interface defines a NIFWriter - a class that should write NIF data from a given list of Document instances.

Author:

Michael Röder (roeder@informatik.uni-leipzig.de)

Method Summary

Modifier and Type	Method and Description
DocumentListWriter	getDocumentListWriter() Returns the DocumentListWriter used by this parser.
String	getHttpContentType() This method should return the HTTP content type string for the data that is created by this writer.
void	setDocumentListWriter(DocumentListWriter listWriter) Sets the DocumentListWriter used by this parser.
String	writeNIF(List<Document> document) Writes the given lost of Document instances as NIF data to a String.
void	writeNIF(List<Document> document, OutputStream os) Writes the given lost of Document instances as NIF data to the given OutputStream.
void	writeNIF(List<Document> document, Writer writer) Writes the given lost of Document instances as NIF data to the given Writer.

Method Detail

writeNIF

String writeNIF(List<Document> document)

Writes the given lost of Document instances as NIF data to a String.

Parameters:

document - the list of Document instances that should be written as NIF data

Returns:

the String containing the NIF data

writeNIF

void writeNIF(List<Document> document,
              Writer writer)

Writes the given lost of Document instances as NIF data to the given Writer.

Note that following the recommendations of the Jena framework we highly recommend to use writeNIF(List, OutputStream) instead of using a Writer since the OutputStream is not relying on a specific encoding.

Parameters:

document - the list of Document instances that should be written as NIF data

writer - the Writer to which the NIF data should be written

writeNIF

void writeNIF(List<Document> document,
              OutputStream os)

Writes the given lost of Document instances as NIF data to the given OutputStream.

Parameters:

document - the list of Document instances that should be written as NIF data

os - the OutputStream to which the NIF data should be written

getHttpContentType

String getHttpContentType()

This method should return the HTTP content type string for the data that is created by this writer.

Returns:

the HTTP content type string

getDocumentListWriter

DocumentListWriter getDocumentListWriter()

Returns the DocumentListWriter used by this parser.

Returns:

the DocumentListWriter used by this parser

setDocumentListWriter

void setDocumentListWriter(DocumentListWriter listWriter)

Sets the DocumentListWriter used by this parser.

Parameters:

listWriter - the DocumentListWriter used by this parser