/*
 * Copyright 2013 SFB 632.
 *
 * Licensed under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 annis.service;

import annis.model.Annotation;

/**
 * Interface defining the REST API calls that ANNIS provides for getting the
 * meta data.
 *
 * <p>
 * All paths for this part of the service start with
 * <pre>annis/meta/</pre>
 * </p>
 *
 * @author Benjamin Weißenfels <b.pixeldrama@gmail.com>
 */
public interface MetadataService
{

  /**
   * Retrieves the meta data for a top level corpus.
   *
   * <p>If the <b>deep</b> path is called, the metadata of all subcorpora and
   * documents are also fetched.</p>
   *
   *
   * <h3>Path(s)</h3>
   *
   * <ol>
   * <li>GET annis/meta/<b>{top}</b></li>
   * <li>GET annis/meta/<b>{top}</b>/deep</li>
   * </ol>
   *
   * <h3>MIME</h3>
   *
   * accept:
   * <code>application/xml</code>
   *
   * @param topLevelCorpus Determines the corpus, for which the annotations are
   * retrieved.
   * @return The xml representation of a list wich contains {@link Annotation}
   * objects.
   */
  public Annotation getMetadata(String topLevelCorpus);
}

@@ -948,15 +948,13 @@
   * 
-Retriev
+Fetch
 es t
@@ -1236,20 +1236,28 @@
 op%7D%3C/b%3E/
-deep
+%3Cb%3E%7Bdoc%7D%3C/b%3E
 %3C/li%3E%0A  
@@ -1541,16 +1541,16 @@
 .%0A   */%0A
-
   public
@@ -1596,11 +1596,1216 @@
 Corpus);
+%0A%0A  /**%0A   * Fetches the meta data for a top level corpus.%0A   *%0A   * %3Ch3%3EPath(s)%3C/h3%3E%0A   *%0A   * %3Col%3E%0A   * %3Cli%3EGET annis/meta/deep/%3Cb%3E%7Btop%7D%3C/b%3E%3C/li%3E%0A   * %3Cli%3EGET annis/meta/deep/%3Cb%3E%7Btop%7D%3C/b%3E/%3Cb%3E%7Bdoc%7D%3C/b%3E%3C/li%3E%0A   *%0A   * %3C/ol%3E%0A   *%0A   * %3Ch3%3EMIME%3C/h3%3E%0A   *%0A   * accept:%0A   * %3Ccode%3Eapplication/xml%3C/code%3E%0A   *%0A   * @param topLevelCorpus Determines the corpus, for which the annotations are%0A   * retrieved.%0A   * @param docname Determines the document name, for which the annotations are%0A   * fetched. If null, all annotations of all documents are fetched.%0A   * @return The xml representation of a list wich contains %7B@link Annotation%7D%0A   * objects.%0A   */%0A  public Annotation getMetadataDeep(String topLevelCorpus, String docname);%0A%0A  /**%0A   * Fetches all document names within a top level corpus.%0A   *%0A   * %3Ch3%3EPath%3C/h3%3E%0A   *%0A   * %3Cp%3EGET annis/meta/docnames/%3Cb%3E%7Btop%7D%3C/b%3E%3C/p%3E *%0A   *%0A   * %3Ch3%3EMIME%3C/h3%3E%0A   *%0A   * accept:%0A   * %3Ccode%3Eapplication/xml%3C/code%3E%0A   *%0A   * @param topLevelCorpus Determines the corpus, for which the document names%0A   * are retrieved.%0A   * @return The xml representation of a list wich contains %7B@link Annotation%7D%0A   * objects.%0A   */%0A  public Annotation getDocNames(String topLevelCorpus);
 %0A%7D%0A

Define the interface for metadata more exactly.