Project

General

Profile

Revision a2ae5990

IDa2ae5990561ed16741b1db2608fe310085e20bcc
Parent e29dff1d
Child f1b276ef

Added by Andreas Kohlbecker over 5 years ago

#4408 - updating documentation on Marked area filter regarding fallback areas

View differences:

cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/utility/DescriptionUtility.java
43 43
     * Filters the given set of {@link Distribution}s for publication purposes
44 44
     * The following rules are respected during the filtering:
45 45
     * <ol>
46
     * <li><b>Marked area filter</b>: Skip distributions where the area has a {@link Marker}
47
     * with one of the specified {@link MarkerType}s
48
     * <li><b>Fallback Area filter</b>: Areas can be tagged as fallback area by assigning
49
     * a {@link Marker} of the specified {@link MarkerType}.
50
     * These areas will be skipped as long not a a Distribution for any of sub areas exists,
51
     * see https://dev.e-taxonomy.eu/trac/ticket/4408 for a detailed discussion.</li>
46
     * <li><b>Marked area filter</b>: Skip distributions for areas having a {@code TRUE} {@link Marker}
47
     * with one of the specified {@link MarkerType}s. Existing sub-areas of a marked area must also be marked
48
     * with the same marker type, otherwise the marked area acts as a <b>fallback area</b> for the sub areas.
49
     * An area is a <b>fallback area</b> if it is marked to be hidden and if it has at least one of
50
     * sub area which is not marked to be hidden. The fallback area will be show if there is no {@link Distribution}
51
     * for any of the non hidden sub-areas. For more detailed discussion on fallback areas see
52
     * https://dev.e-taxonomy.eu/trac/ticket/4408</li>
52 53
     * <li><b>Prefer computed rule</b>:Computed distributions are preferred over entered or imported elements.
53 54
     * (Computed description elements are identified by the {@link
54 55
     * MarkerType.COMPUTED()}). This means if a entered or imported status

Also available in: Unified diff

Add picture from clipboard (Maximum size: 40 MB)