svn commit: r736103 - in /lucene/tika/trunk/src/main/java/org/apache/tika/detect: ./ Detector.java

[ju...@apache.org]

Author: jukka
Date: Tue Jan 20 13:00:16 2009
New Revision: 736103

URL: http://svn.apache.org/viewvc?rev=736103&view=rev
Log:
TIKA-95: Pluggable magic header detectors

Added the Detector interface

Added:
    lucene/tika/trunk/src/main/java/org/apache/tika/detect/
    lucene/tika/trunk/src/main/java/org/apache/tika/detect/Detector.java

Added: lucene/tika/trunk/src/main/java/org/apache/tika/detect/Detector.java
URL: http://svn.apache.org/viewvc/lucene/tika/trunk/src/main/java/org/apache/tika/detect/Detector.java?rev=736103&view=auto
==============================================================================
--- lucene/tika/trunk/src/main/java/org/apache/tika/detect/Detector.java (added)
+++ lucene/tika/trunk/src/main/java/org/apache/tika/detect/Detector.java Tue Jan 20 13:00:16 2009
@@ -0,0 +1,59 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.tika.detect;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.tika.metadata.Metadata;
+import org.apache.tika.mime.MimeType;
+
+/**
+ * Content type detector. Implementations of this interface use various
+ * heuristics to detect the content type of a document based on given
+ * input metadata or the first few bytes of the document stream.
+ *
+ * @since Apache Tika 0.3
+ */
+public interface Detector {
+
+    /**
+     * Detects the content type of the given input document. Returns
+     * <code>application/octet-stream</code> if the type of the document
+     * can not be detected.
+     * <p>
+     * If the document input stream is not available, then the first
+     * argument may be <code>null</code>. Otherwise the detector may
+     * read bytes from the start of the stream to help in type detection.
+     * The stream must not be closed or otherwise manipulated other by
+     * simply reading bytes from it, as the caller may use the mark feature
+     * to be able to reset the stream to the beginning for proper parsing
+     * when the content type is detected. For the same reason the detector
+     * must only read up to a limited number of bytes from the stream to
+     * avoid potentially unbounded memory use for the buffer of a marked
+     * a stream.
+     * <p>
+     * The given input metadata is only read, not modified, by the detector.
+     *
+     * @param input document input stream, or <code>null</code>
+     * @param metadata input metadata for the document
+     * @return detected media type, or <code>application/octet-stream</code>
+     * @throws IOException if the document input stream could not be read
+     */
+    MimeType detect(InputStream input, Metadata metadata) throws IOException;
+
+}