MediaCatalog.java

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

  28. import javax.annotation.Nonnull;
  29. import it.tidalwave.bluemarine2.model.finder.audio.AudioFileFinder;
  30. import it.tidalwave.bluemarine2.model.finder.audio.MusicArtistFinder;
  31. import it.tidalwave.bluemarine2.model.finder.audio.PerformanceFinder;
  32. import it.tidalwave.bluemarine2.model.finder.audio.RecordFinder;
  33. import it.tidalwave.bluemarine2.model.finder.audio.TrackFinder;

  34. /***********************************************************************************************************************
  35.  *
  36.  * Represents a collection of media that can be queried in various ways.
  37.  *
  38.  * @author  Fabrizio Giudici
  39.  *
  40.  **********************************************************************************************************************/
  41. public interface MediaCatalog
  42.   {
  43.     public static final Class<MediaCatalog> _MediaCatalog_ = MediaCatalog.class;

  44.     /*******************************************************************************************************************
  45.      *
  46.      * Finds the {@link MusicArtist}s in this catalog.
  47.      *
  48.      * @return  a {@code Finder} for the artists
  49.      *
  50.      ******************************************************************************************************************/
  51.     @Nonnull
  52.     public MusicArtistFinder findArtists();

  53.     /*******************************************************************************************************************
  54.      *
  55.      * Finds the {@link Record}s in this catalog.
  56.      *
  57.      * @return  a {@code Finder} for the records
  58.      *
  59.      ******************************************************************************************************************/
  60.     @Nonnull
  61.     public RecordFinder findRecords();

  62.     /*******************************************************************************************************************
  63.      *
  64.      * Finds the {@link Track}s in this catalog.
  65.      *
  66.      * @return  a {@code Finder} for the tracks
  67.      *
  68.      ******************************************************************************************************************/
  69.     @Nonnull
  70.     public TrackFinder findTracks();

  71.     /*******************************************************************************************************************
  72.      *
  73.      * Finds the {@link Performance}s in this catalog.
  74.      *
  75.      * @return  a {@code Finder} for the performances
  76.      *
  77.      ******************************************************************************************************************/
  78.     @Nonnull
  79.     public PerformanceFinder findPerformances();

  80.     /*******************************************************************************************************************
  81.      *
  82.      * Finds the {@link AudioFile}s in this catalog.
  83.      *
  84.      * @return  a {@code Finder} for the audio files
  85.      *
  86.      ******************************************************************************************************************/
  87.     @Nonnull
  88.     public AudioFileFinder findAudioFiles();
  89.   }