org.lsst.ccs.commons.annotations

Annotation Type LookupField

@Target(value=FIELD)
 @Retention(value=RUNTIME)
 @Documented
public @interface LookupField

This field annotation allows to access other components from a given component that belongs to the component tree. Given a tree travel LookupField.Strategy, it allows to collect one or more traveled components, depending on the type of the annotated field. If the annotated field is an array or a Collection (supported collections are Map<String, T>, List<T>, Set<T>, T[]), traveled components are collected only if they can be assigned to the elementary field type, until the travel ends. For arrays and collection, components are inserted in pre-order (parents first, children then). In case of maps, the pre-order is preserved only if the map implementation preserves insertion order. If the annotated field is not of a compound type, the first component met during the tree travel that is assignable to the field type is set to the annotated field.

Author:

LSST CCS Team

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
LookupField.Strategy	strategy The travel strategy.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	pathFilter A regular expression to be used to filter on the path of the selected elements.

Element Detail

strategy

public abstract LookupField.Strategy strategy

The travel strategy.

Returns:

the travel strategy

pathFilter

public abstract String pathFilter

A regular expression to be used to filter on the path of the selected elements. The meaning of the resulting path depends on the selected Strategy. For the following strategies: - DESCENDANDS, CHILDREN the path is the relative path of the found component with respect to the object whose filed is annotated (for CHILDREN it's just the name of the component) - BYNAME, TOP and SIBLINGS will return the name (key) of the found components - TREE, ANCESTOR the returned path is the full path of the found components

Returns:

The regular expression to filter on the path

Default:

""