com.liferay.portal.kernel.search

Interface Document

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

DocumentImpl

@ProviderType
public interface Document
extends java.lang.Cloneable, java.io.Serializable

Author:

Brian Wing Shun Chan, Bruno Farache

Method Summary

Modifier and Type	Method and Description
void	add(Field field)
void	addDate(java.lang.String name, java.util.Date value)
void	addDate(java.lang.String name, java.util.Date[] values)
void	addDateSortable(java.lang.String name, java.util.Date value)
void	addDateSortable(java.lang.String name, java.util.Date[] values)
void	addFile(java.lang.String name, byte[] bytes, java.lang.String fileExt)
void	addFile(java.lang.String name, java.io.File file, java.lang.String fileExt)
void	addFile(java.lang.String name, java.io.InputStream is, java.lang.String fileExt)
void	addFile(java.lang.String name, java.io.InputStream is, java.lang.String fileExt, int maxStringLength)
void	addGeoLocation(double latitude, double longitude)
void	addGeoLocation(java.lang.String name, double latitude, double longitude)
void	addKeyword(java.lang.String name, boolean value)
void	addKeyword(java.lang.String name, java.lang.Boolean value)
void	addKeyword(java.lang.String name, boolean[] values)
void	addKeyword(java.lang.String name, java.lang.Boolean[] values)
void	addKeyword(java.lang.String name, double value)
void	addKeyword(java.lang.String name, java.lang.Double value)
void	addKeyword(java.lang.String name, double[] values)
void	addKeyword(java.lang.String name, java.lang.Double[] values)
void	addKeyword(java.lang.String name, float value)
void	addKeyword(java.lang.String name, java.lang.Float value)
void	addKeyword(java.lang.String name, float[] values)
void	addKeyword(java.lang.String name, java.lang.Float[] values)
void	addKeyword(java.lang.String name, int value)
void	addKeyword(java.lang.String name, int[] values)
void	addKeyword(java.lang.String name, java.lang.Integer value)
void	addKeyword(java.lang.String name, java.lang.Integer[] values)
void	addKeyword(java.lang.String name, long value)
void	addKeyword(java.lang.String name, java.lang.Long value)
void	addKeyword(java.lang.String name, long[] values)
void	addKeyword(java.lang.String name, java.lang.Long[] values)
void	addKeyword(java.lang.String name, short value)
void	addKeyword(java.lang.String name, java.lang.Short value)
void	addKeyword(java.lang.String name, short[] values)
void	addKeyword(java.lang.String name, java.lang.Short[] values)
void	addKeyword(java.lang.String name, java.lang.String value)
void	addKeyword(java.lang.String name, java.lang.String[] values)
void	addKeyword(java.lang.String name, java.lang.String value, boolean lowerCase)
void	addKeywordSortable(java.lang.String name, java.lang.Boolean value)
void	addKeywordSortable(java.lang.String name, java.lang.Boolean[] values)
void	addKeywordSortable(java.lang.String name, java.lang.String value)
void	addKeywordSortable(java.lang.String name, java.lang.String[] values)
void	addLocalizedKeyword(java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> values)
void	addLocalizedKeyword(java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> values, boolean lowerCase)
void	addLocalizedKeyword(java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> values, boolean lowerCase, boolean sortable)
void	addLocalizedText(java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> values)
void	addNumber(java.lang.String name, java.math.BigDecimal value)
void	addNumber(java.lang.String name, java.math.BigDecimal[] values)
void	addNumber(java.lang.String name, double value)
void	addNumber(java.lang.String name, java.lang.Double value)
void	addNumber(java.lang.String name, double[] values)
void	addNumber(java.lang.String name, java.lang.Double[] values)
void	addNumber(java.lang.String name, float value)
void	addNumber(java.lang.String name, java.lang.Float value)
void	addNumber(java.lang.String name, float[] values)
void	addNumber(java.lang.String name, java.lang.Float[] values)
void	addNumber(java.lang.String name, int value)
void	addNumber(java.lang.String name, int[] values)
void	addNumber(java.lang.String name, java.lang.Integer value)
void	addNumber(java.lang.String name, java.lang.Integer[] values)
void	addNumber(java.lang.String name, long value)
void	addNumber(java.lang.String name, java.lang.Long value)
void	addNumber(java.lang.String name, long[] values)
void	addNumber(java.lang.String name, java.lang.Long[] values)
void	addNumber(java.lang.String name, java.lang.String value)
void	addNumber(java.lang.String name, java.lang.String[] values)
void	addNumberSortable(java.lang.String name, java.math.BigDecimal value)
void	addNumberSortable(java.lang.String name, java.math.BigDecimal[] values)
void	addNumberSortable(java.lang.String name, java.lang.Double value)
void	addNumberSortable(java.lang.String name, java.lang.Double[] values)
void	addNumberSortable(java.lang.String name, java.lang.Float value)
void	addNumberSortable(java.lang.String name, java.lang.Float[] values)
void	addNumberSortable(java.lang.String name, java.lang.Integer value)
void	addNumberSortable(java.lang.String name, java.lang.Integer[] values)
void	addNumberSortable(java.lang.String name, java.lang.Long value)
void	addNumberSortable(java.lang.String name, java.lang.Long[] values)
void	addText(java.lang.String name, java.lang.String value)
void	addText(java.lang.String name, java.lang.String[] values)
void	addTextSortable(java.lang.String name, java.lang.String value)
void	addTextSortable(java.lang.String name, java.lang.String[] values)
void	addUID(java.lang.String portletId, long field1)
void	addUID(java.lang.String portletId, java.lang.Long field1)
void	addUID(java.lang.String portletId, long field1, java.lang.String field2)
void	addUID(java.lang.String portletId, java.lang.Long field1, java.lang.String field2)
void	addUID(java.lang.String portletId, java.lang.String field1)
void	addUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2)
void	addUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2, java.lang.String field3)
void	addUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2, java.lang.String field3, java.lang.String field4)
java.lang.Object	clone()
java.lang.String	get(java.util.Locale locale, java.lang.String name)
java.lang.String	get(java.util.Locale locale, java.lang.String name, java.lang.String defaultName)
java.lang.String	get(java.lang.String name)
java.lang.String	get(java.lang.String name, java.lang.String defaultName)
java.util.Date	getDate(java.lang.String name)
Field	getField(java.lang.String name)
java.util.Map<java.lang.String,Field>	getFields()
java.lang.String	getPortletId()
java.lang.String	getUID()
java.lang.String[]	getValues(java.lang.String name)
boolean	hasField(java.lang.String name)
boolean	isDocumentSortableTextField(java.lang.String name)
void	remove(java.lang.String name)
void	setSortableTextFields(java.lang.String[] sortableTextFields)

Method Detail

add

void add(Field field)

addDate

void addDate(java.lang.String name,
             java.util.Date value)

addDate

void addDate(java.lang.String name,
             java.util.Date[] values)

addDateSortable

void addDateSortable(java.lang.String name,
                     java.util.Date value)

addDateSortable

void addDateSortable(java.lang.String name,
                     java.util.Date[] values)

addFile

void addFile(java.lang.String name,
             byte[] bytes,
             java.lang.String fileExt)
      throws java.io.IOException

Throws:

java.io.IOException

addFile

void addFile(java.lang.String name,
             java.io.File file,
             java.lang.String fileExt)
      throws java.io.IOException

Throws:

java.io.IOException

addFile

void addFile(java.lang.String name,
             java.io.InputStream is,
             java.lang.String fileExt)
      throws java.io.IOException

Throws:

java.io.IOException

addFile

void addFile(java.lang.String name,
             java.io.InputStream is,
             java.lang.String fileExt,
             int maxStringLength)
      throws java.io.IOException

Throws:

java.io.IOException

addGeoLocation

void addGeoLocation(double latitude,
                    double longitude)

addGeoLocation

void addGeoLocation(java.lang.String name,
                    double latitude,
                    double longitude)

addKeyword

void addKeyword(java.lang.String name,
                boolean value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Boolean value)

addKeyword

void addKeyword(java.lang.String name,
                boolean[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Boolean[] values)

addKeyword

void addKeyword(java.lang.String name,
                double value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Double value)

addKeyword

void addKeyword(java.lang.String name,
                double[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Double[] values)

addKeyword

void addKeyword(java.lang.String name,
                float value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Float value)

addKeyword

void addKeyword(java.lang.String name,
                float[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Float[] values)

addKeyword

void addKeyword(java.lang.String name,
                int value)

addKeyword

void addKeyword(java.lang.String name,
                int[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Integer value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Integer[] values)

addKeyword

void addKeyword(java.lang.String name,
                long value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Long value)

addKeyword

void addKeyword(java.lang.String name,
                long[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Long[] values)

addKeyword

void addKeyword(java.lang.String name,
                short value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Short value)

addKeyword

void addKeyword(java.lang.String name,
                short[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.Short[] values)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.String value)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.String value,
                boolean lowerCase)

addKeyword

void addKeyword(java.lang.String name,
                java.lang.String[] values)

addKeywordSortable

void addKeywordSortable(java.lang.String name,
                        java.lang.Boolean value)

addKeywordSortable

void addKeywordSortable(java.lang.String name,
                        java.lang.Boolean[] values)

addKeywordSortable

void addKeywordSortable(java.lang.String name,
                        java.lang.String value)

addKeywordSortable

void addKeywordSortable(java.lang.String name,
                        java.lang.String[] values)

addLocalizedKeyword

void addLocalizedKeyword(java.lang.String name,
                         java.util.Map<java.util.Locale,java.lang.String> values)

addLocalizedKeyword

void addLocalizedKeyword(java.lang.String name,
                         java.util.Map<java.util.Locale,java.lang.String> values,
                         boolean lowerCase)

addLocalizedKeyword

void addLocalizedKeyword(java.lang.String name,
                         java.util.Map<java.util.Locale,java.lang.String> values,
                         boolean lowerCase,
                         boolean sortable)

addLocalizedText

void addLocalizedText(java.lang.String name,
                      java.util.Map<java.util.Locale,java.lang.String> values)

addNumber

void addNumber(java.lang.String name,
               java.math.BigDecimal value)

addNumber

void addNumber(java.lang.String name,
               java.math.BigDecimal[] values)

addNumber

void addNumber(java.lang.String name,
               double value)

addNumber

void addNumber(java.lang.String name,
               java.lang.Double value)

addNumber

void addNumber(java.lang.String name,
               double[] values)

addNumber

void addNumber(java.lang.String name,
               java.lang.Double[] values)

addNumber

void addNumber(java.lang.String name,
               float value)

addNumber

void addNumber(java.lang.String name,
               java.lang.Float value)

addNumber

void addNumber(java.lang.String name,
               float[] values)

addNumber

void addNumber(java.lang.String name,
               java.lang.Float[] values)

addNumber

void addNumber(java.lang.String name,
               int value)

addNumber

void addNumber(java.lang.String name,
               int[] values)

addNumber

void addNumber(java.lang.String name,
               java.lang.Integer value)

addNumber

void addNumber(java.lang.String name,
               java.lang.Integer[] values)

addNumber

void addNumber(java.lang.String name,
               long value)

addNumber

void addNumber(java.lang.String name,
               java.lang.Long value)

addNumber

void addNumber(java.lang.String name,
               long[] values)

addNumber

void addNumber(java.lang.String name,
               java.lang.Long[] values)

addNumber

void addNumber(java.lang.String name,
               java.lang.String value)

addNumber

void addNumber(java.lang.String name,
               java.lang.String[] values)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.math.BigDecimal value)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.math.BigDecimal[] values)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Double value)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Double[] values)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Float value)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Float[] values)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Integer value)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Integer[] values)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Long value)

addNumberSortable

void addNumberSortable(java.lang.String name,
                       java.lang.Long[] values)

addText

void addText(java.lang.String name,
             java.lang.String value)

addText

void addText(java.lang.String name,
             java.lang.String[] values)

addTextSortable

void addTextSortable(java.lang.String name,
                     java.lang.String value)

addTextSortable

void addTextSortable(java.lang.String name,
                     java.lang.String[] values)

addUID

void addUID(java.lang.String portletId,
            long field1)

addUID

void addUID(java.lang.String portletId,
            long field1,
            java.lang.String field2)

addUID

void addUID(java.lang.String portletId,
            java.lang.Long field1)

addUID

void addUID(java.lang.String portletId,
            java.lang.Long field1,
            java.lang.String field2)

addUID

void addUID(java.lang.String portletId,
            java.lang.String field1)

addUID

void addUID(java.lang.String portletId,
            java.lang.String field1,
            java.lang.String field2)

addUID

void addUID(java.lang.String portletId,
            java.lang.String field1,
            java.lang.String field2,
            java.lang.String field3)

addUID

void addUID(java.lang.String portletId,
            java.lang.String field1,
            java.lang.String field2,
            java.lang.String field3,
            java.lang.String field4)

clone

java.lang.Object clone()

get

java.lang.String get(java.util.Locale locale,
                     java.lang.String name)

get

java.lang.String get(java.util.Locale locale,
                     java.lang.String name,
                     java.lang.String defaultName)

get

java.lang.String get(java.lang.String name)

get

java.lang.String get(java.lang.String name,
                     java.lang.String defaultName)

getDate

java.util.Date getDate(java.lang.String name)
                throws java.text.ParseException

Throws:

java.text.ParseException

getField

Field getField(java.lang.String name)

getFields

java.util.Map<java.lang.String,Field> getFields()

getPortletId

java.lang.String getPortletId()

getUID

java.lang.String getUID()

getValues

java.lang.String[] getValues(java.lang.String name)

hasField

boolean hasField(java.lang.String name)

isDocumentSortableTextField

boolean isDocumentSortableTextField(java.lang.String name)

remove

void remove(java.lang.String name)

setSortableTextFields

void setSortableTextFields(java.lang.String[] sortableTextFields)