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
23 package org.opencastproject.metadata.mpeg7;
24
25 import org.opencastproject.mediapackage.MediaPackageElementFlavor;
26 import org.opencastproject.metadata.api.MetadataCatalog;
27
28 import org.w3c.dom.Document;
29
30 import java.io.IOException;
31
32 import javax.xml.parsers.ParserConfigurationException;
33 import javax.xml.transform.TransformerException;
34
35 /**
36 * The <code>MPEG7</code> catalog encapsulates MPEG-7 metadata.
37 */
38 public interface Mpeg7Catalog extends Mpeg7, MetadataCatalog, Cloneable {
39 /** A flavor that matches any mpeg7 element */
40 MediaPackageElementFlavor ANY_MPEG7 = MediaPackageElementFlavor.parseFlavor("mpeg-7/*");
41
42 /**
43 * Saves the catalog to disk.
44 *
45 * todo think about hiding technical exceptions
46 *
47 * @throws ParserConfigurationException
48 * if the xml parser environment is not correctly configured
49 * @throws TransformerException
50 * if serialization of the metadata document fails
51 * @throws IOException
52 * if an error with catalog file handling occurs
53 */
54 Document toXml() throws ParserConfigurationException, TransformerException, IOException;
55
56 Mpeg7Catalog clone();
57 }