org.dice_research.topicmodeling.io.factories

Interface FileBasedDocumentFactory

All Known Implementing Classes:

AbstractFileBasedDocumentFactory, ByteArrayReadingFileBasedDocumentFactory, StreamOpeningFileBasedDocumentFactory

public interface FileBasedDocumentFactory

A factory creating a Document instance from the supplied file.

Author:

Michael Röder (michael.roeder@uni-paderborn.de)

Method Summary

Modifier and Type	Method and Description
default org.dice_research.topicmodeling.utils.doc.Document	createDocument(File file) Creates a Document instance from the given file and assigns the default ID 0.
org.dice_research.topicmodeling.utils.doc.Document	createDocument(File file, int documentId) Creates a Document instance from the given file and assigns the given document ID.

Method Detail

createDocument

default org.dice_research.topicmodeling.utils.doc.Document createDocument(File file)

Creates a Document instance from the given file and assigns the default ID 0.

Parameters:

file - the file that should be used to create the Document instance

Returns:

a Document instance from the given file

createDocument

org.dice_research.topicmodeling.utils.doc.Document createDocument(File file,
                                                                  int documentId)

Creates a Document instance from the given file and assigns the given document ID.

Parameters:

file - the file that should be used to create the Document instance

documentId - the ID the newly created instance should have

Returns:

a Document instance from the given file