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 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
121 public void addModifiedDate();
122
123
126 public void addModifiedDate(Date modifiedDate);
127
128 public void addNumber(String name, double value);
129
130 public void addNumber(String name, Double value);
131
132 public void addNumber(String name, double[] values);
133
134 public void addNumber(String name, Double[] values);
135
136 public void addNumber(String name, float value);
137
138 public void addNumber(String name, Float value);
139
140 public void addNumber(String name, float[] values);
141
142 public void addNumber(String name, Float[] values);
143
144 public void addNumber(String name, int value);
145
146 public void addNumber(String name, int[] values);
147
148 public void addNumber(String name, Integer value);
149
150 public void addNumber(String name, Integer[] values);
151
152 public void addNumber(String name, long value);
153
154 public void addNumber(String name, Long value);
155
156 public void addNumber(String name, long[] values);
157
158 public void addNumber(String name, Long[] values);
159
160 public void addNumber(String name, String value);
161
162 public void addNumber(String name, String[] values);
163
164 public void addText(String name, String value);
165
166 public void addText(String name, String[] values);
167
168 public void addUID(String portletId, long field1);
169
170 public void addUID(String portletId, long field1, String field2);
171
172 public void addUID(String portletId, Long field1);
173
174 public void addUID(String portletId, Long field1, String field2);
175
176 public void addUID(String portletId, String field1);
177
178 public void addUID(String portletId, String field1, String field2);
179
180 public void addUID(
181 String portletId, String field1, String field2, String field3);
182
183 public void addUID(
184 String portletId, String field1, String field2, String field3,
185 String field4);
186
187 public Object clone();
188
189 public String get(Locale locale, String name);
190
191 public String get(Locale locale, String name, String defaultName);
192
193 public String get(String name);
194
195 public String get(String name, String defaultName);
196
197 public Date getDate(String name) throws ParseException;
198
199 public Field getField(String name);
200
201 public Map<String, Field> getFields();
202
203 public String getPortletId();
204
205 public String getUID();
206
207 public String[] getValues(String name);
208
209 public boolean hasField(String name);
210
211 public boolean isDocumentSortableTextField(String name);
212
213 public void remove(String name);
214
215 public void setSortableTextFields(String[] sortableTextFields);
216
217 }