001
014
015 package com.liferay.portal.kernel.search;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import java.io.File;
020 import java.io.IOException;
021 import java.io.InputStream;
022 import java.io.Serializable;
023
024 import java.math.BigDecimal;
025
026 import java.text.ParseException;
027
028 import java.util.Date;
029 import java.util.Locale;
030 import java.util.Map;
031
032
036 @ProviderType
037 public interface Document extends Cloneable, Serializable {
038
039 public void add(Field field);
040
041 public void addDate(String name, Date value);
042
043 public void addDate(String name, Date[] values);
044
045 public void addDateSortable(String name, Date value);
046
047 public void addDateSortable(String name, Date[] values);
048
049 public void addFile(String name, byte[] bytes, String fileExt)
050 throws IOException;
051
052 public void addFile(String name, File file, String fileExt)
053 throws IOException;
054
055 public void addFile(String name, InputStream is, String fileExt)
056 throws IOException;
057
058 public void addFile(
059 String name, InputStream is, String fileExt, int maxStringLength)
060 throws IOException;
061
062 public void addGeoLocation(double latitude, double longitude);
063
064 public void addGeoLocation(String name, double latitude, double longitude);
065
066 public void addKeyword(String name, boolean value);
067
068 public void addKeyword(String name, Boolean value);
069
070 public void addKeyword(String name, boolean[] values);
071
072 public void addKeyword(String name, Boolean[] values);
073
074 public void addKeyword(String name, double value);
075
076 public void addKeyword(String name, Double value);
077
078 public void addKeyword(String name, double[] values);
079
080 public void addKeyword(String name, Double[] values);
081
082 public void addKeyword(String name, float value);
083
084 public void addKeyword(String name, Float value);
085
086 public void addKeyword(String name, float[] values);
087
088 public void addKeyword(String name, Float[] values);
089
090 public void addKeyword(String name, int value);
091
092 public void addKeyword(String name, int[] values);
093
094 public void addKeyword(String name, Integer value);
095
096 public void addKeyword(String name, Integer[] values);
097
098 public void addKeyword(String name, long value);
099
100 public void addKeyword(String name, Long value);
101
102 public void addKeyword(String name, long[] values);
103
104 public void addKeyword(String name, Long[] values);
105
106 public void addKeyword(String name, short value);
107
108 public void addKeyword(String name, Short value);
109
110 public void addKeyword(String name, short[] values);
111
112 public void addKeyword(String name, Short[] values);
113
114 public void addKeyword(String name, String value);
115
116 public void addKeyword(String name, String value, boolean lowerCase);
117
118 public void addKeyword(String name, String[] values);
119
120 public void addKeywordSortable(String name, Boolean value);
121
122 public void addKeywordSortable(String name, Boolean[] values);
123
124 public void addKeywordSortable(String name, String value);
125
126 public void addKeywordSortable(String name, String[] values);
127
128 public void addLocalizedKeyword(String name, Map<Locale, String> values);
129
130 public void addLocalizedKeyword(
131 String name, Map<Locale, String> values, boolean lowerCase);
132
133 public void addLocalizedKeyword(
134 String name, Map<Locale, String> values, boolean lowerCase,
135 boolean sortable);
136
137 public void addLocalizedText(String name, Map<Locale, String> values);
138
139 public void addNumber(String name, BigDecimal value);
140
141 public void addNumber(String name, BigDecimal[] values);
142
143 public void addNumber(String name, double value);
144
145 public void addNumber(String name, Double value);
146
147 public void addNumber(String name, double[] values);
148
149 public void addNumber(String name, Double[] values);
150
151 public void addNumber(String name, float value);
152
153 public void addNumber(String name, Float value);
154
155 public void addNumber(String name, float[] values);
156
157 public void addNumber(String name, Float[] values);
158
159 public void addNumber(String name, int value);
160
161 public void addNumber(String name, int[] values);
162
163 public void addNumber(String name, Integer value);
164
165 public void addNumber(String name, Integer[] values);
166
167 public void addNumber(String name, long value);
168
169 public void addNumber(String name, Long value);
170
171 public void addNumber(String name, long[] values);
172
173 public void addNumber(String name, Long[] values);
174
175 public void addNumber(String name, String value);
176
177 public void addNumber(String name, String[] values);
178
179 public void addNumberSortable(String name, BigDecimal value);
180
181 public void addNumberSortable(String name, BigDecimal[] values);
182
183 public void addNumberSortable(String name, Double value);
184
185 public void addNumberSortable(String name, Double[] values);
186
187 public void addNumberSortable(String name, Float value);
188
189 public void addNumberSortable(String name, Float[] values);
190
191 public void addNumberSortable(String name, Integer value);
192
193 public void addNumberSortable(String name, Integer[] values);
194
195 public void addNumberSortable(String name, Long value);
196
197 public void addNumberSortable(String name, Long[] values);
198
199 public void addText(String name, String value);
200
201 public void addText(String name, String[] values);
202
203 public void addTextSortable(String name, String value);
204
205 public void addTextSortable(String name, String[] values);
206
207 public void addUID(String portletId, long field1);
208
209 public void addUID(String portletId, long field1, String field2);
210
211 public void addUID(String portletId, Long field1);
212
213 public void addUID(String portletId, Long field1, String field2);
214
215 public void addUID(String portletId, String field1);
216
217 public void addUID(String portletId, String field1, String field2);
218
219 public void addUID(
220 String portletId, String field1, String field2, String field3);
221
222 public void addUID(
223 String portletId, String field1, String field2, String field3,
224 String field4);
225
226 public Object clone();
227
228 public String get(Locale locale, String name);
229
230 public String get(Locale locale, String name, String defaultName);
231
232 public String get(String name);
233
234 public String get(String name, String defaultName);
235
236 public Date getDate(String name) throws ParseException;
237
238 public Field getField(String name);
239
240 public Map<String, Field> getFields();
241
242 public String getPortletId();
243
244 public String getUID();
245
246 public String[] getValues(String name);
247
248 public boolean hasField(String name);
249
250 public boolean isDocumentSortableTextField(String name);
251
252 public void remove(String name);
253
254 public void setSortableTextFields(String[] sortableTextFields);
255
256 }