1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.kernel.search;
16  
17  import java.io.File;
18  import java.io.IOException;
19  import java.io.InputStream;
20  import java.io.Serializable;
21  
22  import java.text.ParseException;
23  
24  import java.util.Date;
25  import java.util.Map;
26  
27  /**
28   * <a href="Document.java.html"><b><i>View Source</i></b></a>
29   *
30   * @author Brian Wing Shun Chan
31   * @author Bruno Farache
32   */
33  public interface Document extends Serializable {
34  
35      public void add(Field field);
36  
37      public void addDate(String name, Date value);
38  
39      public void addFile(String name, byte[] bytes, String fileExt)
40          throws IOException;
41  
42      public void addFile(String name, File file, String fileExt)
43          throws IOException;
44  
45      public void addFile(String name, InputStream is, String fileExt)
46          throws IOException;
47  
48      public void addKeyword(String name, boolean value);
49  
50      public void addKeyword(String name, Boolean value);
51  
52      public void addKeyword(String name, boolean[] values);
53  
54      public void addKeyword(String name, Boolean[] values);
55  
56      public void addKeyword(String name, double value);
57  
58      public void addKeyword(String name, Double value);
59  
60      public void addKeyword(String name, double[] values);
61  
62      public void addKeyword(String name, Double[] values);
63  
64      public void addKeyword(String name, int value);
65  
66      public void addKeyword(String name, int[] values);
67  
68      public void addKeyword(String name, Integer value);
69  
70      public void addKeyword(String name, Integer[] values);
71  
72      public void addKeyword(String name, long value);
73  
74      public void addKeyword(String name, Long value);
75  
76      public void addKeyword(String name, long[] values);
77  
78      public void addKeyword(String name, Long[] values);
79  
80      public void addKeyword(String name, short value);
81  
82      public void addKeyword(String name, Short value);
83  
84      public void addKeyword(String name, short[] values);
85  
86      public void addKeyword(String name, Short[] values);
87  
88      public void addKeyword(String name, String value);
89  
90      public void addKeyword(String name, String value, boolean lowerCase);
91  
92      public void addKeyword(String name, String[] values);
93  
94      public void addModifiedDate();
95  
96      public void addModifiedDate(Date modifiedDate);
97  
98      public void addText(String name, String value);
99  
100     public void addUID(String portletId, long field1);
101 
102     public void addUID(String portletId, long field1, String field2);
103 
104     public void addUID(String portletId, Long field1);
105 
106     public void addUID(String portletId, Long field1, String field2);
107 
108     public void addUID(String portletId, String field1);
109 
110     public void addUID(String portletId, String field1, String field2);
111 
112     public void addUID(
113         String portletId, String field1, String field2, String field3);
114 
115     public void addUID(
116         String portletId, String field1, String field2, String field3,
117         String field4);
118 
119     public String get(String name);
120 
121     public Date getDate(String name) throws ParseException;
122 
123     public Map<String, Field> getFields();
124 
125     public String[] getValues(String name);
126 
127 }