SpatioTemporalLocator.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.metadata.mpeg7;

import org.opencastproject.mediapackage.XmlElement;

/**
 * This locator specifies elements in time and space.
 *
 * <pre>
 * <complexType name="SpatioTemporalLocatorType" final="#all">
 *   <sequence>
 *     <element name="CoordRef" minOccurs="0">
 *       <complexType>
 *         <attribute name="ref" type="IDREF" use="required"/>
 *         <attribute name="spatialRef" type="boolean" use="required"/>
 *       </complexType>
 *     </element>
 *     <choice maxOccurs="unbounded">
 *       <element name="FigureTrajectory" type="mpeg7:FigureTrajectoryType"/>
 *       <element name="ParameterTrajectory" type="mpeg7:ParameterTrajectoryType"/>
 *       <element name="MediaTime" type="mpeg7:MediaTimeType"/>
 *     </choice>
 *   </sequence>
 * </complexType>
 * </pre>
 */
public interface SpatioTemporalLocator extends XmlElement {

  /**
   * Sets the media time.
   *
   * @param time
   *          the time
   */
  void setMediaTime(MediaTime time);

  /**
   * Returns the locator's time and duration.
   *
   * @return the media time
   */
  MediaTime getMediaTime();

}