org.efaps.db.search.compare.AbstractQAttrCompare Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * 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.
 *
 * Revision:        $Rev: 7483 $
 * Last Changed:    $Date: 2012-05-11 11:57:38 -0500 (Fri, 11 May 2012) $
 * Last Changed By: $Author: [email protected] $
 */


package org.efaps.db.search.compare;

import org.efaps.db.AbstractObjectQuery;
import org.efaps.db.search.AbstractQPart;
import org.efaps.db.search.QAttribute;
import org.efaps.db.search.value.AbstractQValue;
import org.efaps.util.EFapsException;


/**
 * Compare an Attribute with a value.
 *
 * @author The eFaps Team
 * @version $Id: AbstractQAttrCompare.java 7483 2012-05-11 16:57:38Z [email protected] $
 */
public abstract class AbstractQAttrCompare
    extends AbstractQPart
{
    /**
     * The attribute used for this equal.
     */
    private final QAttribute attribute;

    /**
     * The value the attribute will be compared to.
     */
    private final AbstractQValue value;

    /**
     * Must this compare ignore the case.
     */
    private boolean ignoreCase;

    /**
     * Constructor setting attribute and value.
     * @param _attribute Attribute to be checked for equal
     * @param _value     value as criteria
     */
    public AbstractQAttrCompare(final QAttribute _attribute,
                                final AbstractQValue _value)
    {
        this.attribute = _attribute;
        this.value = _value;
    }

    /**
     * Getter method for the instance variable {@link #attribute}.
     *
     * @return value of instance variable {@link #attribute}
     */
    public QAttribute getAttribute()
    {
        return this.attribute;
    }

    /**
     * Getter method for the instance variable {@link #value}.
     *
     * @return value of instance variable {@link #value}
     */
    public AbstractQValue getValue()
    {
        return this.value;
    }

    /**
     * Getter method for the instance variable {@link #ignoreCase}.
     *
     * @return value of instance variable {@link #ignoreCase}
     */
    public boolean isIgnoreCase()
    {
        return this.ignoreCase;
    }

    /**
     * Setter method for instance variable {@link #ignoreCase}.
     *
     * @param _ignoreCase value for instance variable {@link #ignoreCase}
     * @return this
     */
    public AbstractQAttrCompare setIgnoreCase(final boolean _ignoreCase)
    {
        this.ignoreCase = _ignoreCase;
        return this;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public AbstractQPart prepare(final AbstractObjectQuery _query,
                                 final AbstractQPart _part)
        throws EFapsException
    {
        this.attribute.prepare(_query, this);
        this.value.prepare(_query, this);
        return this;
    }
}