001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search;
016    
017    import java.io.File;
018    import java.io.IOException;
019    import java.io.InputStream;
020    import java.io.Serializable;
021    
022    import java.math.BigDecimal;
023    
024    import java.text.ParseException;
025    
026    import java.util.Date;
027    import java.util.Locale;
028    import java.util.Map;
029    
030    /**
031     * @author Brian Wing Shun Chan
032     * @author Bruno Farache
033     */
034    public interface Document extends Cloneable, Serializable {
035    
036            public void add(Field field);
037    
038            public void addDate(String name, Date value);
039    
040            public void addDate(String name, Date[] values);
041    
042            public void addFile(String name, byte[] bytes, String fileExt)
043                    throws IOException;
044    
045            public void addFile(String name, File file, String fileExt)
046                    throws IOException;
047    
048            public void addFile(String name, InputStream is, String fileExt)
049                    throws IOException;
050    
051            public void addFile(
052                            String name, InputStream is, String fileExt, int maxStringLength)
053                    throws IOException;
054    
055            public void addGeoLocation(double latitude, double longitude);
056    
057            public void addKeyword(String name, boolean value);
058    
059            public void addKeyword(String name, Boolean value);
060    
061            public void addKeyword(String name, boolean[] values);
062    
063            public void addKeyword(String name, Boolean[] values);
064    
065            public void addKeyword(String name, double value);
066    
067            public void addKeyword(String name, Double value);
068    
069            public void addKeyword(String name, double[] values);
070    
071            public void addKeyword(String name, Double[] values);
072    
073            public void addKeyword(String name, float value);
074    
075            public void addKeyword(String name, Float value);
076    
077            public void addKeyword(String name, float[] values);
078    
079            public void addKeyword(String name, Float[] values);
080    
081            public void addKeyword(String name, int value);
082    
083            public void addKeyword(String name, int[] values);
084    
085            public void addKeyword(String name, Integer value);
086    
087            public void addKeyword(String name, Integer[] values);
088    
089            public void addKeyword(String name, long value);
090    
091            public void addKeyword(String name, Long value);
092    
093            public void addKeyword(String name, long[] values);
094    
095            public void addKeyword(String name, Long[] values);
096    
097            public void addKeyword(String name, short value);
098    
099            public void addKeyword(String name, Short value);
100    
101            public void addKeyword(String name, short[] values);
102    
103            public void addKeyword(String name, Short[] values);
104    
105            public void addKeyword(String name, String value);
106    
107            public void addKeyword(String name, String value, boolean lowerCase);
108    
109            public void addKeyword(String name, String[] values);
110    
111            public void addKeywordSortable(String name, Boolean value);
112    
113            public void addKeywordSortable(String name, Boolean[] values);
114    
115            public void addKeywordSortable(String name, String value);
116    
117            public void addKeywordSortable(String name, String[] values);
118    
119            public void addLocalizedKeyword(String name, Map<Locale, String> values);
120    
121            public void addLocalizedKeyword(
122                    String name, Map<Locale, String> values, boolean lowerCase);
123    
124            public void addLocalizedKeyword(
125                    String name, Map<Locale, String> values, boolean lowerCase,
126                    boolean sortable);
127    
128            public void addLocalizedText(String name, Map<Locale, String> values);
129    
130            public void addNumber(String name, BigDecimal value);
131    
132            public void addNumber(String name, BigDecimal[] values);
133    
134            public void addNumber(String name, double value);
135    
136            public void addNumber(String name, Double value);
137    
138            public void addNumber(String name, double[] values);
139    
140            public void addNumber(String name, Double[] values);
141    
142            public void addNumber(String name, float value);
143    
144            public void addNumber(String name, Float value);
145    
146            public void addNumber(String name, float[] values);
147    
148            public void addNumber(String name, Float[] values);
149    
150            public void addNumber(String name, int value);
151    
152            public void addNumber(String name, int[] values);
153    
154            public void addNumber(String name, Integer value);
155    
156            public void addNumber(String name, Integer[] values);
157    
158            public void addNumber(String name, long value);
159    
160            public void addNumber(String name, Long value);
161    
162            public void addNumber(String name, long[] values);
163    
164            public void addNumber(String name, Long[] values);
165    
166            public void addNumber(String name, String value);
167    
168            public void addNumber(String name, String[] values);
169    
170            public void addNumberSortable(String name, BigDecimal value);
171    
172            public void addNumberSortable(String name, BigDecimal[] values);
173    
174            public void addNumberSortable(String name, Double value);
175    
176            public void addNumberSortable(String name, Double[] values);
177    
178            public void addNumberSortable(String name, Float value);
179    
180            public void addNumberSortable(String name, Float[] values);
181    
182            public void addNumberSortable(String name, Integer value);
183    
184            public void addNumberSortable(String name, Integer[] values);
185    
186            public void addNumberSortable(String name, Long value);
187    
188            public void addNumberSortable(String name, Long[] values);
189    
190            public void addText(String name, String value);
191    
192            public void addText(String name, String[] values);
193    
194            public void addTextSortable(String name, String value);
195    
196            public void addTextSortable(String name, String[] values);
197    
198            public void addUID(String portletId, long field1);
199    
200            public void addUID(String portletId, long field1, String field2);
201    
202            public void addUID(String portletId, Long field1);
203    
204            public void addUID(String portletId, Long field1, String field2);
205    
206            public void addUID(String portletId, String field1);
207    
208            public void addUID(String portletId, String field1, String field2);
209    
210            public void addUID(
211                    String portletId, String field1, String field2, String field3);
212    
213            public void addUID(
214                    String portletId, String field1, String field2, String field3,
215                    String field4);
216    
217            public Object clone();
218    
219            public String get(Locale locale, String name);
220    
221            public String get(Locale locale, String name, String defaultName);
222    
223            public String get(String name);
224    
225            public String get(String name, String defaultName);
226    
227            public Date getDate(String name) throws ParseException;
228    
229            public Field getField(String name);
230    
231            public Map<String, Field> getFields();
232    
233            public String getPortletId();
234    
235            public String getUID();
236    
237            public String[] getValues(String name);
238    
239            public boolean hasField(String name);
240    
241            public boolean isDocumentSortableTextField(String name);
242    
243            public void remove(String name);
244    
245            public void setSortableTextFields(String[] sortableTextFields);
246    
247    }