com.hp.autonomy.aci.content.fieldtext.MATCHRECURSE 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 MATCHRECURSE operator
 */
public class MATCHRECURSE extends Specifier {

    /**
     * Constructs a new single field MATCHRECURSE fieldtext
     * @param field The field name
     * @param value The field value
     * @param depth The depth of recursion
     */
    public MATCHRECURSE(final String field, final String value, final Number depth) {
        this(Collections.singletonList(field), value, depth);
    }

    /**
     * Constructs a new single field MATCHRECURSE fieldtext
     * @param fields The field names
     * @param value The field value
     * @param depth The depth of recursion
     */
    public MATCHRECURSE(final String[] fields, final String value, final Number depth) {
        this(Arrays.asList(fields), value, depth);
    }

    /**
     * Constructs a new single field MATCHRECURSE fieldtext
     * @param fields The field names
     * @param value The field value
     * @param depth The depth of recursion
     */
    public MATCHRECURSE(final Iterable fields, final String value, final Number depth) {
        super("MATCHRECURSE", fields, value, InternalUtils.numberToString(depth.intValue()));

        if(depth.intValue() < 0) {
            throw new IllegalArgumentException("Depth must not be negative");
        }
    }

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

    public final int getDepth() {
        return Integer.parseInt(getValues().get(1));
    }

    public static MATCHRECURSE MATCHRECURSE(final String field, final String value, final Number depth) {
        return new MATCHRECURSE(field, value, depth);
    }

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

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