com.adobe.cq.social.ugc.api

Class UgcIndexProperty

java.lang.Object

com.adobe.cq.social.ugc.api.UgcIndexProperty

public class UgcIndexProperty
extends java.lang.Object

An index property specified by index handers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UgcIndexProperty.Index The index types.

Constructor Summary

Constructors

Constructor and Description
UgcIndexProperty(java.lang.String name, java.lang.Object value, boolean store, UgcIndexProperty.Index index) Create a UgcIndexProperty by specifying its name, value and how it will be saved in the index.
UgcIndexProperty(java.lang.String name, java.lang.Object value, boolean store, UgcIndexProperty.Index index, boolean fulltext) Create a UgcIndexProperty by specifying its name, value and how it will be saved in the index.

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.document.Field.Index	getFieldIndex() Return the field index.
UgcIndexProperty.Index	getIndex() Return the index type.
java.lang.String	getName() Return property name.
java.lang.Object	getValue() Return property value.
boolean	isFullText() Return fulltext.
boolean	isStore() Return true if store.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UgcIndexProperty

public UgcIndexProperty(java.lang.String name,
                        java.lang.Object value,
                        boolean store,
                        UgcIndexProperty.Index index)

Create a UgcIndexProperty by specifying its name, value and how it will be saved in the index.

Parameters:

name - The name of the field

value - The string to process

store - Whether value should be stored in the index

index - Whether the field should be indexed, and if so, if it should be tokenized before indexing

UgcIndexProperty

public UgcIndexProperty(java.lang.String name,
                        java.lang.Object value,
                        boolean store,
                        UgcIndexProperty.Index index,
                        boolean fulltext)

Create a UgcIndexProperty by specifying its name, value and how it will be saved in the index.

Parameters:

name - The name of the field

value - The string to process

store - Whether value should be stored in the index

index - Whether the field should be indexed, and if so, if it should be tokenized before indexing

fulltext - true if full text.

Method Detail

isFullText

public boolean isFullText()

Return fulltext.

Returns:

the value of fulltext.

getName

public java.lang.String getName()

Return property name.

Returns:

property name.

getValue

public java.lang.Object getValue()

Return property value.

Returns:

property value.

isStore

public boolean isStore()

Return true if store.

Returns:

true if store.

getIndex

public UgcIndexProperty.Index getIndex()

Return the index type.

Returns:

the index type.

getFieldIndex

public org.apache.lucene.document.Field.Index getFieldIndex()

Return the field index.

Returns:

the field index.