org.geomajas.sld.ShadedReliefInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geomajas-project-sld-api Show documentation
Geomajas SLD API
There is a newer version: 1.2.1
Show newest version
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2013 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the Apache
 * License, Version 2.0. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */
package org.geomajas.sld;

import java.io.Serializable;
import org.geomajas.annotation.Api;

/**
 * 
 "ShadedRelief" specifies the application of relief shading (or "hill shading") to a DEM raster to give it somewhat of
 * a three-dimensional effect and to make elevation changes more visible.
 * 
 * 
 * Schema fragment(s) for this class:...
 * 
 *  * <xs:element
 * xmlns:ns="http://www.opengis.net/sld"
 * xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ShadedRelief">
 *   <xs:complexType>
 *     <xs:sequence>
 *       <xs:element ref="ns:BrightnessOnly" minOccurs="0"/>
 *       <xs:element ref="ns:ReliefFactor" minOccurs="0"/>
 *     </xs:sequence>
 *   </xs:complexType>
 * </xs:element>
 * 
 * 
 * @author Jan De Moerloose
 * @since 1.0.0
 */

@Api(allMethods = true)
public class ShadedReliefInfo implements Serializable {

	private static final long serialVersionUID = 100;

	private BrightnessOnlyInfo brightnessOnly;

	private ReliefFactorInfo reliefFactor;

	/**
	 * Get the 'BrightnessOnly' element value.
	 * 
	 * @return value
	 */
	public BrightnessOnlyInfo getBrightnessOnly() {
		return brightnessOnly;
	}

	/**
	 * Set the 'BrightnessOnly' element value.
	 * 
	 * @param brightnessOnly
	 */
	public void setBrightnessOnly(BrightnessOnlyInfo brightnessOnly) {
		this.brightnessOnly = brightnessOnly;
	}

	/**
	 * Get the 'ReliefFactor' element value.
	 * 
	 * @return value
	 */
	public ReliefFactorInfo getReliefFactor() {
		return reliefFactor;
	}

	/**
	 * Set the 'ReliefFactor' element value.
	 * 
	 * @param reliefFactor
	 */
	public void setReliefFactor(ReliefFactorInfo reliefFactor) {
		this.reliefFactor = reliefFactor;
	}

	/** {@inheritDoc} */
	@java.lang.Override
	@java.lang.SuppressWarnings("all")
	public java.lang.String toString() {
		return "ShadedReliefInfo(brightnessOnly=" + this.getBrightnessOnly() + ", reliefFactor="
				+ this.getReliefFactor() + ")";
	}

	/** {@inheritDoc} */
	@java.lang.Override
	@java.lang.SuppressWarnings("all")
	public boolean equals(final java.lang.Object o) {
		if (o == this) {
			return true;
		}
		if (!(o instanceof ShadedReliefInfo)) {
			return false;
		}
		final ShadedReliefInfo other = (ShadedReliefInfo) o;
		if (!other.canEqual((java.lang.Object) this)) {
			return false;
		}
		if (this.getBrightnessOnly() == null ? other.getBrightnessOnly() != null : !this.getBrightnessOnly().equals(
				(java.lang.Object) other.getBrightnessOnly())) {
			return false;
		}
		if (this.getReliefFactor() == null ? other.getReliefFactor() != null : !this.getReliefFactor().equals(
				(java.lang.Object) other.getReliefFactor())) {
			return false;
		}
		return true;
	}

	/** {@inheritDoc} */
	@java.lang.SuppressWarnings("all")
	public boolean canEqual(final java.lang.Object other) {
		return other instanceof ShadedReliefInfo;
	}

	/** {@inheritDoc} */
	@java.lang.Override
	@java.lang.SuppressWarnings("all")
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = result * prime + (this.getBrightnessOnly() == null ? 0 : this.getBrightnessOnly().hashCode());
		result = result * prime + (this.getReliefFactor() == null ? 0 : this.getReliefFactor().hashCode());
		return result;
	}
}