SizeRepresentationUtil.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2021 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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.sleuthkit.autopsy.report.modules.datasourcesummaryexport;

import java.text.DecimalFormat;
import org.openide.util.NbBundle;

final class SizeRepresentationUtil {

    private static final int SIZE_CONVERSION_CONSTANT = 1000;
    private static final DecimalFormat APPROXIMATE_SIZE_FORMAT = new DecimalFormat("#.##");

    @NbBundle.Messages({
        "SizeRepresentationUtil_units_bytes=bytes",
        "SizeRepresentationUtil_units_kilobytes=KB",
        "SizeRepresentationUtil_units_megabytes=MB",
        "SizeRepresentationUtil_units_gigabytes=GB",
        "SizeRepresentationUtil_units_terabytes=TB",
        "SizeRepresentationUtil_units_petabytes=PB"
    })
    enum SizeUnit {
        BYTES(Bundle.SizeRepresentationUtil_units_bytes(), "#", 0),
        KB(Bundle.SizeRepresentationUtil_units_kilobytes(), "#,##0.00,", 1),
        MB(Bundle.SizeRepresentationUtil_units_megabytes(), "#,##0.00,,", 2),
        GB(Bundle.SizeRepresentationUtil_units_gigabytes(), "#,##0.00,,,", 3),
        TB(Bundle.SizeRepresentationUtil_units_terabytes(), "#,##0.00,,,,", 4),
        PB(Bundle.SizeRepresentationUtil_units_petabytes(), "#,##0.00,,,,,", 5);

        private final String suffix;
        private final String excelFormatString;
        private final long divisor;

        SizeUnit(String suffix, String excelFormatString, int power) {
            this.suffix = suffix;
            
            // based on https://www.mrexcel.com/board/threads/how-do-i-format-cells-to-show-gb-mb-kb.140135/
            this.excelFormatString = String.format("%s \"%s\"", excelFormatString, suffix);
            this.divisor = (long) Math.pow(SIZE_CONVERSION_CONSTANT, power);
        }

        String getSuffix() {
            return suffix;
        }

        String getExcelFormatString() {
            return excelFormatString;
        }

        long getDivisor() {
            return divisor;
        }
    }

    static String getSizeString(Long size) {
        return getSizeString(size, APPROXIMATE_SIZE_FORMAT, true);
    }

    static SizeUnit getSizeUnit(Long size) {
        if (size == null) {
            return SizeUnit.values()[0];
        }
        
        for (SizeUnit unit : SizeUnit.values()) {
            long result = size / unit.getDivisor();
            if (result < SIZE_CONVERSION_CONSTANT) {
                return unit;
            }
        }
        
        return SizeUnit.values()[SizeUnit.values().length - 1];
    }

    static String getSizeString(Long size, DecimalFormat format, boolean showFullSize) {
        if (size == null) {
            return "";
        }

        SizeUnit sizeUnit = getSizeUnit(size);
        if (sizeUnit == null) {
            sizeUnit = SizeUnit.BYTES;
        }
        
        String closestUnitSize = String.format("%s %s", 
                format.format(((double) size) / sizeUnit.getDivisor()), sizeUnit.getSuffix());
        
        String fullSize = String.format("%d %s", size, SizeUnit.BYTES.getSuffix());
        if (sizeUnit.equals(SizeUnit.BYTES)) {
            return fullSize;
        } else if (showFullSize) {
            return String.format("%s (%s)", closestUnitSize, fullSize);
        } else {
            return closestUnitSize;
        }
    }
    
    static DefaultCellModel<?> getBytesCell(Long bytes) {
        if (bytes == null) {
            return new DefaultCellModel<>("");
        } else {
            SizeUnit unit = SizeRepresentationUtil.getSizeUnit(bytes);
            if (unit == null) {
                unit = SizeUnit.BYTES;
            }

            return new DefaultCellModel<>(bytes, SizeRepresentationUtil::getSizeString, unit.getExcelFormatString());
        }
    }

    private SizeRepresentationUtil() {
    }
}