com.sptci.jdo.annotation

Annotation Type Searchable

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value={TYPE,FIELD})
public @interface Searchable

Annotation for class fields that are to be indexed for full-text search. When specified at the class level, it is possible to specify a number of fields that are to be indexed as a combination making for easier search queries.

© Copyright 2009 Sans Pareil Technologies, Inc.

Version:

$Id: Searchable.java 4570 2009-01-22 17:36:49Z rakesh $

Author:

Rakesh Vidyadharan 2009-1-13

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NULL The default value for members() indicating a null value.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	members The name of the fields in the prevalent object to index.
String	name The name of the field within the lucene document that is represented by this index.

Field Detail

NULL

public static final String NULL

The default value for members() indicating a null value.

Element Detail

name

public abstract String name

The name of the field within the lucene document that is represented by this index. Specify only for composite indices (specified at class level. When annotated at the field level, the name of the field is taken as the indexed field name. If not specified a name that is the concatenation of the field names in members() will be used. Using the default value will make it harder to compile queries, so it is recommended that you specify this value as well.

Returns:

The name of the indexed field.

Default:

""

members

public abstract String[] members

The name of the fields in the prevalent object to index. This need only be specified when specified at the class level. Multiple fields may be specified to indicate a composite search index (tokenised and stored as a common index for easy search). Defaults to NULL.

Returns:

The name of the fields.

Default:

""