DatumStatusCounterMXBean.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.apache.streams.local.counters;

/**
 *
 */
public interface DatumStatusCounterMXBean {

  /**
   * Get number of failed datums
   * @return number of failed datums
   */
  public long getNumFailed();

  /**
   * Get number of passed datums
   * @return number of passed datums
   */
  public long getNumPassed();

  /**
   * Get the failure rate.  Calculated by num failed divided by (num passed + num failed)
   * @return the failure rate
   */
  public double getFailRate();

}