DocumentCreator.java example

Explorer
spring-modules-master
/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springmodules.lucene.index.core;

import java.io.IOException;

import org.apache.lucene.document.Document;

/**
 * Callback interface for creating a Lucene document instance.
 *
 * <p>Used for input Document creation in LuceneIndexTemplate. Alternatively,
 * Document instances can be passed into LuceneIndexTemplate's corresponding
 * <code>addDocument</code> methods directly.
 *
 * <p><b>Caution</b>: If you want to use InputStream with this interface, you need to
 * manage the stream outside the template or use the InputStreamDocumentCreator.
 *
 * @author Thierry Templier
 * @see org.springmodules.lucene.index.core.InputStreamDocumentCreator
 * @see LuceneIndexTemplate#addDocument(DocumentCreator)
 * @see LuceneIndexTemplate#addDocument(DocumentCreator,org.apache.lucene.analysis.Analyzer)
 */
public interface DocumentCreator {

	/**
	 * Create a Lucene document instance.
	 * <p>For use as <i>input</i> creator with LuceneIndexTemplate's
	 * <code>addDocument</code> methods,
	 * this method should create a <i>populated</i> Document instance.
	 * @return the Lucene Document instance
	 * @throws IOException if thrown by a Lucene method, to be auto-converted
	 * to a LuceneManipulateIndexException
	 */
	Document createDocument() throws Exception;
}