org.swiftboot.sheet.meta.Area Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swiftboot-sheet Show documentation
There is a newer version: 2.4.7
package org.swiftboot.sheet.meta;

import java.util.Objects;

/**
 * Represent an area in a sheet
 *
 * @author swiftech
 */
public class Area {

    /**
     *
     */
    SheetId sheetId = null;// default is null

    /**
     * Start position of this area, this cannot be null.
     */
    Position startPosition;

    /**
     * End position of this area, inclusive.
     * this can be null which means an area only has a single cell.
     * row or column of this position can be null which means uncertain rows or columns of this area.
     */
    Position endPosition;

    /**
     * Dimension of area, if specified, the startPosition and endPosition won't work.
     * only for import now.
     */
    Dimension dimension;

    public static Area newHorizontal(Position startPosition, int length) {
        return new Area(startPosition, new Position(startPosition.getRow(), startPosition.getColumn() + length - 1));
    }

    public static Area newVertical(Position startPosition, int length) {
        return new Area(startPosition, new Position(startPosition.getRow() + length - 1, startPosition.getColumn()));
    }

    public static Area newArea(Position startPosition, int rows, int cols) {
        return new Area(startPosition, new Position(startPosition.getRow() + rows - 1, startPosition.getColumn() + cols - 1));
    }

    public Area(Position startPosition) {
        this.startPosition = startPosition;
    }

    public Area(SheetId sheetId, Position startPosition) {
        this.sheetId = sheetId;
        this.startPosition = startPosition;
    }

    public Area(Position startPosition, Position endPosition) {
        this.startPosition = startPosition;
        this.endPosition = endPosition;
    }

    public Area(SheetId sheetId, Position startPosition, Position endPosition) {
        this.sheetId = sheetId;
        this.startPosition = startPosition;
        this.endPosition = endPosition;
    }

    public Area(Integer row1, Integer column1, Integer row2, Integer column2) {
        this.startPosition = new Position(row1, column1);
        this.endPosition = new Position(row2, column2);
    }

    public Area(Dimension dimension) {
        this.dimension = dimension;
    }

    public Area(SheetId sheetId, Dimension dimension) {
        this.sheetId = sheetId;
        this.dimension = dimension;
    }

    /**
     * Row count from start position to end position
     *
     * @return
     */
    public Integer rowCount() {
        if (dimension != null) {
            return dimension.getHeight();
        }
        if (startPosition == null) {
            return 0;
        }
        if (isSingleCell()) {
            return 1;
        }
        if (endPosition.row == null) {
            return null; // must be uncertain size
        }
        return Math.abs(endPosition.row - startPosition.row) + 1;
    }

    /**
     * Column count from start position to end position.
     *
     * @return
     */
    public Integer columnCount() {
        if (dimension != null) {
            return dimension.getWidth();
        }
        if (startPosition == null) {
            return 0;
        }
        if (isSingleCell()) {
            return 1;
        }
        if (endPosition.column == null) {
            return null; // must be uncertain size
        }
        return Math.abs(endPosition.column - startPosition.column) + 1;
    }

    public int size() {
        if (startPosition == null) {
            return 0;
        }
        if (isSingleCell()) {
            return 1;
        }
        return rowCount() * columnCount();
    }

    public boolean isSingleCell() {
        return startPosition != null && (endPosition == null || startPosition.equals(endPosition));
    }

    public boolean isLine() {
        return (startPosition != null && startPosition.getRow().equals(endPosition.getRow()))
                || (startPosition != null && startPosition.getColumn().equals(endPosition.getColumn()));
    }

    /**
     * Calculate overlay, uncertain row or column index will be ignored.
     *
     * @param area
     */
    public Area overlay(Area area) {
        Position nearest = Position.narrow(this.startPosition, area.getStartPosition());
        // Enlarge with start position if no end position
        Position farthest = Position.enlarge(
                this.endPosition == null ? this.startPosition : this.endPosition,
                area.getEndPosition() == null ? area.getStartPosition() : area.getEndPosition());
        return new Area(nearest, farthest);
    }

    /**
     * Dynamic area is size unknown.
     *
     * @return
     */
    public boolean isDynamic() {
        return this.endPosition != null && (this.endPosition.getRow() == null || this.endPosition.getColumn() == null);
    }

    public SheetId getSheetId() {
        return sheetId;
    }

    public void setSheetId(SheetId sheetId) {
        this.sheetId = sheetId;
    }

    public Position getStartPosition() {
        return startPosition;
    }

    public void setStartPosition(Position startPosition) {
        this.startPosition = startPosition;
    }

    public Position getEndPosition() {
        return endPosition;
    }

    public void setEndPosition(Position endPosition) {
        this.endPosition = endPosition;
    }

    public Dimension getDimension() {
        return dimension;
    }

    public void setDimension(Dimension dimension) {
        this.dimension = dimension;
    }

    @Override
    public String toString() {
        return "Area{" +
                "sheetId=" + sheetId +
                ", start=" + startPosition +
                ", end=" + endPosition +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Area area = (Area) o;
        return Objects.equals(startPosition, area.startPosition) && Objects.equals(endPosition, area.endPosition);
    }

    @Override
    public int hashCode() {
        return Objects.hash(startPosition, endPosition);
    }
}