org.compass.annotations

The searchable class is associated with an alias, which can be used to reference the class when performing search operations, or for other mappings to extend it.

A class mapping has it's own fully functional index, unless using the Searchable.subIndex() to join several searchable classes into the same index (when joining several searchalbe classes into the same index, the search will be much faster, but updates perform locks on the sub index level, so it might slow it down).

A searchable class creates an internal "all" meta-data, which holds searchable information of all the class searchable content.

The "all" meta-data is an internal meta-data, which holds searchable information of all the class searchable content.

The definitions here are per searchable class definitions.

Specifies a org.compass.annotations.Searchable class field/property that dynamically controls boost value of the class mapped based on its value.

Mostly used to convert classes into a String value that will be stored in the index.

A searchable component is a class field/property that reference another class, which content need to be embedded into the content of its Searchable class.

Each searchable class must have at least one id annotation.

A searchable id component is a class field/property that reference another class, which content need to be embedded into the content of its org.compass.annotations.Searchable class and represents one of its ids.

The referenced class must have searchable definitions, defined either using annotations or other means (like xml).

Compass will try to automatically identify the searchable class mapping definitions that map to the component class.

SearchableId and SearchableProperty can be used to auto-generate meta-data.

The searchable property will automatically create a SearchableMetaData , with its name being the field/property name.

A searchable reference is a class field/property that reference another class, and the relationship need to be stored by Compass so it can be traversed when getting the class from the index.

Compass will end up saving only the ids of the referenced class in the search engine index.

The searchalbe reference can annotate a java.util.Collection type field/property, supporting either java.util.List or java.util.Set .

The Analyzer is registed under a lookup name ( SearchAnalyzer.name() ), which can then be reference in the different mapping definitions.

Allows for simple configuration of all analyzers that come with Compass using SearchAnalyzer.type() . If the SearchAnalyzer.type() is set to AnalyzerType.Snowball , the SearchAnalyzer.snowballType() can be used to further configure the snowball analyzer.

The LuceneAnalyzerTokenFilterProvider is registed under a lookup name ( SearchAnalyzerFilter.name() ), which can then be reference in in the analyzer definition (i.e.