org.compass.core
Class Property.Index

java.lang.Object
  org.compass.core.util.Parameter
      org.compass.core.Property.Index

All Implemented Interfaces:

Serializable

Enclosing interface:

Property

public static final class Property.Index
extends Parameter

Specifies whether and how a meta-data property should be indexed.

See Also:

Serialized Form

Field Summary

static Property.Index	NO Do not index the property value.
static Property.Index	TOKENIZED Index the property's value so it can be searched.
static Property.Index	UN_TOKENIZED Index the property's value without using an Analyzer, so it can be searched.

Method Summary

static Property.Index	fromString(String propertyIndex)
static String	toString(Property.Index propertyIndex)

Methods inherited from class org.compass.core.util.Parameter

readResolve, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO

public static final Property.Index NO

Do not index the property value. This property can thus not be searched, but one can still access its contents provided it is stored.

TOKENIZED

public static final Property.Index TOKENIZED

Index the property's value so it can be searched. An Analyzer will be used to tokenize and possibly further normalize the text before its terms will be stored in the index. This is useful for common text.

UN_TOKENIZED

public static final Property.Index UN_TOKENIZED

Index the property's value without using an Analyzer, so it can be searched. As no analyzer is used the value will be stored as a single term. This is useful for unique Ids like product numbers.

Method Detail

toString

public static String toString(Property.Index propertyIndex)

fromString

public static Property.Index fromString(String propertyIndex)