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 index, but not its embedded elements Default: infinite (an exception will be raised if a class circular reference occurs while infinite is chosen)
 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:
"."

depth

public abstract int depth
Stop indexing embedded elements when depth is reached depth=1 means the associated element is index, but not its embedded elements Default: infinite (an exception will be raised if a class circular reference occurs while infinite is chosen)

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 Hibernate. All Rights Reserved.