DataSetIndexElement.java

/*
 * Copyright 2014 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.dashbuilder.dataset.engine.index;

import org.dashbuilder.dataset.engine.index.stats.MemSizeFormatter;
import org.dashbuilder.dataset.engine.index.visitor.DataSetIndexVisitor;
import org.dashbuilder.dataset.impl.MemSizeEstimator;

/**
 * A DataSet index element
 */
public abstract class DataSetIndexElement {

    /**
     * Time (in nanoseconds) required to "build" (load, create, filter, ...) the indexed element.
     */
    long buildTime = 0;

    /**
     * Number of times the data set has been reused from an existing build.
     */
    int reuseHits = 0;

    DataSetIndexElement(long buildTime) {
        this.buildTime = buildTime;
    }

    public long getBuildTime() {
        return buildTime;
    }

    public void setBuildTime(long buildTime) {
        this.buildTime = buildTime;
    }

    public int getReuseHits() {
        return reuseHits;
    }

    public void reuseHit() {
        this.reuseHits++;
    }

    public long getReuseTime() {
        return buildTime*reuseHits;
    }

    public void acceptVisitor(DataSetIndexVisitor visitor) {
        visitor.visit(this);
    }

    public long getEstimatedSize() {
        return MemSizeEstimator.sizeOfLong + MemSizeEstimator.sizeOfInteger;
    }

    public String toString() {
        StringBuilder out = new StringBuilder();
        String simpleName = this.getClass().getName();
        int dotIdx = simpleName.lastIndexOf('.');
        if (dotIdx != -1) simpleName = simpleName.substring(dotIdx + 1);
        out.append(simpleName).append(" ");
        out.append(MemSizeFormatter.formatSize(getEstimatedSize())).append(" ");
        out.append((double) getBuildTime() / 1000000).append(" secs (").append(getReuseHits()).append(")");
        return out.toString();
    }
}