com.datastax.driver.mapping

Class DefaultHierarchyScanStrategy

java.lang.Object

com.datastax.driver.mapping.DefaultHierarchyScanStrategy

All Implemented Interfaces:

HierarchyScanStrategy

public class DefaultHierarchyScanStrategy
extends Object
implements HierarchyScanStrategy

The default HierarchyScanStrategy.

This strategy assumes that there exists a common ancestor for all mapped classes in the application, and allows all its descendants (optionally including itself) to be scanned for annotations.

Constructor Summary

Constructors

Constructor and Description
DefaultHierarchyScanStrategy() Creates a new instance with defaults: the common ancestor is Object excluded, which implies that every ancestor of a mapped class, except Object itself, will be scanned for annotations.
DefaultHierarchyScanStrategy(Class<?> highestAncestor, boolean included) Creates a new instance with the given highest common ancestor.

Method Summary

Modifier and Type	Method and Description
List<Class<?>>	filterClassHierarchy(Class<?> mappedClass) Computes the ancestors of the given base class, optionally filtering out any ancestor that should not be scanned.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHierarchyScanStrategy

public DefaultHierarchyScanStrategy()

Creates a new instance with defaults: the common ancestor is Object excluded, which implies that every ancestor of a mapped class, except Object itself, will be scanned for annotations.

DefaultHierarchyScanStrategy

public DefaultHierarchyScanStrategy(Class<?> highestAncestor,
                                    boolean included)

Creates a new instance with the given highest common ancestor.

Parameters:

highestAncestor - The highest ancestor class to consider; cannot be null.

included - Whether or not to include the highest ancestor itself.

Method Detail

filterClassHierarchy

public List<Class<?>> filterClassHierarchy(Class<?> mappedClass)

Description copied from interface: HierarchyScanStrategy

Computes the ancestors of the given base class, optionally filtering out any ancestor that should not be scanned.

Implementors should always include mappedClass in the returned list.

Specified by:

filterClassHierarchy in interface HierarchyScanStrategy

Parameters:

mappedClass - The mapped class; this is necessarily a class annotated with either @Table or @UDT.

Returns:

the list of classes that should be scanned, including mappedClass itself and its ancestors, ordered from the lowest (closest to mappedClass) to the highest (or farthest from mappedClass).