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 package org.opencastproject.oaipmh.server;
22
23 import org.opencastproject.oaipmh.persistence.SearchResultItem;
24
25 import org.w3c.dom.Element;
26
27 import java.util.Optional;
28
29 /**
30 * A metadata provider provides XML serialized metadata for a certain OAI-PMH metadata prefix. For further information
31 * about metadata prefixes see the section
32 * <a href="http://www.openarchives.org/OAI/openarchivesprotocol.html#MetadataNamespaces">3.4 metadataPrefix and Metadata
33 * Schema</a> of the OAI-PMH specification.
34 */
35 public interface MetadataProvider {
36 /**
37 * Return the metadata format handled by this provider.
38 */
39 MetadataFormat getMetadataFormat();
40
41 /**
42 * Transform a search result item into a piece of XML metadata.
43 */
44 Element createMetadata(OaiPmhRepository repository, SearchResultItem item, Optional<String> set);
45
46 }