cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IMetadataService.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2015 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10 package eu.etaxonomy.cdm.api.service;
  11
  12 import java.util.Map;
  13
  14 import eu.etaxonomy.cdm.config.CdmSourceException;
  15 import eu.etaxonomy.cdm.model.metadata.CdmMetaData.MetaDataPropertyName;
  16
  17 /**
  18  * @author cmathew
  19  * @date 20 Nov 2015
  20  *
  21  */
  22 public interface IMetadataService {
  23
  24
  25     /**
  26      * Returns the CDM model schema version number
  27      *
  28      * @return the CDM model schema version number
  29      * @throws CdmSourceException , incase of an underlying SQL error
  30      */
  31     public String getDbSchemaVersion() throws CdmSourceException;
  32
  33     /**
  34      * Returns a boolean flag to indicate whether the database is empty
  35      *
  36      * @return boolean flag to indicate whether the database is empty
  37      * @throws CdmSourceException , incase of an underlying SQL error
  38      */
  39     public boolean isDbEmpty() throws CdmSourceException;
  40
  41     /**
  42      * Returns metadata corresponding to the underlying data source
  43      *
  44      * @return
  45      * @throws CdmSourceException
  46      */
  47     public Map<MetaDataPropertyName, String> getCdmMetadataMap() throws CdmSourceException;
  48
  49 }