/*
 *  Copyright 2014 Anyware Services
 *
 *  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 org.ametys.cms.search.query;

import java.util.Arrays;

import org.ametys.cms.content.indexing.solr.SolrFieldNames;

/**
 * Represents a {@link Query} testing the current workflow step of a content.
 * It can only be used to search on the current step.
 */
public class WorkflowStepQuery implements Query
{
    
    private Operator _operator;
    private int[] _values;
    private LogicalOperator _logicalOperator;
    
    /**
     * Build a WorkflowStepQuery.
     * @param value the step id to test.
     */
    public WorkflowStepQuery(int value)
    {
        this(new int[] {value});
    }
    
    /**
     * Build a WorkflowStepQuery.
     * @param values the step IDs to test.
     */
    public WorkflowStepQuery(int... values)
    {
        this(Operator.EQ, values);
    }
    
    /**
     * Build a WorkflowStepQuery.
     * @param operator the operator.
     * @param value the step id to test.
     */
    public WorkflowStepQuery(Operator operator, int value)
    {
        this(operator, new int[] {value});
    }
    
    /**
     * Build a WorkflowStepQuery.
     * @param operator the operator.
     * @param values the step IDs to test.
     */
    public WorkflowStepQuery(Operator operator, int... values)
    {
        this(operator, LogicalOperator.OR, values);
    }
    
    /**
     * Build a WorkflowStepQuery.
     * @param operator the operator.
     * @param logicalOperator the logical operator.
     * @param values the step IDs to test.
     */
    public WorkflowStepQuery(Operator operator, LogicalOperator logicalOperator, int... values)
    {
        if (Operator.EQ != operator && Operator.NE != operator && Operator.EXISTS != operator)
        {
            throw new IllegalArgumentException("Test operator '" + operator + "' is unknown for test's expression.");
        }
        
        _operator = operator;
        _logicalOperator = logicalOperator;
        _values = values;
    }

    /**
     * Get the operator.
     * @return the operator
     */
    public Operator getOperator()
    {
        return _operator;
    }

    /**
     * Get the values.
     * @return the values
     */
    public int[] getValues()
    {
        return _values;
    }

    /**
     * Get the logicalOperator.
     * @return the logicalOperator
     */
    public LogicalOperator getLogicalOperator()
    {
        return _logicalOperator;
    }
    
    @Override
    public String build() throws QuerySyntaxException
    {
        StringBuilder query = new StringBuilder();

        if (_operator == Operator.EXISTS)
        {
            query.append(SolrFieldNames.WORKFLOW_STEP).append(":").append(QueryHelper.EXISTS_VALUE);
            
            return query.toString();
        }
        
        if (_values.length > 0)
        {
            if (_values.length > 1)
            {
                query.append('(');
            }
            for (int i = 0; i < _values.length; i++)
            {
                if (i > 0)
                {
                    query.append(' ').append(_logicalOperator).append(' ');
                }
                
                if (_operator == Operator.NE)
                {
                    NotQuery.appendNegation(query);
                }
                
                query.append(SolrFieldNames.WORKFLOW_STEP).append(':').append(_values[i]);
            }
            if (_values.length > 1)
            {
                query.append(')');
            }
        }
        
        return query.toString();
    }

    @Override
    public int hashCode()
    {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((_logicalOperator == null) ? 0 : _logicalOperator.hashCode());
        result = prime * result + ((_operator == null) ? 0 : _operator.hashCode());
        result = prime * result + Arrays.hashCode(_values);
        return result;
    }

    @Override
    public boolean equals(Object obj)
    {
        if (this == obj)
        {
            return true;
        }
        if (obj == null)
        {
            return false;
        }
        if (getClass() != obj.getClass())
        {
            return false;
        }
        WorkflowStepQuery other = (WorkflowStepQuery) obj;
        if (_logicalOperator != other._logicalOperator)
        {
            return false;
        }
        if (_operator != other._operator)
        {
            return false;
        }
        if (!Arrays.equals(_values, other._values))
        {
            return false;
        }
        return true;
    }
}