MovingRegion.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;

/**
 * A <code>MovingRegion</code> describes the location, the movement and contents of elements on a video segment:
 *
 * <pre>
 * <complexType name="MovingRegionType">
 *   <complexContent>
 *     <extension base="mpeg7:SegmentType">
 *       <sequence>
 *         <choice minOccurs="0">
 *           <element name="SpatioTemporalLocator" type="mpeg7:SpatioTemporalLocatorType"/>
 *           <element name="SpatioTemporalMask" type="mpeg7:SpatioTemporalMaskType"/>
 *         </choice>
 *         <choice minOccurs="0" maxOccurs="unbounded">
 *           <element name="VisualDescriptor" type="mpeg7:VisualDType"/>
 *           <element name="VisualDescriptionScheme" type="mpeg7:VisualDSType"/>
 *           <element name="VisualTimeSeriesDescriptor" type="mpeg7:VisualTimeSeriesType"/>
 *           <element name="GofGopFeature" type="mpeg7:GofGopFeatureType"/>
 *         </choice>
 *         <element name="MultipleView" type="mpeg7:MultipleViewType" minOccurs="0"/>
 *         <choice minOccurs="0" maxOccurs="unbounded">
 *           <element name="SpatialDecomposition" type="mpeg7:MovingRegionSpatialDecompositionType"/>
 *           <element name="TemporalDecomposition" type="mpeg7:MovingRegionTemporalDecompositionType"/>
 *           <element name="SpatioTemporalDecomposition" type="mpeg7:MovingRegionSpatioTemporalDecompositionType"/>
 *           <element name="MediaSourceDecomposition" type="mpeg7:MovingRegionMediaSourceDecompositionType"/>
 *         </choice>
 *       </sequence>
 *     </extension>
 *   </complexContent>
 * </complexType>
 * </pre>
 */
public interface MovingRegion extends XmlElement {

  /**
   * Sets the spatio temporal locator.
   *
   * @param locator
   *          the region locator
   */
  void setSpatioTemporalLocator(SpatioTemporalLocator locator);

  /**
   * Returns the spatio temporal locator.
   *
   * @return the locator
   */
  SpatioTemporalLocator getSpatioTemporalLocator();

}