com.rgi.geopackage.tiles.TileMatrix Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagd Show documentation
SWAGD: Software to Aggregate Geospatial Data
The newest version!
/* The MIT License (MIT)
 *
 * Copyright (c) 2015 Reinventing Geospatial, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.rgi.geopackage.tiles;


/**
 * @author Luke Lambert
 *
 */

public class TileMatrix
{
    /**
     * Constructor
     *
     * @param tableName
     *             Name of the tile set table that this tile matrix corresponds to
     * @param zoomLevel
     *             The zoom level of the associated tile set (0 <= zoomLevel <= max_level)
     * @param matrixWidth
     *             The number of columns (>= 1) for this tile at this zoom level
     * @param matrixHeight
     *             The number of rows (>= 1) for this tile at this zoom level
     * @param tileWidth
     *             The tile width in pixels (>= 1) at this zoom level
     * @param tileHeight
     *             The tile height in pixels (>= 1) at this zoom level
     * @param pixelXSize
     *             The width of the associated tile set's spatial reference system or default meters for an undefined geographic coordinate reference system (SRS id 0) (> 0) (SRS units per pixel)
     * @param pixelYSize
     *             The height of the associated tile set's spatial reference system or default meters for an undefined geographic coordinate reference system (SRS id 0) (> 0) (SRS units per pixel)
     */
    protected TileMatrix(final String tableName,
                         final int    zoomLevel,
                         final int    matrixWidth,
                         final int    matrixHeight,
                         final int    tileWidth,
                         final int    tileHeight,
                         final double pixelXSize,
                         final double pixelYSize)
    {
        if(tableName == null || tableName.isEmpty())
        {
            throw new IllegalArgumentException("Table name may not be null or empty");
        }

        if(zoomLevel < 0)
        {
            throw new IllegalArgumentException("Zoom level may not be less than 0");
        }

        if(matrixWidth <= 0)
        {
            throw new IllegalArgumentException("Matrix width must be greater than 0");
        }

        if(matrixHeight <= 0)
        {
            throw new IllegalArgumentException("Matrix height must be greater than 0");
        }

        if(tileWidth <= 0)
        {
            throw new IllegalArgumentException("Tile width must be greater than 0");
        }

        if(tileHeight <= 0)
        {
            throw new IllegalArgumentException("Matrix height must be greater than 0");
        }

        if(pixelXSize <= 0.0)
        {
            throw new IllegalArgumentException("Pixel X size must be greater than 0.0");
        }

        if(pixelYSize <= 0.0)
        {
            throw new IllegalArgumentException("Pixel Y size must be greater than 0.0");
        }

        this.tableName    = tableName;
        this.zoomLevel    = zoomLevel;
        this.matrixWidth  = matrixWidth;
        this.matrixHeight = matrixHeight;
        this.tileWidth    = tileWidth;
        this.tileHeight   = tileHeight;
        this.pixelXSize   = pixelXSize;
        this.pixelYSize   = pixelYSize;
    }

    /**
     * @return the table name of the associated tile set
     */
    public String getTableName()
    {
        return this.tableName;
    }

    /**
     * @return the zoom level of the associated tile set (0 <= zoomLevel <= max_level)
     */
    public int getZoomLevel()
    {
        return this.zoomLevel;
    }

    /**
     * @return the number of columns (>= 1) for this tile at this zoom level
     */
    public int getMatrixWidth()
    {
        return this.matrixWidth;
    }

    /**
     * @return the number of rows (>= 1) for this tile at this zoom level
     */
    public int getMatrixHeight()
    {
        return this.matrixHeight;
    }

    /**
     * @return the tile width in pixels (>= 1) at this zoom level
     */
    public int getTileWidth()
    {
        return this.tileWidth;
    }

    /**
     * @return the tile height in pixels (>= 1) at this zoom level
     */
    public int getTileHeight()
    {
        return this.tileHeight;
    }

    /**
     * @return the width of the associated tile set's spatial reference system or default meters for an undefined geographic coordinate reference system (SRS id 0) (SRS units per pixel)
     */
    public double getPixelXSize()
    {
        return this.pixelXSize;
    }

    /**
     * @return the height of the associated tile set's spatial reference system or default meters for an undefined geographic coordinate reference system (SRS id 0) (SRS units per pixel)
     */
    public double getPixelYSize()
    {
        return this.pixelYSize;
    }

    /**
     * @param inTableName
     *             The tableName of the other tile matrix
     * @param inZoomLevel
     *             The zoomLevel of the other tile matrix
     * @param inMatrixWidth
     *             The matrixWidth (number of tiles wide) of the other tile matrix
     * @param inMatrixHeight
     *             The matrixHeight (number of tiles high)of the other tile matrix
     * @param inTileWidth
     *             The tileWidth in pixels of the other tile matrix
     * @param inTileHeight
     *             The tileHeight in pixels of the other tile matrix
     * @param inPixelXSize
     *             The pixelXSize (units/pixel) of the other tile matrix
     * @param inPixelYSize
     *             The pixelYSize (units/pixel) of the other tile matrix
     * @return true if this tile matrix equals the parameter values; otherwise returns false
     */
    public boolean equals(final String inTableName,
                          final int    inZoomLevel,
                          final int    inMatrixWidth,
                          final int    inMatrixHeight,
                          final int    inTileWidth,
                          final int    inTileHeight,
                          final double inPixelXSize,
                          final double inPixelYSize)
    {
        return this.tableName.equals(inTableName)  &&
               this.zoomLevel    == inZoomLevel    &&
               this.matrixWidth  == inMatrixWidth  &&
               this.matrixHeight == inMatrixHeight &&
               this.tileWidth    == inTileWidth    &&
               this.tileHeight   == inTileHeight   &&
               this.pixelXSize   == inPixelXSize   &&
               this.pixelYSize   == inPixelYSize;
    }

    private final String tableName;
    private final int    zoomLevel;
    private final int    matrixWidth;
    private final int    matrixHeight;
    private final int    tileWidth;
    private final int    tileHeight;
    private final double pixelXSize;
    private final double pixelYSize;
}