001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
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.Map;
026    
027    /**
028     * @author Brian Wing Shun Chan
029     * @author Bruno Farache
030     */
031    public interface Document extends Serializable {
032    
033            public void add(Field field);
034    
035            public void addDate(String name, Date value);
036    
037            public void addFile(String name, byte[] bytes, String fileExt)
038                    throws IOException;
039    
040            public void addFile(String name, File file, String fileExt)
041                    throws IOException;
042    
043            public void addFile(String name, InputStream is, String fileExt)
044                    throws IOException;
045    
046            public void addKeyword(String name, boolean value);
047    
048            public void addKeyword(String name, Boolean value);
049    
050            public void addKeyword(String name, boolean[] values);
051    
052            public void addKeyword(String name, Boolean[] values);
053    
054            public void addKeyword(String name, double value);
055    
056            public void addKeyword(String name, Double value);
057    
058            public void addKeyword(String name, double[] values);
059    
060            public void addKeyword(String name, Double[] values);
061    
062            public void addKeyword(String name, float value);
063    
064            public void addKeyword(String name, Float value);
065    
066            public void addKeyword(String name, float[] values);
067    
068            public void addKeyword(String name, Float[] values);
069    
070            public void addKeyword(String name, int value);
071    
072            public void addKeyword(String name, int[] values);
073    
074            public void addKeyword(String name, Integer value);
075    
076            public void addKeyword(String name, Integer[] values);
077    
078            public void addKeyword(String name, long value);
079    
080            public void addKeyword(String name, Long value);
081    
082            public void addKeyword(String name, long[] values);
083    
084            public void addKeyword(String name, Long[] values);
085    
086            public void addKeyword(String name, short value);
087    
088            public void addKeyword(String name, Short value);
089    
090            public void addKeyword(String name, short[] values);
091    
092            public void addKeyword(String name, Short[] values);
093    
094            public void addKeyword(String name, String value);
095    
096            public void addKeyword(String name, String value, boolean lowerCase);
097    
098            public void addKeyword(String name, String[] values);
099    
100            public void addModifiedDate();
101    
102            public void addModifiedDate(Date modifiedDate);
103    
104            public void addText(String name, String value);
105    
106            public void addUID(String portletId, long field1);
107    
108            public void addUID(String portletId, long field1, String field2);
109    
110            public void addUID(String portletId, Long field1);
111    
112            public void addUID(String portletId, Long field1, String field2);
113    
114            public void addUID(String portletId, String field1);
115    
116            public void addUID(String portletId, String field1, String field2);
117    
118            public void addUID(
119                    String portletId, String field1, String field2, String field3);
120    
121            public void addUID(
122                    String portletId, String field1, String field2, String field3,
123                    String field4);
124    
125            public String get(String name);
126    
127            public Date getDate(String name) throws ParseException;
128    
129            public Map<String, Field> getFields();
130    
131            public String getUID();
132    
133            public String[] getValues(String name);
134    
135    }