Package qupath.lib.interfaces

Interface MinimalMetadataStore

All Known Subinterfaces:
MetadataStore, Project<T>, ProjectImageEntry<T>
All Known Implementing Classes:
ParallelTileObject, PathAnnotationObject, PathCellObject, PathDetectionObject, PathObject, PathROIObject, PathRootObject, PathTileObject, TMACoreObject
public interface MinimalMetadataStore
Minimal interface to indicate that an object can provide a map of metadata key/value pairs.

In some use-cases, there will be a need to store some metadata values for internal use and others that should be visible to the user. When this is the case, it is suggested to use the convention that metadata keys that start with "_" are to be used internally, but this is not enforced by this interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,String>
    getMetadata()
    Returns a modifiable map containing the metadata.

  • Method Details

    • getMetadata

      Map<String,String> getMetadata()
      Returns a modifiable map containing the metadata.

      The returned map may or may not be thread-safe. Implementing classes must document the thread-safeness of the map.

      Returns:
      the metadata of this store