package fr.ifremer.quadrige3.batch.shape.config;
   
   /*-
    * #%L
    * Quadrige3 Core :: Quadrige3 Core Shared
    * $Id:$
    * $HeadURL:$
    * %%
    * Copyright (C) 2017 Ifremer
   * %%
   * This program is free software: you can redistribute it and/or modify
   * it under the terms of the GNU Affero General Public License as published by
   * the Free Software Foundation, either version 3 of the License, or
   * (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   * #L%
   */
  
  import org.nuiton.config.ConfigOptionDef;
  
  import java.io.File;
  
  import static org.nuiton.i18n.I18n.n;
  
  /**
   * batch shape configuration options.
   *
   * @author benoit.lavenier@e-is.pro
   */
  public enum ShapeConfigurationOption implements ConfigOptionDef {
  
      // ------------------------------------------------------------------------//
      // -- READ-ONLY OPTIONS ---------------------------------------------------//
      // ------------------------------------------------------------------------//
  
      INPUT_SHAPES_DIRECTORY(
              "quadrige3.batch.shape.input.directory",
              n("quadrige3.batch.shape.config.input.directory.description"),
              "${quadrige3.data.directory}/shapes_input",
              File.class),
  
      OUTPUT_SHAPES_DIRECTORY(
              "quadrige3.batch.shape.output.directory",
              n("quadrige3.batch.shape.config.output.directory.description"),
              "${quadrige3.data.directory}/shapes_output",
              File.class),
  
      // ------------------------------------------------------------------------//
      // -- DATA CONSTANTS ------------------------------------------------------//
      // ------------------------------------------------------------------------//
  
      SHAPE_ATTRIBUTE_ID(
              "quadrige3.batch.shape.attribute.id",
              n("quadrige3.batch.shape.config.attribute.id.description"),
              "ID_LDS",
              String.class),
  
      SHAPE_ATTRIBUTE_LABEL(
              "quadrige3.batch.shape.attribute.label",
              n("quadrige3.batch.shape.config.attribute.label.description"),
              "MNE_LDS",
              String.class),
  
      SHAPE_ATTRIBUTE_NAME(
              "quadrige3.batch.shape.attribute.name",
              n("quadrige3.batch.shape.config.attribute.name.description"),
              "LIB_LDS",
              String.class),
  
      SHAPE_ATTRIBUTE_BATHY(
              "quadrige3.batch.shape.attribute.bathy",
              n("quadrige3.batch.shape.config.attribute.bathy.description"),
              "BAT_LDS",
              String.class),
  
      SHAPE_ATTRIBUTE_COMMENT(
              "quadrige3.batch.shape.attribute.comment",
              n("quadrige3.batch.shape.config.attribute.comment.description"),
              "COM_LDS",
              String.class),
  
      SHAPE_ATTRIBUTE_POS_SYSTEM_ID (
              "quadrige3.batch.shape.attribute.posSystemId",
              n("quadrige3.batch.shape.config.attribute.posSystemId.description"),
              "POS_LDS",
              String.class),
  
  
      SHAPE_ATTRIBUTE_UT_FORMAT (
              "quadrige3.batch.shape.attribute.utFormat",
              n("quadrige3.batch.shape.config.attribute.utFormat.description"),
              "UT_LDS",
             String.class),
 
     SHAPE_ATTRIBUTE_DAYLIGHT_SAVING_TIME (
             "quadrige3.batch.shape.attribute.daylightSavingTime",
             n("quadrige3.batch.shape.config.attribute.daylightSavingTime.description"),
             "CUT_LDS",
             String.class),
 
     ;
 
     /** Configuration key. */
     private final String key;
 
     /** I18n key of option description */
     private final String description;
 
     /** Type of option */
     private final Class<?> type;
 
     /** Default value of option. */
     private String defaultValue;
 
     /** Flag to not keep option value on disk */
     private boolean isTransient;
 
     /** Flag to not allow option value modification */
     private boolean isFinal;
 
     ShapeConfigurationOption(String key,
                              String description,
                              String defaultValue,
                              Class<?> type,
                              boolean isTransient) {
         this.key = key;
         this.description = description;
         this.defaultValue = defaultValue;
         this.type = type;
         this.isTransient = isTransient;
         this.isFinal = isTransient;
     }
 
     ShapeConfigurationOption(String key,
                              String description,
                              String defaultValue,
                              Class<?> type) {
         this(key, description, defaultValue, type, true);
     }
 
     /** {@inheritDoc} */
     @Override
     public String getKey() {
         return key;
     }
 
     /** {@inheritDoc} */
     @Override
     public Class<?> getType() {
         return type;
     }
 
     /** {@inheritDoc} */
     @Override
     public String getDescription() {
         return description;
     }
 
     /** {@inheritDoc} */
     @Override
     public String getDefaultValue() {
         return defaultValue;
     }
 
     /** {@inheritDoc} */
     @Override
     public boolean isTransient() {
         return isTransient;
     }
 
     /** {@inheritDoc} */
     @Override
     public boolean isFinal() {
         return isFinal;
     }
 
     /** {@inheritDoc} */
     @Override
     public void setDefaultValue(String defaultValue) {
         this.defaultValue = defaultValue;
     }
 
     /** {@inheritDoc} */
     @Override
     public void setTransient(boolean newValue) {
         // not used
     }
 
     /** {@inheritDoc} */
     @Override
     public void setFinal(boolean newValue) {
         // not used
     }
 }