PushAction.java

/*******************************************************************************
 * Copyright French Prime minister Office/SGMAP/DINSIC/Vitam Program (2015-2019)
 *
 * contact.vitam@culture.gouv.fr
 *
 * This software is a computer program whose purpose is to implement a digital archiving back-office system managing
 * high volumetry securely and efficiently.
 *
 * This software is governed by the CeCILL 2.1 license under French law and abiding by the rules of distribution of free
 * software. You can use, modify and/ or redistribute the software under the terms of the CeCILL 2.1 license as
 * circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license,
 * users are provided only with a limited warranty and the software's author, the holder of the economic rights, and the
 * successive licensors have only limited liability.
 *
 * In this respect, the user's attention is drawn to the risks associated with loading, using, modifying and/or
 * developing or reproducing the software by the user in light of its specific status of free software, that may mean
 * that it is complicated to manipulate, and that also therefore means that it is reserved for developers and
 * experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the
 * software's suitability as regards their requirements in conditions enabling the security of their systems and/or data
 * to be ensured and, more generally, to use and operate it in the same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had knowledge of the CeCILL 2.1 license and that you
 * accept its terms.
 *******************************************************************************/
package fr.gouv.vitam.common.database.builder.query.action;

import java.util.Date;

import com.fasterxml.jackson.databind.node.ArrayNode;

import fr.gouv.vitam.common.database.builder.request.configuration.BuilderToken.UPDATEACTION;
import fr.gouv.vitam.common.database.builder.request.configuration.GlobalDatas;
import fr.gouv.vitam.common.database.builder.request.exception.InvalidCreateOperationException;
import fr.gouv.vitam.common.exception.InvalidParseOperationException;

/**
 * Push Action: $push : { name : { $each : [ value, value, ... ] } }
 *
 */
public class PushAction extends Action {
    private static final String CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION =
        "Cannot add a set element since this is not a Push Action: ";

    protected PushAction() {
        super();
    }

    /**
     * Push Action constructor
     *
     * @param variableName key name
     * @param value key value
     * @throws InvalidCreateOperationException when query is invalid
     */
    public PushAction(final String variableName, final String... value)
        throws InvalidCreateOperationException {
        super();
        createActionVariableEach(UPDATEACTION.PUSH, variableName);
        for (final String val : value) {
            if (val != null && !val.trim().isEmpty()) {
                try {
                    GlobalDatas.sanityValueCheck(val);
                } catch (final InvalidParseOperationException e) {
                    throw new InvalidCreateOperationException(e);
                }
                ((ArrayNode) currentObject).add(val.trim());
            }
        }
        currentUPDATEACTION = UPDATEACTION.PUSH;
        setReady(true);
    }

    /**
     * Push Action constructor
     *
     * @param variableName key name
     * @param value key value
     * @throws InvalidCreateOperationException when query is invalid
     */
    public PushAction(final String variableName, final long... value)
        throws InvalidCreateOperationException {
        super();
        createActionVariableEach(UPDATEACTION.PUSH, variableName);
        for (final long val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        currentUPDATEACTION = UPDATEACTION.PUSH;
        setReady(true);
    }

    /**
     * Push Action constructor
     *
     * @param variableName key name
     * @param value key value
     * @throws InvalidCreateOperationException when query is invalid
     */
    public PushAction(final String variableName, final boolean... value)
        throws InvalidCreateOperationException {
        super();
        createActionVariableEach(UPDATEACTION.PUSH, variableName);
        for (final boolean val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        currentUPDATEACTION = UPDATEACTION.PUSH;
        setReady(true);
    }

    /**
     * Push Action constructor
     *
     * @param variableName key name
     * @param value key value
     * @throws InvalidCreateOperationException when query is invalid
     */
    public PushAction(final String variableName, final double... value)
        throws InvalidCreateOperationException {
        super();
        createActionVariableEach(UPDATEACTION.PUSH, variableName);
        for (final double val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        currentUPDATEACTION = UPDATEACTION.PUSH;
        setReady(true);
    }

    /**
     * Push Action constructor
     *
     * @param variableName key name
     * @param value key value
     * @throws InvalidCreateOperationException when query is invalid
     */
    public PushAction(final String variableName, final Date... value)
        throws InvalidCreateOperationException {
        super();
        createActionVariableEach(UPDATEACTION.PUSH, variableName);
        for (final Date val : value) {
            ((ArrayNode) currentObject).add(GlobalDatas.getDate(val));
        }
        currentUPDATEACTION = UPDATEACTION.PUSH;
        setReady(true);
    }

    /**
     * Add other Push sub actions to Push Query
     *
     * @param value key value
     * @return the PushAction
     * @throws InvalidCreateOperationException when query is invalid
     */
    public final PushAction add(final String... value)
        throws InvalidCreateOperationException {
        if (currentUPDATEACTION != UPDATEACTION.PUSH) {
            throw new InvalidCreateOperationException(
                CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION + currentUPDATEACTION);
        }
        for (final String val : value) {
            if (val != null && !val.trim().isEmpty()) {
                try {
                    GlobalDatas.sanityValueCheck(val);
                } catch (final InvalidParseOperationException e) {
                    throw new InvalidCreateOperationException(e);
                }
                ((ArrayNode) currentObject).add(val.trim());
            }
        }
        return this;
    }

    /**
     * Add other Push sub actions to Push Query
     *
     * @param value key value
     * @return the PushAction
     * @throws InvalidCreateOperationException when query is invalid
     */
    public final PushAction add(final boolean... value)
        throws InvalidCreateOperationException {
        if (currentUPDATEACTION != UPDATEACTION.PUSH) {
            throw new InvalidCreateOperationException(
                CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION + currentUPDATEACTION);
        }
        for (final boolean val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        return this;
    }

    /**
     * Add other Push sub actions to Push Query
     *
     * @param value key value
     * @return the PushAction
     * @throws InvalidCreateOperationException when query is invalid
     */
    public final PushAction add(final long... value)
        throws InvalidCreateOperationException {
        if (currentUPDATEACTION != UPDATEACTION.PUSH) {
            throw new InvalidCreateOperationException(
                CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION + currentUPDATEACTION);
        }
        for (final long val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        return this;
    }

    /**
     * Add other Push sub actions to Push Query
     *
     * @param value key value
     * @return the PushAction
     * @throws InvalidCreateOperationException when query is invalid
     */
    public final PushAction add(final double... value)
        throws InvalidCreateOperationException {
        if (currentUPDATEACTION != UPDATEACTION.PUSH) {
            throw new InvalidCreateOperationException(
                CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION + currentUPDATEACTION);
        }
        for (final double val : value) {
            ((ArrayNode) currentObject).add(val);
        }
        return this;
    }

    /**
     * Add other Push sub actions to Push Query
     *
     * @param value key value
     * @return the PushAction
     * @throws InvalidCreateOperationException when query is invalid
     */
    public final PushAction add(final Date... value)
        throws InvalidCreateOperationException {
        if (currentUPDATEACTION != UPDATEACTION.PUSH) {
            throw new InvalidCreateOperationException(
                CANNOT_ADD_A_SET_ELEMENT_SINCE_THIS_IS_NOT_A_PUSH_ACTION + currentUPDATEACTION);
        }
        for (final Date val : value) {
            ((ArrayNode) currentObject).add(GlobalDatas.getDate(val));
        }
        return this;
    }

}