1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.genericattributes.business;
35
36 import java.io.Serializable;
37 import java.util.List;
38
39 import org.apache.commons.fileupload.FileItem;
40
41 import fr.paris.lutece.util.ReferenceItem;
42 import fr.paris.lutece.util.ReferenceList;
43
44 /**
45 *
46 * IOcrProvider : type document provider for automatic reading of documents<br>
47 * <ul>
48 * <li><code>getKey( )</code> must return the unique key.</li>
49 * <li><code>getDisplayedName( )</code> will be displayed in reference lists.</li>
50 * </ul>
51 */
52 public interface IOcrProvider extends Serializable
53 {
54 /**
55 * Gets the key. This key <b>must be unique</b>.
56 *
57 * @return the key;
58 */
59 String getKey( );
60
61 /**
62 * Gets the displayed name
63 *
64 * @return the displayed name
65 */
66 String getDisplayedName( );
67
68 /**
69 * Gets the html template
70 *
71 * @param nIdTargetEntry
72 * The File reading entry id
73 * @param strResourceType
74 * the resource type
75 * @return the html template
76 */
77 String getHtmlCode( int nIdTargetEntry, String strResourceType );
78
79 /**
80 * Gets the html template configuration
81 *
82 * @param listEntry
83 * The entry list to mapping for prefill
84 * @param nIdTargetEntry
85 * The File reading entry id
86 * @param strResourceType
87 * the resource type
88 * @return the the html template
89 */
90 String getConfigHtmlCode( ReferenceList listEntry, int nIdTargetEntry, String strResourceType );
91
92 /**
93 * Builds a new {@link ReferenceItem} for the type document provider.<br>
94 * <code>key == getKey( )</code>, <code>value == getDisplayedName( )</code>
95 *
96 * @return the item created.
97 */
98 ReferenceItem toRefItem( );
99
100 /**
101 * returns the Parameter class contains all the parameters of the map
102 *
103 * @return the Parameter
104 */
105 Object getParameter( int nKey );
106
107 /**
108 * Gets the list field.
109 *
110 * @return the list field
111 */
112 ReferenceList getListField( );
113
114 /**
115 * Gets the field by id.
116 *
117 * @param idField
118 * the id field
119 * @return the field by id
120 */
121 ReferenceItem getFieldById( int idField );
122
123 /**
124 * Call WS OCR with the uploaded file.
125 *
126 * @param fileUploaded
127 * fileUploaded
128 * @param nIdTargetEntry
129 * The File reading entry id
130 * @param strResourceType
131 * the resource type
132 * @return the Ocr result
133 * @throws Exception
134 */
135 List<Response> process( FileItem fileUploaded, int nIdTargetEntry, String strResourceType ) throws Exception;
136
137 }