1   /**
2    * Copyright (c) 2000-2009 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, byte[] bytes, String fileExt)
48          throws IOException;
49  
50      public void addFile(String name, File file, String fileExt)
51          throws IOException;
52  
53      public void addFile(String name, InputStream is, String fileExt)
54          throws IOException;
55  
56      public void addKeyword(String name, boolean value);
57  
58      public void addKeyword(String name, Boolean value);
59  
60      public void addKeyword(String name, boolean[] values);
61  
62      public void addKeyword(String name, Boolean[] values);
63  
64      public void addKeyword(String name, double value);
65  
66      public void addKeyword(String name, Double value);
67  
68      public void addKeyword(String name, double[] values);
69  
70      public void addKeyword(String name, Double[] values);
71  
72      public void addKeyword(String name, int value);
73  
74      public void addKeyword(String name, int[] values);
75  
76      public void addKeyword(String name, Integer value);
77  
78      public void addKeyword(String name, Integer[] values);
79  
80      public void addKeyword(String name, long value);
81  
82      public void addKeyword(String name, Long value);
83  
84      public void addKeyword(String name, long[] values);
85  
86      public void addKeyword(String name, Long[] values);
87  
88      public void addKeyword(String name, short value);
89  
90      public void addKeyword(String name, Short value);
91  
92      public void addKeyword(String name, short[] values);
93  
94      public void addKeyword(String name, Short[] values);
95  
96      public void addKeyword(String name, String value);
97  
98      public void addKeyword(String name, String value, boolean lowerCase);
99  
100     public void addKeyword(String name, String[] values);
101 
102     public void addModifiedDate();
103 
104     public void addModifiedDate(Date modifiedDate);
105 
106     public void addText(String name, String value);
107 
108     public void addUID(String portletId, long field1);
109 
110     public void addUID(String portletId, long field1, String field2);
111 
112     public void addUID(String portletId, Long field1);
113 
114     public void addUID(String portletId, Long field1, String field2);
115 
116     public void addUID(String portletId, String field1);
117 
118     public void addUID(String portletId, String field1, String field2);
119 
120     public void addUID(
121         String portletId, String field1, String field2, String field3);
122 
123     public void addUID(
124         String portletId, String field1, String field2, String field3,
125         String field4);
126 
127     public String get(String name);
128 
129     public Date getDate(String name) throws ParseException;
130 
131     public Map<String, Field> getFields();
132 
133     public String[] getValues(String name);
134 
135 }