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.text.ParseException;
023    
024    import java.util.Date;
025    import java.util.Locale;
026    import java.util.Map;
027    
028    /**
029     * @author Brian Wing Shun Chan
030     * @author Bruno Farache
031     */
032    public interface Document extends Cloneable, Serializable {
033    
034            public void add(Field field);
035    
036            public void addDate(String name, Date value);
037    
038            public void addDate(String name, Date[] values);
039    
040            public void addFile(String name, byte[] bytes, String fileExt)
041                    throws IOException;
042    
043            public void addFile(String name, File file, String fileExt)
044                    throws IOException;
045    
046            public void addFile(String name, InputStream is, String fileExt)
047                    throws IOException;
048    
049            public void addFile(
050                            String name, InputStream is, String fileExt, int maxStringLength)
051                    throws IOException;
052    
053            public void addKeyword(String name, boolean value);
054    
055            public void addKeyword(String name, Boolean value);
056    
057            public void addKeyword(String name, boolean[] values);
058    
059            public void addKeyword(String name, Boolean[] values);
060    
061            public void addKeyword(String name, double value);
062    
063            public void addKeyword(String name, Double value);
064    
065            public void addKeyword(String name, double[] values);
066    
067            public void addKeyword(String name, Double[] values);
068    
069            public void addKeyword(String name, float value);
070    
071            public void addKeyword(String name, Float value);
072    
073            public void addKeyword(String name, float[] values);
074    
075            public void addKeyword(String name, Float[] values);
076    
077            public void addKeyword(String name, int value);
078    
079            public void addKeyword(String name, int[] values);
080    
081            public void addKeyword(String name, Integer value);
082    
083            public void addKeyword(String name, Integer[] values);
084    
085            public void addKeyword(String name, long value);
086    
087            public void addKeyword(String name, Long value);
088    
089            public void addKeyword(String name, long[] values);
090    
091            public void addKeyword(String name, Long[] values);
092    
093            public void addKeyword(String name, short value);
094    
095            public void addKeyword(String name, Short value);
096    
097            public void addKeyword(String name, short[] values);
098    
099            public void addKeyword(String name, Short[] values);
100    
101            public void addKeyword(String name, String value);
102    
103            public void addKeyword(String name, String value, boolean lowerCase);
104    
105            public void addKeyword(String name, String[] values);
106    
107            public void addLocalizedKeyword(String name, Map<Locale, String> values);
108    
109            public void addLocalizedKeyword(
110                    String name, Map<Locale, String> values, boolean lowerCase);
111    
112            public void addLocalizedKeyword(
113                    String name, Map<Locale, String> values, boolean lowerCase,
114                    boolean sortable);
115    
116            public void addLocalizedText(String name, Map<Locale, String> values);
117    
118            /**
119             * @deprecated As of 6.1.0
120             */
121            @Deprecated
122            public void addModifiedDate();
123    
124            /**
125             * @deprecated As of 6.1.0
126             */
127            @Deprecated
128            public void addModifiedDate(Date modifiedDate);
129    
130            public void addNumber(String name, double value);
131    
132            public void addNumber(String name, Double value);
133    
134            public void addNumber(String name, double[] values);
135    
136            public void addNumber(String name, Double[] values);
137    
138            public void addNumber(String name, float value);
139    
140            public void addNumber(String name, Float value);
141    
142            public void addNumber(String name, float[] values);
143    
144            public void addNumber(String name, Float[] values);
145    
146            public void addNumber(String name, int value);
147    
148            public void addNumber(String name, int[] values);
149    
150            public void addNumber(String name, Integer value);
151    
152            public void addNumber(String name, Integer[] values);
153    
154            public void addNumber(String name, long value);
155    
156            public void addNumber(String name, Long value);
157    
158            public void addNumber(String name, long[] values);
159    
160            public void addNumber(String name, Long[] values);
161    
162            public void addNumber(String name, String value);
163    
164            public void addNumber(String name, String[] values);
165    
166            public void addText(String name, String value);
167    
168            public void addText(String name, String[] values);
169    
170            public void addUID(String portletId, long field1);
171    
172            public void addUID(String portletId, long field1, String field2);
173    
174            public void addUID(String portletId, Long field1);
175    
176            public void addUID(String portletId, Long field1, String field2);
177    
178            public void addUID(String portletId, String field1);
179    
180            public void addUID(String portletId, String field1, String field2);
181    
182            public void addUID(
183                    String portletId, String field1, String field2, String field3);
184    
185            public void addUID(
186                    String portletId, String field1, String field2, String field3,
187                    String field4);
188    
189            public Object clone();
190    
191            public String get(Locale locale, String name);
192    
193            public String get(Locale locale, String name, String defaultName);
194    
195            public String get(String name);
196    
197            public String get(String name, String defaultName);
198    
199            public Date getDate(String name) throws ParseException;
200    
201            public Field getField(String name);
202    
203            public Map<String, Field> getFields();
204    
205            public String getPortletId();
206    
207            public String getUID();
208    
209            public String[] getValues(String name);
210    
211            public boolean hasField(String name);
212    
213            public boolean isDocumentSortableTextField(String name);
214    
215            public void remove(String name);
216    
217            public void setSortableTextFields(String[] sortableTextFields);
218    
219    }