View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.metadata.mpeg7;
23  
24  import org.opencastproject.mediapackage.XmlElement;
25  
26  /**
27   * This locator specifies elements in time and space.
28   *
29   * <pre>
30   * &lt;complexType name="SpatioTemporalLocatorType" final="#all"&gt;
31   *   &lt;sequence&gt;
32   *     &lt;element name="CoordRef" minOccurs="0"&gt;
33   *       &lt;complexType&gt;
34   *         &lt;attribute name="ref" type="IDREF" use="required"/&gt;
35   *         &lt;attribute name="spatialRef" type="boolean" use="required"/&gt;
36   *       &lt;/complexType&gt;
37   *     &lt;/element&gt;
38   *     &lt;choice maxOccurs="unbounded"&gt;
39   *       &lt;element name="FigureTrajectory" type="mpeg7:FigureTrajectoryType"/&gt;
40   *       &lt;element name="ParameterTrajectory" type="mpeg7:ParameterTrajectoryType"/&gt;
41   *       &lt;element name="MediaTime" type="mpeg7:MediaTimeType"/&gt;
42   *     &lt;/choice&gt;
43   *   &lt;/sequence&gt;
44   * &lt;/complexType&gt;
45   * </pre>
46   */
47  public interface SpatioTemporalLocator extends XmlElement {
48  
49    /**
50     * Sets the media time.
51     *
52     * @param time
53     *          the time
54     */
55    void setMediaTime(MediaTime time);
56  
57    /**
58     * Returns the locator's time and duration.
59     *
60     * @return the media time
61     */
62    MediaTime getMediaTime();
63  
64  }