• Home
• org.diirt
• datasource
• 3.1.7
• source code
• SourceRateExpression.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.diirt.datasource.expression.SourceRateExpression Maven / Gradle / Ivy

/**
 * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
 * All rights reserved. Use is subject to license terms. See LICENSE.TXT
 */
package org.diirt.datasource.expression;

import org.diirt.datasource.ReadFunction;

/**
 * An expression to read at the rate of the source.
 * 

 * Don't implement objects with this interface, use {@link SourceRateExpressionImpl}.
 *
 * @param  type of the read payload
 * @author carcassi
 */
public interface SourceRateExpression extends SourceRateExpressionList {

    /**
     * Changes the name for this expression
     *
     * @param name new name
     * @return this
     */
    public SourceRateExpression as(String name);

    /**
     * Name of the expression.
     *
     * @return the expression name
     */
    public String getName();

    /**
     * The function that calculates this expression.
     *
     * @return the expression function
     */
    public ReadFunction getFunction();

    /**
     * The implementation of this expression.
     *
     * @return the implementation
     */
    public SourceRateExpressionImpl getSourceRateExpressionImpl();

}