opennms/src/api/Operator.ts

Client API for the OpenNMS network monitoring platform

import {OnmsEnum, forLabel} from '../internal/OnmsEnum';

/**
 * Represents a filter comparator.
 * @category Filtering
 */
export class Operator extends OnmsEnum<number> {
  /** Given a label ('and', 'or'), return the corresponding operator. */
  public static forLabel(label: string) {
    return forLabel(Operators, label);
  }

  /** Aliases for the command-line. */
  private readonly aliases = [] as string[];

  constructor(id: number, label: string, ...aliases: string[]) {
    super(id, label);
    this.aliases = aliases;
  }

  /** Whether this comparator matches the given comparator string. */
  public matches(comparator: string) {
    return (comparator.toLowerCase() === this.label.toLowerCase())
      || this.aliases.indexOf(comparator) >= 0;
  }
}

/* eslint-disable  */

/**
 * Contains constant instances of all operators.
 * @category Model
 */
export const Operators = {
  /** AND (all must match) */
  AND: new Operator(1, 'AND'),

  /** OR (at least one must match) */
  OR: new Operator(2, 'OR'),
};
Object.freeze(Operators);