org.openstack4j.model.telemetry.EventCriteria Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of openstack4j-core Show documentation
OpenStack Java API
There is a newer version: 3.12
package org.openstack4j.model.telemetry;

import java.util.Date;
import java.util.List;

import com.google.common.collect.Lists;
import org.openstack4j.openstack.internal.Parser;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * Query options used in retrieving Events
 *
 * @author Jeremy Unruh
 * @author Miroslav Lacina
 */
public class EventCriteria {

    private List params = Lists.newArrayList();

    public static EventCriteria create() {
        return new EventCriteria();
    }

    /**
     * Matches the given event type
     *
     * @param eventType the resource id
     * @return EventCriteria
     */
    public EventCriteria eventType(String eventType) {
        checkNotNull(eventType, "eventType must not be null");
        return add("event_type", Oper.EQUALS, eventType);
    }

    /**
     * Matches the given message identifier
     *
     * @param messageId the message id
     * @return EventCriteria
     */
    public EventCriteria messageId(String messageId) {
        checkNotNull(messageId, "messageId must not be null");
        return add("message_id", Oper.EQUALS, messageId);
    }

    /**
     * Adds the start timestamp event criteria
     *
     * @param operator the operator
     * @param value the date for this timestamp
     * @return EventCriteria
     */
    public EventCriteria startTimestamp(Oper operator, Date value) {
        checkNotNull(value, "Date must not be null");
        return add("start_timestamp", operator, Parser.toISO8601DateFormat(value));
    }

    /**
     * Adds the end timestamp event criteria
     *
     * @param operator the operator
     * @param value the date for this timestamp
     * @return EventCriteria
     */
    public EventCriteria endTimestamp(Oper operator, Date value) {
        checkNotNull(value, "Date must not be null");
        return add("end_timestamp", operator, Parser.toISO8601DateFormat(value));
    }

    /**
     * Adds an adhoc field criteria
     *
     * @param field the field name (will be treated as trait name and applied on trait)
     * @param operator the operator
     * @param value the value
     * @return EventCriteria
     */
    public EventCriteria add(String field, Oper operator, Number value) {
        checkNotNull(value, "Value must not be null");
        return add(field, operator, value.toString());
    }

    /**
     * Adds an adhoc field criteria
     *
     * @param field the field name (will be treated as trait name and applied on trait)
     * @param operator the operator
     * @param value the value
     * @return EventCriteria
     */
    public EventCriteria add(String field, Oper operator, String value) {
        checkNotNull(field, "Field must not be null");
        checkNotNull(operator, "Operator must not be null");
        checkNotNull(value, "Value must not be null");

        params.add(new NameOpValue(field, operator, value));
        return this;
    }

    /**
     * @return the criteria parameters for this query
     */
    public List getCriteriaParams() {
        return params;
    }

    public enum Oper {
        /**
         * Less Than : <
         */
        LT("lt"),
        /**
         * Greater Than : >
         */
        GT("gt"),
        /**
         * Less Than Equals : <=
         */
        LTE("le"),
        /**
         * Greater Than Equals : >=
         */
        GTE("ge"),
        /**
         * Equals : =
         */
        EQUALS("eq");
        private final String queryValue;

        Oper(String queryValue) {
            this.queryValue = queryValue;
        }

        public String getQueryValue() {
            return queryValue;
        }
    }

    public static class NameOpValue {
        private final String field;
        private final Oper operator;
        private String value;

        NameOpValue(String field, Oper operator, Comparable value) {
            this.field = field;
            this.operator = operator;
            if (value instanceof Date)
                this.value = Parser.toISO8601DateFormat(Date.class.cast(value));
            else
                this.value = String.valueOf(value);
        }

        public String getField() {
            return field;
        }

        public Oper getOperator() {
            return operator;
        }

        public String getValue() {
            return value;
        }
    }
}