View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.tika.parser;
18  
19  import java.io.IOException;
20  import java.io.InputStream;
21  import java.util.Set;
22  
23  import org.apache.tika.exception.TikaException;
24  import org.apache.tika.metadata.Metadata;
25  import org.apache.tika.mime.MediaType;
26  import org.xml.sax.ContentHandler;
27  import org.xml.sax.SAXException;
28  
29  /**
30   * Decorator base class for the {@link Parser} interface. This class
31   * simply delegates all parsing calls to an underlying decorated parser
32   * instance. Subclasses can provide extra decoration by overriding the
33   * parse method.
34   */
35  public class ParserDecorator implements Parser {
36  
37      /**
38       * The decorated parser instance.
39       */
40      private final Parser parser;
41  
42      /**
43       * Creates a decorator for the given parser.
44       *
45       * @param parser the parser instance to be decorated
46       */
47      public ParserDecorator(Parser parser) {
48          this.parser = parser;
49      }
50  
51      /**
52       * Delegates the method call to the decorated parser. Subclasses should
53       * override this method (and use <code>super.getSupportedTypes()</code>
54       * to invoke the decorated parser) to implement extra decoration.
55       */
56      public Set<MediaType> getSupportedTypes(ParseContext context) {
57          return parser.getSupportedTypes(context);
58      }
59  
60      /**
61       * Delegates the method call to the decorated parser. Subclasses should
62       * override this method (and use <code>super.parse()</code> to invoke
63       * the decorated parser) to implement extra decoration.
64       */
65      public void parse(
66              InputStream stream, ContentHandler handler,
67              Metadata metadata, ParseContext context)
68              throws IOException, SAXException, TikaException {
69          parser.parse(stream, handler, metadata, context);
70      }
71  
72      /**
73       * @deprecated This method will be removed in Apache Tika 1.0.
74       */
75      public void parse(
76              InputStream stream, ContentHandler handler, Metadata metadata)
77              throws IOException, SAXException, TikaException {
78          parse(stream, handler, metadata, new ParseContext());
79      }
80  
81  }