FileDocCategorySizeDatePackage
FileDocument.javaAPI DocApache Lucene 2.1.02771Wed Feb 14 10:46:42 GMT 2007org.apache.lucene.demo

FileDocument

public class FileDocument extends Object
A utility for making Lucene Documents from a File.

Fields Summary
Constructors Summary
private FileDocument()

Methods Summary
public static org.apache.lucene.document.DocumentDocument(java.io.File f)
Makes a document for a File.

The document has three fields:

  • path--containing the pathname of the file, as a stored, untokenized field;
  • modified--containing the last modified date of the file as a field as created by DateTools; and
  • contents--containing the full contents of the file, as a Reader field;

    	 
        // make a new, empty document
        Document doc = new Document();
    
        // Add the path of the file as a field named "path".  Use a field that is 
        // indexed (i.e. searchable), but don't tokenize the field into words.
        doc.add(new Field("path", f.getPath(), Field.Store.YES, Field.Index.UN_TOKENIZED));
    
        // Add the last modified date of the file a field named "modified".  Use 
        // a field that is indexed (i.e. searchable), but don't tokenize the field
        // into words.
        doc.add(new Field("modified",
            DateTools.timeToString(f.lastModified(), DateTools.Resolution.MINUTE),
            Field.Store.YES, Field.Index.UN_TOKENIZED));
    
        // Add the contents of the file to a field named "contents".  Specify a Reader,
        // so that the text of the file is tokenized and indexed, but not stored.
        // Note that FileReader expects the file to be in the system's default encoding.
        // If that's not the case searching for special characters will fail.
        doc.add(new Field("contents", new FileReader(f)));
    
        // return the document
        return doc;