JahiaFileExtractionService


1   //
2   //                                   ____.
3   //                       __/\ ______|    |__/\.     _______
4   //            __   .____|    |       \   |    +----+       \
5   //    _______|  /--|    |    |    -   \  _    |    :    -   \_________
6   //   \\______: :---|    :    :           |    :    |         \________>
7   //           |__\---\_____________:______:    :____|____:_____\
8   //                                      /_____|
9   //
10  //                 . . . i n   j a h i a   w e   t r u s t . . .
11  //
12  
13  package org.jahia.services.fileextraction;
14  
15  import java.io.InputStream  ;
16  
17  import org.jahia.exceptions.JahiaException;
18  import org.jahia.services.*;
19  
20  /**
21   * 
22   * @author hollis
23   *
24   * TODO To change the template for this generated type comment go to
25   * Window - Preferences - Java - Code Style - Code Templates
26   */
27  public abstract class JahiaFileExtractionService extends JahiaService {
28  
29      /**
30       * Return a file extractor for a given content type
31       *
32       * @param contentType String
33       * @throws JahiaException
34       * @return FileExtractor
35       */
36      public abstract FileExtractor getFileExtractor(String   contentType)
37          throws JahiaException;
38  
39      /**
40       *  
41       * @param contentType
42       * @param cacheKey , a unique key used to cache the extraction ( serializing on disk )
43       * @param lastModified
44       * @param allowCache, if true, use a cached extractio if any
45       * @param fileStream
46       * @return
47       * @throws Exception
48       */
49      public abstract ExtractedDocument getExtractedDocument( String   contentType,
50                                                     String   cacheKey,
51                                                     long lastModified,
52                                                     boolean allowCache,
53                                                     InputStream   fileStream)
54      throws Exception  ;
55  
56      /**
57       *  
58       * @param contentType
59       * @param cacheKey , a unique key used to cache the extraction ( serializing on disk )
60       * @param lastModified
61       * @param allowCache, if true, use a cached extractio if any
62       * @param fileStream
63       * @param charSet
64       * @return
65       * @throws Exception
66       */
67      public abstract ExtractedDocument getExtractedDocument( String   contentType,
68                                                     String   cacheKey,
69                                                     long lastModified,
70                                                     boolean allowCache,
71                                                     InputStream   fileStream,
72                                                     String   charSet)
73      throws Exception  ;
74  
75  }
76
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags