nyla.solutions.global.patterns.search.SearchEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nyla.solutions.global Show documentation

Nyla Solutions Global Java API provides support for basic application utilities (application configuration, data encryption, debugger and text processing).

The newest version!

package nyla.solutions.global.patterns.search;

import java.io.File;
import java.io.IOException;
import java.net.URL;


public interface SearchEngine
{

	/**
	 * Create a search index for a URL
	 * @param url the url to index
	 * @throws IOException
	 */
	public abstract void index(URL url) throws IOException;	

	/**
	 * Indexes a file or directory
	 * 
	 * @param fileName  the name of a text file or a folder we wish to add to the
	 *            index
	 * @throws java.io.IOException
	 */
	public abstract void index(File file) throws IOException;
	

	/**
	 * 
	 * @param querystr
	 * @param field
	 * @return return array  ScoreDoc[]
	 * @throws IOException
	 * @throws ParseException
	 */
	public abstract Object[] search(String query, String field);
	
	
	/**
	 * 
	 * @param querystr
	 * @param field
	 * @return return array  ScoreDoc[]
	 * @throws IOException
	 * @throws ParseException
	 */
	public abstract Object[] search(String query);
	

}