mirror of
https://github.com/yacy/yacy_search_server.git
synced 2024-09-21 00:00:13 +02:00
b6fb239e74
some file types are containers for several files. These containers had been parsed in such a way that the set of resulting parsed content was merged into one single document before parsing. Using this parser infrastructure it is not possible to parse document containers that contain individual files. An example is a rss file where the rss messages can be treated as individual documents with their own url reference. Another example is a surrogate file which was treated with a special operation outside of the parser infrastructure. This commit introduces a redesigned parser interface and a new abstract parser implementation. The new parser interface has now only one entry point and returns always a set of parsed documents. In case of single documents the parser method returns a set of one documents. To be compliant with the new interface, the zip and tar parser had been also completely redesigned. All parsers are now much more simple and cleaner in its structure. The switchboard operations had been extended to operate with sets of parsed files, not single parsed files. additionally, parsing of jar manifest files had been added. git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@6955 6c8d7289-2bf4-0310-a012-ef5d649a1542
108 lines
3.3 KiB
Java
108 lines
3.3 KiB
Java
/**
|
|
* Parser.java
|
|
* Copyright 2010 by Michael Peter Christen, mc@yacy.net, Frankfurt am Main, Germany
|
|
* First released 29.6.2010 at http://yacy.net
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program in the file lgpl21.txt
|
|
* If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
// this is a new definition of the parser interface using multiple documents as result set
|
|
// and a much simpler method structure with only one single parser method to implement
|
|
|
|
package net.yacy.document;
|
|
|
|
import java.io.InputStream;
|
|
import java.util.Set;
|
|
|
|
import net.yacy.cora.document.MultiProtocolURI;
|
|
|
|
public interface Parser {
|
|
|
|
/**
|
|
* each parser must define a set of supported mime types
|
|
* @return a set of mime type strings that are supported
|
|
*/
|
|
public Set<String> supportedMimeTypes();
|
|
|
|
/**
|
|
* each parser must define a set of supported file extensions
|
|
* @return a set of file name extensions that are supported
|
|
*/
|
|
public Set<String> supportedExtensions();
|
|
|
|
/**
|
|
* parse an input stream
|
|
* @param url the url of the source
|
|
* @param mimeType the mime type of the source, if known
|
|
* @param charset the charset of the source, if known
|
|
* @param source a input stream
|
|
* @return a list of documents that result from parsing the source
|
|
* @throws Parser.Failure
|
|
* @throws InterruptedException
|
|
*/
|
|
public Document[] parse(
|
|
MultiProtocolURI url,
|
|
String mimeType,
|
|
String charset,
|
|
InputStream source
|
|
) throws Parser.Failure, InterruptedException;
|
|
|
|
|
|
// methods to that shall make it possible to put Parser objects into a hashtable
|
|
|
|
/**
|
|
* get the name of the parser
|
|
* @return the name of the parser
|
|
*/
|
|
public String getName();
|
|
|
|
/**
|
|
* check equivalence of parsers; this simply tests equality of parser names
|
|
* @param o
|
|
* @return
|
|
*/
|
|
public boolean equals(Object o);
|
|
|
|
/**
|
|
* the hash code of a parser
|
|
* @return the hash code of the parser name string
|
|
*/
|
|
public int hashCode();
|
|
|
|
/**
|
|
* a parser waring
|
|
* thrown as an exception
|
|
*/
|
|
public class Failure extends Exception {
|
|
|
|
private static final long serialVersionUID = 2278214953869122883L;
|
|
private MultiProtocolURI url = null;
|
|
public Failure() {
|
|
super();
|
|
}
|
|
|
|
public Failure(final String message, final MultiProtocolURI url) {
|
|
super(message + "; url = " + url.toNormalform(true, false));
|
|
this.url = url;
|
|
}
|
|
|
|
public MultiProtocolURI getURL() {
|
|
return this.url;
|
|
}
|
|
}
|
|
}
|
|
|
|
|