ca.bc.gov.open.cpf.plugin.api.GeometryConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cpf-api-plugin Show documentation
Concurrent Processing Framework Business Application Plugin API
There is a newer version: 5.1.1-RELEASE
/*
 * Copyright © 2008-2016, Province of British Columbia
 *
 * 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 ca.bc.gov.open.cpf.plugin.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.vividsolutions.jts.geom.Geometry;

/**
 * 
 * The GeometryConfiguration annotation can be used on a {@link BusinessApplicationPlugin} class,
 * a {@link RequestParameter} setXXX method with a {@link Geometry} subclass parameter,
 * or a {@link ResultAttribute} getXXX method with a {@link Geometry} subclass parameter
 * to indicate the configuration of the required coordinate system,
 * precision model, number of coordinate axis and if the geometry should be
 * validated.
 *
 * If the input or result geometry is different from the GeometryConfiguration, then
 * the CPF will convert the geometry to a new geometry using the GeometryConfiguration.
 *
 * The following example shows a geometry result attribute in BC Albers (3005), with x,y,z (3D) coordinates
 * 1mm x,y precision model, 1m z precision model. The geometry will also be validated and the is the primary geometry.
 *
 * @ResultAttribute
@GeometryConfiguration(
  srid = 3005,
  axisCount = 3,
  scaleFactorXy = 1000,
  scaleFactorZ = 1,
  validate = true,
  primaryGeometry = true)
public Geometry getGeometry() {
  return geometry;
}
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {
  ElementType.METHOD, ElementType.TYPE
})
public @interface GeometryConfiguration {
  /**
   * The number or axis used in the geometry. For example a 2D geometry has x, y
   * coordinates, so the number of axis is 2. A 3D geometry has x, y, z so the
   * number of axis is 3. Currently only axisCount of 2 and 3 are supported.
   *
   * @return The axis count.
   */
  public int numAxis() default 2;

  /**
   * The flag indicating that this bean property is the primary geometry. This
   * is required as some spatial file formats only support a single real
   * geometry field. Non-primary geometries will be written as an E-WKTR string
   * field. Only one geometry set method and one geometry get method can be
   * marked as primary (the input primary geometry parameter can be different
   * from the result primary geometry attribute.
   *
   * @return The primary geometry flag.
   */
  public boolean primaryGeometry() default true;

  /**
   * The scale factor to apply the x, y coordinates. The scale factor is 1 /
   * minimum unit. For example if the minimum unit was 1mm (0.001) the scale
   * factor is 1000 (1 / 0.001). The default value 0 indicates a floating
   * precision model where the coordinates are not rounded.
   *
   * @return the X,Y scale factor.
   */
  public double scaleFactorXy() default 0;

  /**
   * The scale factor to apply the z coordinates. The scale factor is 1 /
   * minimum unit. For example if the minimum unit was 1mm (0.001) the scale
   * factor is 1000 (1 / 0.001). The default value 0 indicates a floating
   * precision model where the coordinates are not rounded.
   *
   * @return the Z scale factor.
   */
  public double scaleFactorZ() default 0;

  /**
   * The srid of the coordinate system the geometry should be converted to. If
   * this attribute is omitted or has the value 0 then the coordinate system of the source geometry
   * will not be changed. Otherwise it will be projected to the requested
   * coordinate system.
   *
   * @return The SRID.
   */
  public int srid() default 0;

  /**
   * Boolean flag indicating if the geometry should be validated using the OGC isValid
   * predicate.
   *
   * @return The flag indicating that geometries should be validated.
   */
  public boolean validate() default false;
}