/*
 * The JTS Topology Suite is a collection of Java classes that
 * implement the fundamental operations required to validate a given
 * geo-spatial data set to a known topological specification.
 *
 * Copyright (C) 2001 Vivid Solutions
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * For more information, contact:
 *
 *     Vivid Solutions
 *     Suite #1A
 *     2328 Government Street
 *     Victoria BC  V8T 5G5
 *     Canada
 *
 *     (250)385-6040
 *     www.vividsolutions.com
 */
package com.revolsys.geometry.test.old.generator;

import com.revolsys.geometry.model.BoundingBox;
import com.revolsys.geometry.model.Geometry;
import com.revolsys.geometry.model.GeometryFactory;

/**
 * This class illustrates the basic functionality and configuration options for generating spatial data.
 *
 * @author David Zwiers, Vivid Solutions.
 */
public abstract class GeometryGenerator {
  /**
   * @see GridGenerator
   * @return A new GridGenerator
   */
  public static GridGenerator newGridGenerator() {
    return new GridGenerator();
  }

  /**
   * @see LineStringGenerator
   * @return A new LineStringGenerator
   */
  public static LineStringGenerator newLineStringGenerator() {
    final LineStringGenerator lsg = new LineStringGenerator();
    lsg.setGenerationAlgorithm(LineStringGenerator.ARC);
    lsg.setNumberPoints(10);
    return lsg;
  }

  /**
   * @see LineStringGenerator
   * @see MultiGenerator
   * @return A new PointGenerator
   */
  public static MultiGenerator newMultiLineStringGenerator() {
    final MultiGenerator mg = new MultiGenerator(newLineStringGenerator());
    mg.setNumberGeometries(4);
    return mg;
  }

  /**
   * @see PointGenerator
   * @see MultiGenerator
   * @return A new MultiGenerator
   */
  public static MultiGenerator newMultiPointGenerator() {
    final MultiGenerator mg = new MultiGenerator(newPointGenerator());
    mg.setNumberGeometries(4);
    return mg;
  }

  /**
   * @see PolygonGenerator
   * @see MultiGenerator
   * @return A new PointGenerator
   */
  public static MultiGenerator newMultiPolygonGenerator() {
    final MultiGenerator mg = new MultiGenerator(newPolygonGenerator());
    mg.setNumberGeometries(4);
    return mg;
  }

  /**
   * @see PointGenerator
   * @return A new PointGenerator
   */
  public static PointGenerator newPointGenerator() {
    return new PointGenerator();
  }

  /**
   * @see PolygonGenerator
   * @return A new PolygonGenerator
   */
  public static PolygonGenerator newPolygonGenerator() {
    final PolygonGenerator pg = new PolygonGenerator();
    pg.setGenerationAlgorithm(PolygonGenerator.ARC);
    pg.setNumberPoints(10);
    pg.setNumberHoles(8);
    return pg;
  }

  protected BoundingBox boundingBox;

  protected int dimensions = 2;

  protected GeometryFactory geometryFactory; // includes srid

  /**
   * @return Returns the boundingBox.
   */
  public BoundingBox getBoundingBox() {
    return this.boundingBox;
  }

  /**
   * @return Returns the dimensions.
   */
  public int getDimensions() {
    return this.dimensions;
  }

  /**
   * @return Returns the geometryFactory.
   */
  public GeometryFactory getGeometryFactory() {
    return this.geometryFactory;
  }

  /**
   * @return A Geometry which uses some or all of the Bounding Box specified.
   */
  public abstract Geometry newGeometry();

  /**
   * @param boundingBox The boundingBox to set.
   */
  public void setBoundingBox(final BoundingBox boundingBox) {
    this.boundingBox = boundingBox;
  }

  /**
   * @param dimensions The dimensions to set.
   */
  public void setDimensions(final int dimensions) {
    this.dimensions = dimensions;
    throw new RuntimeException("Dimensions other than 2 are not yet supported");
  }

  /**
   * @param geometryFactory The geometryFactory to set.
   */
  public void setGeometryFactory(final GeometryFactory geometryFactory) {
    this.geometryFactory = geometryFactory;
  }

}