org.apache.lucene.ant

Class TextDocument


public class TextDocument
extends Object

A utility for making Lucene Documents from a File.
Author:
Erik Hatcher
To Do:
Fix JavaDoc comments here

Constructor Summary

TextDocument(File file)
Constructor for the TextDocument object

Method Summary

static Document
Document(File f)
Makes a document for a File.
String
getContents()

Constructor Details

TextDocument

public TextDocument(File file)
            throws IOException
Constructor for the TextDocument object
Parameters:
file - Description of Parameter

Method Details

Document

public static Document Document(File f)
            throws IOException
Makes a document for a File.

The document has a single field:

  • contents--containing the full contents of the file, as a Text field;
Parameters:
f - Description of Parameter
Returns:
Description of the Returned Value

getContents

public String getContents()
Returns:
The contents value
To Do:
finish this method

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.