org.dice_research.topicmodeling.io.factories

Class AbstractFileBasedDocumentFactory

java.lang.Object

org.dice_research.topicmodeling.io.factories.AbstractFileBasedDocumentFactory

All Implemented Interfaces:

FileBasedDocumentFactory

Direct Known Subclasses:

ByteArrayReadingFileBasedDocumentFactory, StreamOpeningFileBasedDocumentFactory

public abstract class AbstractFileBasedDocumentFactory
extends Object
implements FileBasedDocumentFactory

Abstract implementation of a FileBasedDocumentFactory which creates the Document instance, adds the file name as document name and calls the internal abstract method addFileContent(File, Document) to read the content of the file.

Author:

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

Constructor Summary

Constructors

Constructor and Description
AbstractFileBasedDocumentFactory()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addFileContent(File file, org.dice_research.topicmodeling.utils.doc.Document document) Adds the content of the given file to the given document.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dice_research.topicmodeling.io.factories.FileBasedDocumentFactory

createDocument

Constructor Detail

AbstractFileBasedDocumentFactory

public AbstractFileBasedDocumentFactory()

Method Detail

createDocument

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

Description copied from interface: FileBasedDocumentFactory

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

Specified by:

createDocument in interface FileBasedDocumentFactory

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

addFileContent

protected abstract void addFileContent(File file,
                                       org.dice_research.topicmodeling.utils.doc.Document document)

Adds the content of the given file to the given document. The exact definition how this is done is up to the implementation.

Parameters:

file - the file the newly created document is based on

document - the document to which the file content should be added