/**
 * Copyright 2005-2013 The Kuali Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
 *
 * 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.kuali.rice.core.api.criteria;

import org.kuali.rice.core.api.CoreConstants;
import org.w3c.dom.Element;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAnyElement;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElements;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.util.Collection;

/**
 * An immutable predicate which represents an "equal ignore case" statement which is
 * evaluated the {@link org.kuali.rice.core.api.criteria.CriteriaValue} of this predicate.
 *
 * @author Kuali Rice Team (rice.collab@kuali.org)
 * @see org.kuali.rice.core.api.criteria.PredicateFactory for a convenient way to construct this class.
 */
@XmlRootElement(name = EqualIgnoreCasePredicate.Constants.ROOT_ELEMENT_NAME)
@XmlAccessorType(XmlAccessType.NONE)
@XmlType(name = EqualIgnoreCasePredicate.Constants.TYPE_NAME,
        propOrder = {CriteriaSupportUtils.PropertyConstants.VALUE, CoreConstants.CommonElements.FUTURE_ELEMENTS})
public final class EqualIgnoreCasePredicate extends AbstractPredicate implements SingleValuedPredicate {

    private static final long serialVersionUID = 7159459561133496549L;

    @XmlAttribute(name = CriteriaSupportUtils.PropertyConstants.PROPERTY_PATH)
    private final String propertyPath;

    @XmlElements(value = {
            @XmlElement(name = CriteriaStringValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaStringValue.class,
                    required = true)})
    private final CriteriaStringValue value;

    @SuppressWarnings("unused")
    @XmlAnyElement
    private final Collection<Element> _futureElements = null;

    /**
     * Should only be invoked by JAXB.
     */
    @SuppressWarnings("unused")
    private EqualIgnoreCasePredicate() {
        this.propertyPath = null;
        this.value = null;
    }

    /**
     * Constructs an EqualIgnoreCasePredicate for the given path and value.
     *
     * @param propertyPath the property path for the predicate, must not be null or blank
     * @param value the value to evaluation the path against, must not be null.
     * @throws IllegalArgumentException if the propertyPath is null or blank
     * @throws IllegalArgumentException if the value is null
     */
    EqualIgnoreCasePredicate(String propertyPath, CriteriaStringValue value) {
        this.propertyPath = propertyPath;
        this.value = value;
    }

    @Override
    public String getPropertyPath() {
        return propertyPath;
    }

    @Override
    public CriteriaStringValue getValue() {
        return value;
    }

    /**
     * Defines some internal constants used on this class.
     */
    static class Constants {
        final static String ROOT_ELEMENT_NAME = "equalIgnoreCase";
        final static String TYPE_NAME = "EqualIgnoreCaseType";
    }

    @Override
    public String toString() {
        return CriteriaSupportUtils.toString(this);
    }
}
