001
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
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 addDateSortable(String name, Date value);
041
042 public void addDateSortable(String name, Date[] values);
043
044 public void addFile(String name, byte[] bytes, String fileExt)
045 throws IOException;
046
047 public void addFile(String name, File file, String fileExt)
048 throws IOException;
049
050 public void addFile(String name, InputStream is, String fileExt)
051 throws IOException;
052
053 public void addFile(
054 String name, InputStream is, String fileExt, int maxStringLength)
055 throws IOException;
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
133 public void addModifiedDate();
134
135
138 public void addModifiedDate(Date modifiedDate);
139
140 public void addNumber(String name, double value);
141
142 public void addNumber(String name, Double value);
143
144 public void addNumber(String name, double[] values);
145
146 public void addNumber(String name, Double[] values);
147
148 public void addNumber(String name, float value);
149
150 public void addNumber(String name, Float value);
151
152 public void addNumber(String name, float[] values);
153
154 public void addNumber(String name, Float[] values);
155
156 public void addNumber(String name, int value);
157
158 public void addNumber(String name, int[] values);
159
160 public void addNumber(String name, Integer value);
161
162 public void addNumber(String name, Integer[] values);
163
164 public void addNumber(String name, long value);
165
166 public void addNumber(String name, Long value);
167
168 public void addNumber(String name, long[] values);
169
170 public void addNumber(String name, Long[] values);
171
172 public void addNumber(String name, String value);
173
174 public void addNumber(String name, String[] values);
175
176 public void addNumberSortable(String name, Double value);
177
178 public void addNumberSortable(String name, Double[] values);
179
180 public void addNumberSortable(String name, Float value);
181
182 public void addNumberSortable(String name, Float[] values);
183
184 public void addNumberSortable(String name, Integer value);
185
186 public void addNumberSortable(String name, Integer[] values);
187
188 public void addNumberSortable(String name, Long value);
189
190 public void addNumberSortable(String name, Long[] values);
191
192 public void addText(String name, String value);
193
194 public void addText(String name, String[] values);
195
196 public void addTextSortable(String name, String value);
197
198 public void addTextSortable(String name, String[] values);
199
200 public void addUID(String portletId, long field1);
201
202 public void addUID(String portletId, long field1, String field2);
203
204 public void addUID(String portletId, Long field1);
205
206 public void addUID(String portletId, Long field1, String field2);
207
208 public void addUID(String portletId, String field1);
209
210 public void addUID(String portletId, String field1, String field2);
211
212 public void addUID(
213 String portletId, String field1, String field2, String field3);
214
215 public void addUID(
216 String portletId, String field1, String field2, String field3,
217 String field4);
218
219 public Object clone();
220
221 public String get(Locale locale, String name);
222
223 public String get(Locale locale, String name, String defaultName);
224
225 public String get(String name);
226
227 public String get(String name, String defaultName);
228
229 public Date getDate(String name) throws ParseException;
230
231 public Field getField(String name);
232
233 public Map<String, Field> getFields();
234
235 public String getPortletId();
236
237 public String getUID();
238
239 public String[] getValues(String name);
240
241 public boolean hasField(String name);
242
243 public boolean isDocumentSortableTextField(String name);
244
245 public void remove(String name);
246
247 public void setSortableTextFields(String[] sortableTextFields);
248
249 }