Package org.gbif.api.model.collections

Annotation Interface Sourceable

@Documented @Retention(RUNTIME) @Target(FIELD) @Repeatable(Sourceables.class) public @interface Sourceable
Annotation to indicate that a field can be populated from external sources.

This is used in GRSciColl to flag fields whose value comes from other sources rather than GRSciColl such as IH, datasets or organizations.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    MasterSourceType[]
    masterSources
     
    boolean
    overridable
    Indicates that a field is initially filled from an external source, but it can be overwritten afterwards.
    String[]
    sourceableParts
    Indicates that only some parts are sourceable.

  • Element Details

    • masterSources

      MasterSourceType[] masterSources
      Default:
      {}

    • sourceableParts

      String[] sourceableParts
      Indicates that only some parts are sourceable. If this field is not set it's assumed that the whole field is sourceable.

      This applies only to lists or similar. For example, a list of identifiers where only the DOI identifiers are sourceable would set this field as {DOI}.

      Default:
      {}

    • overridable

      boolean overridable
      Indicates that a field is initially filled from an external source, but it can be overwritten afterwards.

      E.g.: the names of IH collections.

      Default:
      false