001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.odf.ose.export.impl.odf.db;
017
018import java.sql.Types;
019import java.util.ArrayList;
020import java.util.HashSet;
021import java.util.List;
022import java.util.Set;
023import java.util.concurrent.atomic.AtomicInteger;
024
025import org.apache.commons.lang3.tuple.Pair;
026
027import org.ametys.odf.ose.db.ParameterizableQuery;
028import org.ametys.odf.ose.db.column.Column;
029import org.ametys.odf.ose.db.column.DefaultColumn;
030import org.ametys.odf.ose.db.column.ForeignKeyColumn;
031import org.ametys.odf.ose.db.column.SourceIdColumn;
032import org.ametys.odf.ose.db.parameter.QueryParameter;
033import org.ametys.odf.ose.db.parameter.ValuedQueryParameter;
034import org.ametys.odf.ose.export.ExportUtils;
035
036/**
037 * Helper to build queries to manage the CHEMIN_PEDAGOGIQUE table.
038 */
039public final class CheminPedagogiqueHelper
040{
041    private static final String __TABLE_NAME = "CHEMIN_PEDAGOGIQUE";
042    
043    private CheminPedagogiqueHelper()
044    {
045        // Helper
046    }
047    
048    /**
049     * Queries to create the table and associated view.
050     * @return List of queries for table and view creation
051     */
052    public static List<ParameterizableQuery> initialize()
053    {
054        Set<Column> columns = new HashSet<>();
055        columns.add(new DefaultColumn("ID", "VARCHAR2(100 CHAR)", false, "SOURCE_CODE"));
056        columns.add(new DefaultColumn("ORDRE", "NUMBER(*,0)", false));
057        columns.add(new ForeignKeyColumn("ELEMENT_PEDAGOGIQUE_ID", "VARCHAR2(100 CHAR)", false, Pair.of("ELEMENT_PEDAGOGIQUE", "SOURCE_CODE"), true));
058        columns.add(new ForeignKeyColumn("ETAPE_ID", "VARCHAR2(100 CHAR)", false, Pair.of("ETAPE", "SOURCE_CODE"), true));
059        columns.add(new DefaultColumn("ANNEE_ID", "NUMBER(38, 0)", false));
060        columns.add(new SourceIdColumn());
061        return ExportUtils.initializeTableAndView(__TABLE_NAME, columns);
062    }
063    
064    /**
065     * Query to delete all lines from the table.
066     * @return The query for deletion
067     */
068    public static ParameterizableQuery deleteFrom()
069    {
070        return ExportUtils.deleteFromAmetys(__TABLE_NAME);
071    }
072
073    /**
074     * Query to insert a line in the table.
075     * @param stepCode The step code
076     * @param elpCode The ELP code
077     * @param oseCatalog The OSE catalog
078     * @param order The order, incremented once at each call
079     * @return The query to insert values in the table
080     */
081    public static ParameterizableQuery insertInto(String stepCode, String elpCode, Long oseCatalog, AtomicInteger order)
082    {
083        List<QueryParameter> parameters = new ArrayList<>();
084        parameters.add(new ValuedQueryParameter("ID", oseCatalog + "-" + stepCode + "-" + elpCode, Types.VARCHAR));
085        parameters.add(new ValuedQueryParameter("ORDRE", order.getAndIncrement(), Types.NUMERIC));
086        parameters.add(new ValuedQueryParameter("ELEMENT_PEDAGOGIQUE_ID", elpCode, Types.VARCHAR));
087        parameters.add(new ValuedQueryParameter("ETAPE_ID",  stepCode, Types.VARCHAR));
088        parameters.add(new ValuedQueryParameter("ANNEE_ID", oseCatalog, Types.NUMERIC));
089        return ExportUtils.insertIntoAmetys(__TABLE_NAME, parameters);
090    }
091}