/*
* Copyright 2009 David Jurgens
*
* This file is part of the S-Space package and is covered under the terms and
* conditions therein.
*
* The S-Space package is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as published
* by the Free Software Foundation and distributed hereunder to you.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND NO REPRESENTATIONS OR WARRANTIES,
* EXPRESS OR IMPLIED ARE MADE. BY WAY OF EXAMPLE, BUT NOT LIMITATION, WE MAKE
* NO REPRESENTATIONS OR WARRANTIES OF MERCHANT- ABILITY OR FITNESS FOR ANY
* PARTICULAR PURPOSE OR THAT THE USE OF THE LICENSED SOFTWARE OR DOCUMENTATION
* WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER
* RIGHTS.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package edu.ucla.sspace.text;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOError;
import java.io.IOException;
import java.io.StringReader;
import edu.ucla.sspace.util.LineReader;
/**
* A {@code Document} implementation backed by a {@code File} whose contents are
* used for the document text.
*/
public class FileDocument implements Document {
/**
* The name of the file whose contents are this document.
*/
private final String fileName;
/**
* The optionally cached contents of the file or {@code null} if the
* contents were not cached.
*/
private final String contents;
/**
* Constructs a {@code Document} based on the contents of the provide file,
* where the contests are read from disk.
*
* @param fileName the name of a file whose contents will be used as a
* document
*
* @throws IOException if any error occurred while reading {@code fileName}.
*/
public FileDocument(String fileName) throws IOException {
this(fileName, false);
}
/**
* Constructs a {@code Document} based on the contents of the provide file,
* optionally caching those contents in memory to allow reading the file
* multiple times.
*
* @param fileName the name of a file whose contents will be used as a
* document
*/
public FileDocument(String fileName, boolean cacheContents)
throws IOException {
this.fileName = fileName;
if (cacheContents) {
StringBuilder sb = new StringBuilder();
for (String line : new LineReader(new File(fileName)))
sb.append(line).append('\n');
contents = sb.toString();
}
else
contents = null;
}
/**
* {@inheritDoc}
*/
public BufferedReader reader() {
try {
return (contents == null)
? new BufferedReader(new FileReader(fileName))
: new BufferedReader(new StringReader(contents));
} catch (IOException ioe) {
throw new IOError(ioe);
}
}
}