org.mmbase.module.lucene

Class IndexFieldDefinition

java.lang.Object

org.mmbase.bridge.util.xml.query.FieldDefinition

org.mmbase.module.lucene.IndexFieldDefinition

public class IndexFieldDefinition
extends FieldDefinition

Defines options for a field to index.

Version:

$Id$

Author:

Pierre van Rooden

Field Summary

Fields

Modifier and Type	Field and Description
String	alias If not null, this is the fieldname under which the value is indexed.
float	boost
String	decryptionPassword Password for unlocking the content of binary fields that may contain encrypted pdf documents.
String	escaper The escaper to use when including the field's value.
boolean	keyWord If true, the field's value is stored as a keyword.
Indexer.Multiple	multiple
String	split
boolean	storeText If true, the field's value is stored and can be returned when search results are given.

Fields inherited from class org.mmbase.bridge.util.xml.query.FieldDefinition

fieldName, optional, stepField

Constructor Summary

Constructors

Constructor and Description
IndexFieldDefinition(boolean storeTextDefault, boolean mergeTextDefault, Set<String> allIndexedFieldsSet)

Method Summary

Modifier and Type	Method and Description
void	configure(Element fieldElement) Configures the field definition, using data from a DOM element
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

keyWord

public boolean keyWord

If true, the field's value is stored as a keyword.

escaper

public String escaper

The escaper to use when including the field's value.

storeText

public boolean storeText

If true, the field's value is stored and can be returned when search results are given.

alias

public String alias

If not null, this is the fieldname under which the value is indexed. Fieldnames with similar values are pooled together.

decryptionPassword

public String decryptionPassword

Password for unlocking the content of binary fields that may contain encrypted pdf documents.

multiple

public Indexer.Multiple multiple

boost

public float boost

split

public String split

Constructor Detail

IndexFieldDefinition

IndexFieldDefinition(boolean storeTextDefault,
                     boolean mergeTextDefault,
                     Set<String> allIndexedFieldsSet)

Method Detail

configure

public void configure(Element fieldElement)

Description copied from class: FieldDefinition

Configures the field definition, using data from a DOM element

Overrides:

configure in class FieldDefinition

toString

public String toString()

Overrides:

toString in class Object