/*
 * Copyright (c) 2010-2015 Evolveum
 *
 * 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 com.evolveum.midpoint.repo.sql.query2.restriction;

import com.evolveum.midpoint.prism.ItemDefinition;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.prism.query.ObjectFilter;
import com.evolveum.midpoint.repo.sql.query2.resolution.HqlDataInstance;
import com.evolveum.midpoint.repo.sql.query2.InterpretationContext;
import com.evolveum.midpoint.repo.sql.query2.definition.JpaEntityDefinition;
import org.apache.commons.lang.Validate;

/**
 * Base for all item path-related restrictions, e.g. those that are based on item path that points to a JPA data node.
 *
 * @author mederly
 */
public abstract class ItemRestriction<T extends ObjectFilter> extends Restriction<T> {

    /**
     * Item path (relative to parent restriction), copied from the appropriate filter.
     * Not null, although possibly empty. (TODO really can be empty?)
     */
    final protected ItemPath itemPath;

    /**
     * Item definition - necessary only for Any items.
     */
    final protected ItemDefinition itemDefinition;

    /**
     * Information about resolved itemPath. Needed when accessing the data.
     * Contains also information on previous steps, useful to enable looking upwards via ".." operator.
     * Filled-in within interpret() method.
     */
    protected HqlDataInstance hqlDataInstance;

    public ItemRestriction(InterpretationContext context, T filter, ItemPath itemPath, ItemDefinition itemDefinition, JpaEntityDefinition baseEntityDefinition, Restriction parent) {
        super(context, filter, baseEntityDefinition, parent);
        if (itemPath != null) {
            this.itemPath = itemPath;
        } else {
            this.itemPath = ItemPath.EMPTY_PATH;
        }
        this.itemDefinition = itemDefinition;
    }

    public ItemPath getItemPath() {
        return itemPath;
    }

    public HqlDataInstance getHqlDataInstance() {
        return hqlDataInstance;
    }

    public void setHqlDataInstance(HqlDataInstance hqlDataInstance) {
        Validate.notNull(hqlDataInstance);
        this.hqlDataInstance = hqlDataInstance;
    }
}