/*
 * 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.addthis.hydra.data.filter.bundle;

import com.addthis.bundle.core.Bundle;
import com.addthis.bundle.util.AutoField;
import com.addthis.bundle.value.ValueFactory;
import com.addthis.bundle.value.ValueObject;
import com.addthis.codec.annotations.FieldConfig;
import com.addthis.hydra.data.filter.value.ValueFilter;
import com.addthis.hydra.data.filter.value.ValueFilterSet;

/**
 * <p>This {@link BundleFilter BundleFilter} <span class="hydra-summary">assigns a value to a specific bundle field</span>.
 * </p>
 * <p>For similar functionality see: value filter {@link ValueFilterSet set}</p>
 * <p>Example:</p>
 * <pre>
 *    {value {to:"USERNAME", value:"Bobby Tables"}}
 * </pre>
 *
 * @user-reference
 */
public class BundleFilterValue implements BundleFilter {

    /**
     * The value to assign into a bundle field. This field is required.
     */
    @FieldConfig(codable = true, required = true)
    private String value;

    /**
     * The bundle field name for the new value. This field is required.
     */
    @FieldConfig(codable = true, required = true)
    private AutoField to;

    /**
     * Optional filter to apply on the input value.
     */
    @FieldConfig(codable = true)
    private ValueFilter filter;

    /**
     * If true then return false when the input value is null. Default is true.
     */
    @FieldConfig(codable = true)
    private boolean nullFail = true;

    @Override
    public boolean filter(Bundle bundle) {
        ValueObject val = ValueFactory.create(value);
        if (filter != null) {
            val = filter.filter(val, bundle);
        }
        if (nullFail && val == null) {
            return false;
        }
        to.setValue(bundle, val);
        return true;
    }

    public BundleFilterValue setValue(String value) {
        this.value = value;
        return this;
    }

    public BundleFilterValue setToField(AutoField field) {
        this.to = field;
        return this;
    }

    public BundleFilterValue setFilter(ValueFilter filter) {
        this.filter = filter;
        return this;
    }

    public BundleFilterValue setNullFail(boolean nullFail) {
        this.nullFail = nullFail;
        return this;
    }

}