com.hcl.domino.data.FTIndexStats 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.data;

/**
 * This class contains statistics information that is returned when indexing a
 * database for full
 * text searching capabilities with {@link Database#ftIndex(java.util.Set)}
 *
 * @author Karsten Lehmann
 */
public interface FTIndexStats {
  /**
   * # of bytes indexed
   *
   * @return bytes
   */
  int getBytesIndexed();

  /**
   * # of new documents
   *
   * @return count
   */
  int getDocsAdded();

  /**
   * # of deleted documents
   *
   * @return count
   */
  int getDocsDeleted();

  /**
   * # of revised documents
   *
   * @return count
   */
  int getDocsUpdated();

  /**
   * Returns the database filepath
   *
   * @return filepath
   */
  String getFilePath();

  /**
   * Returns the database server
   *
   * @return server
   */
  String getServer();

}