org.compass.annotations
Annotation Type SearchConverter

@Target(value=PACKAGE)
@Retention(value=RUNTIME)
public @interface SearchConverter

Configure Converter to be used within Compass. Set on package definition (package-info.java).

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

Author:

kimchy

Required Element Summary

String	name The name the Converter will be registered under.
Class<? extends Converter>	type The Converter implementation.

Optional Element Summary

Class	registerClass Optional, the actual java type this converter will be used for.
SearchSetting[]	settings Settings for the Converter implemenation.

Element Detail

name

public abstract String name

The name the Converter will be registered under.

type

public abstract Class<? extends Converter> type

The Converter implementation.

registerClass

public abstract Class registerClass

Optional, the actual java type this converter will be used for. If used, this converter will be applies to all the types of this class.

Default:

java.lang.Object.class

settings

public abstract SearchSetting[] settings

Settings for the Converter implemenation. If set, the Converter should implement the CompassConfigurable interface.

Default:

{}