bundles/org.eclipse.test.performance/src/org/eclipse/test/internal/performance/data/Sample.java

/*******************************************************************************
 * Copyright (c) 2000, 2019 IBM Corporation and others.
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors: IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.test.internal.performance.data;

import java.io.Serializable;
import java.util.Map;
import java.util.Set;

import org.eclipse.test.performance.Dimension;
import org.junit.Assert;

/**
 * @since 3.1
 */
public class Sample implements Serializable {

    private static final long serialVersionUID = 1L;

    String      fScenarioID;
    long        fStartTime;
    Map<String, String> fProperties;
    DataPoint[] fDataPoints;

    boolean     fIsSummary;
    boolean     fSummaryIsGlobal;
    String      fShortName;
    Dimension[] fSummaryDimensions;
    int         fCommentType;
    String      fComment;

    public Sample(String scenarioID, long starttime, Map<String, String> properties, DataPoint[] dataPoints) {
        Assert.assertTrue("scenarioID is null", scenarioID != null); //$NON-NLS-1$
        fScenarioID = scenarioID;
        fStartTime = starttime;
        fProperties = properties;
        fDataPoints = dataPoints;
    }

    public Sample(DataPoint[] dataPoints) {
        fDataPoints = dataPoints;
    }

    public void setComment(int commentType, String comment) {
        fCommentType = commentType;
        fComment = comment;
    }

    public void tagAsSummary(boolean global, String shortName, Dimension[] summaryDimensions, int commentType, String comment) {
        fIsSummary = true;
        fSummaryIsGlobal = global;
        fShortName = shortName;
        fSummaryDimensions = summaryDimensions;
        fCommentType = commentType;
        fComment = comment;
    }

    public String getScenarioID() {
        return fScenarioID;
    }

    public long getStartTime() {
        return fStartTime;
    }

    public String getProperty(String name) {
        return fProperties.get(name);
    }

    public String[] getPropertyKeys() {
        if (fProperties == null)
            return new String[0];
        Set<String> set = fProperties.keySet();
        return set.toArray(new String[set.size()]);
    }

    public DataPoint[] getDataPoints() {
        DataPoint[] dataPoints = new DataPoint[fDataPoints.length];
        System.arraycopy(fDataPoints, 0, dataPoints, 0, fDataPoints.length);
        return dataPoints;
    }

    @Override
    public String toString() {
        return "MeteringSession [scenarioID= " + fScenarioID + ", #datapoints: " + fDataPoints.length + "]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
    }

    public boolean isSummary() {
        return fIsSummary;
    }

    public boolean isGlobal() {
        return fSummaryIsGlobal;
    }

    public String getShortname() {
        return fShortName;
    }

    public Dimension[] getSummaryDimensions() {
        return fSummaryDimensions;
    }

    public int getCommentType() {
        return fCommentType;
    }

    public String getComment() {
        return fComment;
    }
}