com.hcl.domino.design.simplesearch.ByNumberFieldTerm Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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.hcl.domino.design.simplesearch;

import java.util.Optional;
import java.util.OptionalDouble;

import com.hcl.domino.misc.Pair;

/**
 * Represents a search for documents by number fields.
 * 
 * This is a specialization of {@link ByFieldTerm} that applies to number
 * fields. In such cases, {@link ByFieldTerm#getTextValue()} will be set
 * to a text version of the number, but should be ignored in preference to the
 * methods found in this type.
 * 
 * @author Jesse Gallagher
 * @since 1.0.38
 */
public interface ByNumberFieldTerm extends ByFieldTerm {
  enum NumberRule {
    EQUAL, NOT_EQUAL, GREATER_THAN, LESS_THAN, BETWEEN, NOT_BETWEEN
  }
  
  /**
   * Determines the type of number query this term represents.
   * 
   * @return a {@link NumberRule} instance
   */
  NumberRule getNumberRule();
  
  /**
   * Retrieves the number component of this term, if applicable.
   * 
   * This value applies when {@link #getNumberRule()} is one of:
   * 
   * 
   *   {@link NumberRule#EQUAL EQUAL}
   *   {@link NumberRule#NOT_EQUAL NOT_EQUAL}
   *   {@link NumberRule#GREATER_THAN GREATER_THAN}
   *   {@link NumberRule#LESS_THAN LESS_THAN}
   * 
   * 
   * @return an {@link OptionalDouble} describing the number component for the term,
   *         or an empty one if that is not applicable
   */
  OptionalDouble getNumber();
  
  /**
   * Retrieves the number range component of this term, if applicable.
   * 
   * This value applies when {@link #getNumberRule()} is one of:
   * 
   * 
   *   {@link NumberRule#BETWEEN BETWEEN}
   *   {@link NumberRule#NOT_BETWEEN NOT_BETWEEN}
   * 
   * 
   * @return an {@link Optional} describing the number range component for
   *         the term as a {@link Pair}, or an empty one if that is not
   *         applicable
   */
  Optional> getNumberRange();
}