org.mongodb.morphia.annotations.Text Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of morphia Show documentation

Java Object Document Mapper for MongoDB

The newest version!

package org.mongodb.morphia.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Marks this field for inclusion in text indexing.  There can only be on instance of this field on a class/collection due to the server
 * limiting one text index per collection.
 */
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Text {
    /**
     * Options to apply to the index
     */
    IndexOptions options() default @IndexOptions;

    /**
     * Weight of the field. If a weight is omitted from this item, the weight is assumed to the database default.
     */
    int value() default -1;
}