/*
    * Copyright 2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.properties.config.transfer.templatestream;
  
  import de.smartics.util.lang.Arg;
  
  /**
   * Descriptor for table and column names to store property values.
   */
  public final class TableDescriptor
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The name of the configuration table.
     */
    private final String table;
  
    /**
     * The name of the configuration key column.
     */
    private final String configColumn;
  
    /**
     * The name of the property name column.
     */
    private final String nameColumn;
  
    /**
     * The name of the property value column.
     */
    private final String valueColumn;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    private TableDescriptor(final Builder builder)
    {
      this.table = builder.table;
      this.configColumn = builder.configColumn;
      this.nameColumn = builder.nameColumn;
      this.valueColumn = builder.valueColumn;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * The builder of descriptor instances.
     */
    public static final class Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      /**
       * The name of the configuration table.
       */
      private String table = "config";
  
      /**
       * The name of the configuration key column.
       */
      private String configColumn = "config";
  
      /**
       * The name of the property name column.
       */
      private String nameColumn = "name";
  
      /**
       * The name of the property value column.
       */
      private String valueColumn = "value";
  
      // ***************************** Initializer ******************************
  
      // ***************************** Constructors *****************************
  
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the name of the configuration table.
      *
      * @param table the name of the configuration table.
      * @throws NullPointerException if {@code table} is <code>null</code>.
      * @throws IllegalArgumentException if {@code table} is blank.
      */
     public void setTable(final String table) throws NullPointerException,
       IllegalArgumentException
     {
       this.table = Arg.checkNotBlank("table", table);
     }
 
     /**
      * Sets the name of the optional configuration key column.
      *
      * @param configColumn the name of the optional configuration key column.
      * @throws NullPointerException if {@code configColumn} is <code>null</code>
      *           .
      * @throws IllegalArgumentException if {@code configColumn} is blank.
      */
     public void setConfigColumn(final String configColumn)
       throws NullPointerException, IllegalArgumentException
     {
       this.configColumn = Arg.checkNotBlank("configColumn", configColumn);
     }
 
     /**
      * Sets the name of the property name column.
      *
      * @param nameColumn the name of the property name column.
      * @throws NullPointerException if {@code nameColumn} is <code>null</code>.
      * @throws IllegalArgumentException if {@code nameColumn} is blank.
      */
     public void setNameColumn(final String nameColumn)
       throws NullPointerException, IllegalArgumentException
     {
       this.nameColumn = Arg.checkNotBlank("nameColumn", nameColumn);
     }
 
     /**
      * Sets the name of the property value column.
      *
      * @param valueColumn the name of the property value column.
      * @throws NullPointerException if {@code valueColumn} is <code>null</code>.
      * @throws IllegalArgumentException if {@code valueColumn} is blank.
      */
     public void setValueColumn(final String valueColumn)
       throws NullPointerException, IllegalArgumentException
     {
       this.valueColumn = Arg.checkNotBlank("valueColumn", valueColumn);
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Builds an instance of the descriptor.
      *
      * @return an instance of the descriptor.
      */
     public TableDescriptor build()
     {
       return new TableDescriptor(this);
     }
 
     // --- object basics ------------------------------------------------------
 
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the name of the configuration table.
    *
    * @return the name of the configuration table.
    */
   public String getTable()
   {
     return table;
   }
 
   /**
    * Returns the name of the configuration key column.
    *
    * @return the name of the configuration key column.
    */
   public String getConfigColumn()
   {
     return configColumn;
   }
 
   /**
    * Returns the name of the property name column.
    *
    * @return the name of the property name column.
    */
   public String getNameColumn()
   {
     return nameColumn;
   }
 
   /**
    * Returns the name of the property value column.
    *
    * @return the name of the property value column.
    */
   public String getValueColumn()
   {
     return valueColumn;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }