PresenterFirstSelector.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.mediapackage.selector;

import org.opencastproject.mediapackage.MediaPackageElements;
import org.opencastproject.mediapackage.Track;

/**
 * This <code>MediaPackageElementSelector</code> will return zero or one track from the media package by looking at the
 * flavors and following this order:
 * <ul>
 * <li>{@link MediaPackageElements#PRESENTER_SOURCE}</li>
 * <li>{@link MediaPackageElements#PRESENTATION_SOURCE}</li>
 * <li>{@link MediaPackageElements#DOCUMENTS_SOURCE}</li>
 * <li>{@link MediaPackageElements#AUDIENCE_SOURCE}</li>
 * </ul>
 *
 * This basically means that if there is a presenter track, this is the one that will be returnd. If not, then the
 * selctor will try to find a presentation track and so on.
 */
public class PresenterFirstSelector extends FlavorPrioritySelector<Track> {

  /**
   * Creates a new presentation first selector.
   */
  public PresenterFirstSelector() {
    addFlavor(MediaPackageElements.PRESENTER_SOURCE);
    addFlavor(MediaPackageElements.PRESENTATION_SOURCE);
    addFlavor(MediaPackageElements.DOCUMENTS_SOURCE);
    addFlavor(MediaPackageElements.AUDIENCE_SOURCE);
  }

}