MediaMetadataProvider.java

  1. /*
  2.  * #%L
  3.  * *********************************************************************************************************************
  4.  *
  5.  * NorthernWind - lightweight CMS
  6.  * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
  7.  * %%
  8.  * Copyright (C) 2011 - 2021 Tidalwave s.a.s. (http://tidalwave.it)
  9.  * %%
  10.  * *********************************************************************************************************************
  11.  *
  12.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  13.  * the License. You may obtain a copy of the License at
  14.  *
  15.  *     http://www.apache.org/licenses/LICENSE-2.0
  16.  *
  17.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
  18.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  19.  * specific language governing permissions and limitations under the License.
  20.  *
  21.  * *********************************************************************************************************************
  22.  *
  23.  *
  24.  * *********************************************************************************************************************
  25.  * #L%
  26.  */
  27. package it.tidalwave.northernwind.frontend.ui.component.gallery.spi;

  28. import javax.annotation.Nonnull;
  29. import it.tidalwave.util.Id;
  30. import it.tidalwave.northernwind.core.model.ResourceProperties;

  31. /***********************************************************************************************************************
  32.  *
  33.  * Implementations of this interface provide metadata for media rendering.
  34.  *
  35.  * @author  Fabrizio Giudici
  36.  *
  37.  **********************************************************************************************************************/
  38. @FunctionalInterface
  39. public interface MediaMetadataProvider
  40.   {
  41.     /*******************************************************************************************************************
  42.      *
  43.      * A default implementation that always returns an empty string.
  44.      *
  45.      ******************************************************************************************************************/
  46.     public static final MediaMetadataProvider VOID = (id, format, properties) -> format;

  47.     /*******************************************************************************************************************
  48.      *
  49.      * Retrieves metadata items and formats them.
  50.      *
  51.      * @param  mediaId     the id of the media item to retrieve metadata from
  52.      * @param  format      the format string for metadata
  53.      * @param  properties  some configuration properties
  54.      * @return             the formatted metadata
  55.      *
  56.      ******************************************************************************************************************/
  57.     @Nonnull
  58.     public String getMetadataString (@Nonnull Id mediaId,
  59.                                      @Nonnull String format,
  60.                                      @Nonnull ResourceProperties properties);
  61.   }