com.hp.autonomy.aci.content.fieldtext.BIASVAL Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of content-parameter-api Show documentation

API for representing aspects of IDOL's Content server, including FieldText and document References

There is a newer version: 4.2.0

Show newest version

/*
 * Copyright 2009-2015 Hewlett-Packard Development Company, L.P.
 * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License.
 */

package com.hp.autonomy.aci.content.fieldtext;

import com.hp.autonomy.aci.content.internal.InternalUtils;

import java.util.Arrays;
import java.util.Collections;

/**
 * Fieldtext specifier for the BIASVAL operator
 */
public class BIASVAL extends Specifier {

    /**
     * Constructs a new single field BIASVAL fieldtext
     * @param field The field to bias
     * @param value The value that will receive bias
     * @param bias THe amount of bias to apply
     */
    public BIASVAL(final String field, final String value, final Number bias) {
        this(Collections.singletonList(field), value, bias);
    }

    /**
     * Constructs a new multiple field BIASVAL fieldtext
     * @param fields The field to bias
     * @param value The value that will receive bias
     * @param bias THe amount of bias to apply
     */
    public BIASVAL(final String[] fields, final String value, final Number bias) {
        this(Arrays.asList(fields), value, bias);
    }

    /**
     * Constructs a new multiple field BIASVAL fieldtext
     * @param fields The field to bias
     * @param value The value that will receive bias
     * @param bias THe amount of bias to apply
     */
    public BIASVAL(final Iterable fields, final String value, final Number bias) {
        super("BIASVAL", fields, value, InternalUtils.numberToString(bias));
    }

    public final String getMatchValue() {
        return getValues().get(0);
    }

    public final double getBias() {
        return Double.parseDouble(getValues().get(1));
    }

    public static BIASVAL BIASVAL(final String field, final String value, final Number bias) {
        return new BIASVAL(field, value, bias);
    }

    public static BIASVAL BIASVAL(final String[] fields, final String value, final Number bias) {
        return new BIASVAL(fields, value, bias);
    }

    public static BIASVAL BIASVAL(final Iterable fields, final String value, final Number bias) {
        return new BIASVAL(fields, value, bias);
    }
}