com.xceptance.xlt.api.engine.Data Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
There is a newer version: 8.1.0
/*
 * Copyright (c) 2005-2022 Xceptance Software Technologies GmbH
 *
 * 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
 *
 *     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 com.xceptance.xlt.api.engine;

/**
 * 
 * The {@link Data} interface defines the minimum functionality any data record must implement to be recordable by the
 * XLT engine. Typically, the XLT engine already collects sufficient data (e.g. error and run time values). However, it
 * may be necessary to log other important values as well. For this, a new data record type needs to be created, either
 * by implementing this interface or - preferably - by extending from one of the already existing data record types.
 * 
 * 
 * Such a data record class must obey the following rules:
 * 

 * it must have a name
 * it must have a time stamp
 * it must be serializable to a comma-separated list of values
 * it must be able to reconstruct its state from a comma-separated list of values
 * in order to tell one type of data record from the other, the first entry in the value list must be a type code
 * (e.g. "MyRecordType" or simple "M")
 * 
 * 
 * Note that the type codes "A", "C", "E", "J", "R", and "T" are already used by the XLT engine.
 * 
 * 
 * The data record can be logged using the {@link DataManager}.
 * 
 * 
 * @author Jörg Werner (Xceptance Software Technologies GmbH)
 */
public interface Data
{
    /**
     * The delimiter character (a comma) used to separate single values in a data record.
     */
    public static final char DELIMITER = ',';

    /**
     * Recreates the state of this object from a list of values separated by the DELIMITER constant.
     * 
     * @param s
     *            the list of values
     */
    public void fromCSV(String s);

    /**
     * Returns the name of the agent that produced this data record. Only used during report generation or analysis.
     * 
     * @return the agent's name
     */
    public String getAgentName();

    /**
     * Returns the name of this data record.
     * 
     * @return the name
     */
    public String getName();

    /**
     * Returns the time when the event occurred that this data record was created for.
     * 
     * @return the time
     */
    public long getTime();

    /**
     * Returns the name of the transaction that produced this data record. Only used during report generation or
     * analysis.
     * 
     * @return the transaction's name
     */
    public String getTransactionName();

    /**
     * Returns the type code of this data record.
     * 
     * @return the type code
     */
    public String getTypeCode();

    /**
     * Sets the name of the agent that produced this data record. Only used during report generation or analysis.
     * 
     * @param agentName
     *            the agent's name
     */
    public void setAgentName(String agentName);

    /**
     * Sets the name of this data record.
     * 
     * @param name
     *            the name
     */
    public void setName(String name);

    /**
     * Sets the time when this record's event occurred to the current time.
     */
    public void setTime();

    /**
     * Sets the time when this record's event occurred.
     * 
     * @param time
     *            the timestamp
     */
    public void setTime(long time);

    /**
     * Sets the name of the transaction that produced this data record. Only used during report generation or analysis.
     * 
     * @param transactionName
     *            the transaction's name
     */
    public void setTransactionName(String transactionName);

    /**
     * Returns the state of this object as a list of values separated by the DELIMITER constant.
     * 
     * @return the list of values
     */
    public String toCSV();
}