com.datastax.oss.driver.api.mapper.annotations

Annotation Type HierarchyScanStrategy

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface HierarchyScanStrategy

A strategy to define which ancestors to scan for annotations for Entity-annotated classes and Dao-annotated interfaces.

In addition, properties will also be scanned for on Entity-annotated classes.

By default, the mapper will transparently scan all parent classes and interfaces. The closer in proximity a type is to the base type, the more precedence it is given when scanning. In addition, parent classes are given precedence over interfaces.

For entities, this enables polymorphic mapping of a class hierarchy into different CQL tables or UDTs.

For DAOs, this enables sharing configuration between DAOs by implementing an interface that has annotations defining how the DAO methods should behave.

To disable scanning, set scanAncestors() to false.

To control the highest ancestor considered in scanning for annotations, use highestAncestor() and includeHighestAncestor().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	highestAncestor The Class to consider the highest ancestor, meaning the classes that this class extends or implements will not be scanned for annotations.
boolean	includeHighestAncestor Whether or not to include the specified highestAncestor() in scanning.
boolean	scanAncestors Whether or not ancestors should be scanned for properties and annotations.

Element Detail

scanAncestors

public abstract boolean scanAncestors

Whether or not ancestors should be scanned for properties and annotations.

If false only the Entity class or Dao interface will be scanned.

Defaults to true.

Default:

true

highestAncestor

public abstract Class<?> highestAncestor

The Class to consider the highest ancestor, meaning the classes that this class extends or implements will not be scanned for annotations.

Note that If you have a complex hierarchy involving both parent classes and interfaces and highestAncestor specifies a class for example, all interfaces will still be included. Therefore it is recommended to avoid creating complex type hierarchies or to only do so if you expect the entire hierarchy to be scanned.

Defaults to Object.

Default:

java.lang.Object.class

includeHighestAncestor

public abstract boolean includeHighestAncestor

Whether or not to include the specified highestAncestor() in scanning.

Defaults to false.

Default:

false