mirror of
https://github.com/yacy/yacy_search_server.git
synced 2024-09-21 00:00:13 +02:00
11639aef35
- it is now possible to crawl the local file system with an intranet peer - redesign of URL handling - refactoring: created LGPLed package cora: 'content retrieval api' which may be used externally by other applications without yacy core elements because it has no dependencies to other parts of yacy git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@6902 6c8d7289-2bf4-0310-a012-ef5d649a1542
117 lines
4.3 KiB
Java
117 lines
4.3 KiB
Java
//Idiom.java
|
|
//------------------------
|
|
//part of YaCy
|
|
//(C) by Michael Peter Christen; mc@yacy.net
|
|
//first published on http://www.anomic.de
|
|
//Frankfurt, Germany, 2005
|
|
//
|
|
//this file was contributed by Martin Thelian
|
|
//last major change: $LastChangedDate$ by $LastChangedBy$
|
|
//Revision: $LastChangedRevision$
|
|
//
|
|
//This program is free software; you can redistribute it and/or modify
|
|
//it under the terms of the GNU General Public License as published by
|
|
//the Free Software Foundation; either version 2 of the License, or
|
|
//(at your option) any later version.
|
|
//
|
|
//This program is distributed in the hope that it will be useful,
|
|
//but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
//GNU General Public License for more details.
|
|
//
|
|
//You should have received a copy of the GNU General Public License
|
|
//along with this program; if not, write to the Free Software
|
|
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
package net.yacy.document;
|
|
|
|
import java.io.File;
|
|
import java.io.InputStream;
|
|
import java.util.Set;
|
|
|
|
import net.yacy.cora.document.MultiProtocolURI;
|
|
|
|
|
|
/**
|
|
* This interface defines a list of methods that needs to be implemented
|
|
* by each content parser class.
|
|
* @author Martin Thelian
|
|
* @version $LastChangedRevision$ / $LastChangedDate$
|
|
*/
|
|
public interface Idiom {
|
|
|
|
/**
|
|
* Parsing a document available as byte array
|
|
* @param location the origin of the document
|
|
* @param mimeType the mimetype of the document
|
|
* @param charset the supposed charset of the document or <code>null</code> if unkown
|
|
* @param source the content byte array
|
|
* @return a {@link Document} containing the extracted plain text of the document
|
|
* and some additional metadata.
|
|
*
|
|
* @throws ParserException if the content could not be parsed properly
|
|
*/
|
|
public Document parse(MultiProtocolURI location, String mimeType, String charset, byte[] source)
|
|
throws ParserException, InterruptedException;
|
|
|
|
/**
|
|
* Parsing a document stored in a {@link File}
|
|
* @param location the origin of the document
|
|
* @param mimeType the mimetype of the document
|
|
* @param charset the supposed charset of the document or <code>null</code> if unkown
|
|
* @param sourceFile the file containing the content of the document
|
|
* @return a {@link Document} containing the extracted plain text of the document
|
|
* and some additional metadata.
|
|
*
|
|
* @throws ParserException if the content could not be parsed properly
|
|
*/
|
|
public Document parse(MultiProtocolURI location, String mimeType, String charset, File sourceFile)
|
|
throws ParserException, InterruptedException;
|
|
|
|
/**
|
|
* Parsing a document available as {@link InputStream}
|
|
* @param location the origin of the document
|
|
* @param mimeType the mimetype of the document
|
|
* @param charset the supposed charset of the document or <code>null</code> if unkown
|
|
* @param source the {@link InputStream} containing the document content
|
|
* @return a {@link Document} containing the extracted plain text of the document
|
|
* and some additional metadata.
|
|
*
|
|
* @throws ParserException if the content could not be parsed properly
|
|
*/
|
|
public Document parse(MultiProtocolURI location, String mimeType, String charset, InputStream source)
|
|
throws ParserException, InterruptedException;
|
|
|
|
/**
|
|
* Get the MimeType(s) that are supported by the parser
|
|
* @return a set of strings denoting the supported mime types
|
|
*/
|
|
public Set<String> supportedMimeTypes();
|
|
|
|
/**
|
|
* Get the File extension(s) that are supported by the parser
|
|
* @return a set of strings denoting the supported file extensions
|
|
*/
|
|
public Set<String> supportedExtensions();
|
|
|
|
/**
|
|
* This function should be called before reusing the parser object.
|
|
*/
|
|
public void reset();
|
|
|
|
public void setContentLength(long length);
|
|
|
|
/**
|
|
* Returns the name of the parser
|
|
* @return parser name
|
|
*/
|
|
public String getName();
|
|
|
|
public boolean equals(Object o);
|
|
|
|
public int hashCode();
|
|
|
|
}
|
|
|
|
|