org.hibernate.search.annotations
Annotation Type IndexedEmbedded


@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
@Documented
public @interface IndexedEmbedded


Optional Element Summary
 int depth
          Stop indexing embedded elements when depth is reached depth=1 means the associated element is indexed, but not its embedded elements.
 String[] includePaths
          List which paths of the object graph should be included in the index, and need to match the field names used to store them in the index, so they will also match the field names used to specify full text queries.
 String indexNullAs
           
 String prefix
          Field name prefix Default to 'propertyname.'
 Class<?> targetElement
          Overrides the type of an association.
 

prefix

public abstract String prefix
Field name prefix Default to 'propertyname.'

Default:
"."

includePaths

public abstract String[] includePaths

List which paths of the object graph should be included in the index, and need to match the field names used to store them in the index, so they will also match the field names used to specify full text queries.

Defined paths are going to be indexed even if they exceed the depth threshold. When includePaths is not empty, the default value for depth is 0.

Defined paths are implicitly prefixed with the prefix().

Default:
{}

depth

public abstract int depth

Stop indexing embedded elements when depth is reached depth=1 means the associated element is indexed, but not its embedded elements.

The default value depends on the value of the includePaths attribute: if no paths are defined, the default is Integer.MAX_VALUE; if any includePaths are defined, the default depth is interpreted as 0 if not specified to a different value than it's default.

Note that when defining any path to the includePaths attribute the default is zero also when explicitly set to Integer.MAX_VALUE.

Default:
2147483647

targetElement

public abstract Class<?> targetElement
Overrides the type of an association. If a collection, overrides the type of the collection generics

Default:
void.class

indexNullAs

public abstract String indexNullAs
Returns:
Returns the value to be used for indexing null. Per default IndexedEmbedded.DO_NOT_INDEX_NULL is returned indicating that null values are not indexed.
Default:
"__DO_NOT_INDEX_NULL__"


Copyright © 2006-2012 Red Hat Middleware, LLC. All Rights Reserved