| Document.java |
1 /**
2 * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.portal.kernel.search;
24
25 import java.io.File;
26 import java.io.IOException;
27 import java.io.InputStream;
28
29 import java.text.ParseException;
30
31 import java.util.Date;
32 import java.util.Map;
33
34 /**
35 * <a href="Document.java.html"><b><i>View Source</i></b></a>
36 *
37 * @author Brian Wing Shun Chan
38 * @author Bruno Farache
39 *
40 */
41 public interface Document {
42
43 public void add(Field field);
44
45 public void addDate(String name, Date value);
46
47 public void addFile(String name, InputStream is, String fileExt)
48 throws IOException;
49
50 public void addFile(String name, byte[] bytes, String fileExt)
51 throws IOException;
52
53 public void addFile(String name, File file, String fileExt)
54 throws IOException;
55
56 public void addKeyword(String name, double value);
57
58 public void addKeyword(String name, int value);
59
60 public void addKeyword(String name, long value);
61
62 public void addKeyword(String name, String value);
63
64 public void addKeyword(String name, String[] values);
65
66 public void addModifiedDate();
67
68 public void addText(String name, String value);
69
70 public void addUID(String portletId, long field1);
71
72 public void addUID(String portletId, Long field1);
73
74 public void addUID(String portletId, String field1);
75
76 public void addUID(String portletId, long field1, String field2);
77
78 public void addUID(String portletId, Long field1, String field2);
79
80 public void addUID(String portletId, String field1, String field2);
81
82 public void addUID(
83 String portletId, String field1, String field2, String field3);
84
85 public String get(String name);
86
87 public Date getDate(String name) throws ParseException;
88
89 public String[] getValues(String name);
90
91 public Map<String, Field> getFields();
92
93 }