com.groupdocs.search.common

Class FileOutputAdapter

java.lang.Object

com.groupdocs.search.common.ResultBuilderFactory

com.groupdocs.search.common.OutputAdapter

com.groupdocs.search.common.FileOutputAdapter

All Implemented Interfaces:

IFileOutputAdapter, IOutputAdapter, IResultBuilderFactory

public class FileOutputAdapter
extends OutputAdapter
implements IFileOutputAdapter

Represents an output adapter that collects output into a file.

Learn more

• Output adapters

The example demonstrates a typical usage of the class.

 
 String indexFolder = "c:\\MyIndex\\";
 String documentsFolder = "c:\\MyDocuments\\";
 Index index = new Index(indexFolder); // Creating an index in the specified folder
 index.add(documentsFolder); // Indexing documents from the specified folder
 DocumentInfo[] documents = index.getIndexedDocuments(); // Getting information on indexed documents
 FileOutputAdapter adapter = new FileOutputAdapter("c:\\DocumentText.htm"); // Creating a file output adapter
 index.getDocumentText(documents[0], adapter); // Generating a document text into the output file
 
 

Field Summary

Fields inherited from class com.groupdocs.search.common.ResultBuilderFactory

core

Constructor Summary

Constructors

Constructor and Description
FileOutputAdapter(OutputFormat outputFormat, String filePath) Initializes a new instance of the FileOutputAdapter class.

Method Summary

Modifier and Type	Method and Description
String	getFilePath() Gets an output file path.

Methods inherited from class com.groupdocs.search.common.ResultBuilderFactory

getCore, getOutputFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groupdocs.search.common.IResultBuilderFactory

getOutputFormat

Constructor Detail

FileOutputAdapter

public FileOutputAdapter(OutputFormat outputFormat,
                         String filePath)

Initializes a new instance of the FileOutputAdapter class.

Parameters:

outputFormat - The output format.

filePath - The output file path.

Method Detail

getFilePath

public final String getFilePath()

Gets an output file path.

Specified by:

getFilePath in interface IFileOutputAdapter

Returns:

The output file path.