org.geotoolkit.metadata.iso.identification.DefaultRepresentativeFraction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of geotk-metadata Show documentation
Show all versions of geotk-metadata Show documentation
Implementations of metadata derived from ISO 19115. This module provides both an implementation
of the metadata interfaces defined in GeoAPI, and a framework for handling those metadata through
Java reflection.
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2007-2011, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2011, Geomatys
*
* 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;
* version 2.1 of the License.
*
* 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.
*
* This package contains documentation from OpenGIS specifications.
* OpenGIS consortium's work is fully acknowledged here.
*/
package org.geotoolkit.metadata.iso.identification;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import net.jcip.annotations.ThreadSafe;
import org.opengis.metadata.identification.RepresentativeFraction;
import org.geotoolkit.resources.Errors;
/**
* A scale where {@linkplain #getDenominator denominator} = {@code 1 / scale}.
* This implementation is set up as a {@linkplain Number number} because it is.
*
* @author Jody Garnett (Refractions)
* @author Cédric Briançon (Geomatys)
* @author Martin Desruisseaux (Geomatys)
* @version 3.19
*
* @since 2.4
* @module
*/
@ThreadSafe
@XmlType(name = "MD_RepresentativeFraction_Type")
@XmlRootElement(name = "MD_RepresentativeFraction")
public class DefaultRepresentativeFraction extends Number implements RepresentativeFraction {
/**
* Serial number for compatibility with different versions.
*/
private static final long serialVersionUID = 7228422109144637537L;
/**
* The number below the line in a vulgar fraction.
*/
private long denominator;
/**
* Default empty constructor.
*/
public DefaultRepresentativeFraction() {
}
/**
* Constructs a metadata entity initialized with the values from the specified metadata.
*
* @param source The metadata to copy, or {@code null} if none.
*
* @since 3.18
*/
public DefaultRepresentativeFraction(final RepresentativeFraction source) {
if (source != null) {
denominator = source.getDenominator();
}
}
/**
* Creates a new representative fraction from the specified denominator.
*
* @param denominator The denominator.
*/
public DefaultRepresentativeFraction(final long denominator) {
this.denominator = denominator;
}
/**
* Returns a Geotk metadata implementation with the same values than the given arbitrary
* implementation. If the given object is {@code null}, then this method returns {@code null}.
* Otherwise if the given object is already a Geotk implementation, then the given object is
* returned unchanged. Otherwise a new Geotk implementation is created and initialized to the
* attribute values of the given object.
*
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return A Geotk implementation containing the values of the given object (may be the
* given object itself), or {@code null} if the argument was null.
*
* @since 3.18
*/
public static DefaultRepresentativeFraction castOrCopy(final RepresentativeFraction object) {
return (object == null) || (object instanceof DefaultRepresentativeFraction)
? (DefaultRepresentativeFraction) object : new DefaultRepresentativeFraction(object);
}
/**
* @deprecated Renamed {@link #castOrCopy castOrCopy}.
* @param object The object to get as a Geotk implementation, or {@code null} if none.
* @return The given object as a Geotk implementation.
*/
@Deprecated
public static DefaultRepresentativeFraction wrap(final RepresentativeFraction object) {
return castOrCopy(object);
}
/**
* Creates a representative fraction from a scale as a {@code double} value.
* The {@linkplain #getDenominator denominator} will be set to {@code 1/scale}.
*
* @param scale The scale as a number between 0 and 1.
* @return The representative fraction created from the given scale.
* @throws IllegalArgumentException if the condition {@code abs(scale) <= 1} is not meet.
*/
public static RepresentativeFraction fromScale(final double scale)
throws IllegalArgumentException
{
if (Math.abs(scale) <= 1 || scale == Double.POSITIVE_INFINITY) {
// Note: we accept positive infinity, but not negative infinity because
// we can't represent a negative zero using 'long' primitive type.
return new DefaultRepresentativeFraction(Math.round(1.0 / scale)); // flip!
} else {
throw new IllegalArgumentException(Errors.format(Errors.Keys.ILLEGAL_ARGUMENT_$2, "scale", scale));
}
}
/**
* Returns the scale in a form usable for computation.
*
* @return 1.0 / {@linkplain #getDenominator() denominator}
*/
@Override
public synchronized double doubleValue() {
return 1.0 / (double) denominator;
}
/**
* Returns the scale as a {@code float} type.
*/
@Override
public synchronized float floatValue() {
return 1.0f / (float) denominator;
}
/**
* Returns the scale as an integer. This method returns 0, 1 or throws an exception
* as specified in {@link #intValue}.
*
* @throws ArithmeticException if the {@linkplain #getDenominator denominator} is 0.
*/
@Override
public long longValue() throws ArithmeticException {
return intValue();
}
/**
* Returns the scale as an integer. If the denominator is 0, then this method throws an
* {@link ArithmeticException} since infinities can not be represented by an integer.
* Otherwise if the denominator is 1, then this method returns 1. Otherwise returns 0
* 0 since the scale is a fraction between 0 and 1, and such value can not be represented
* as an integer.
*
* @throws ArithmeticException if the {@linkplain #getDenominator denominator} is 0.
*/
@Override
public synchronized int intValue() throws ArithmeticException {
if (denominator == 1) {
return 1;
} else if (denominator != 0) {
return 0;
} else {
throw new ArithmeticException();
}
}
/**
* Returns the number below the line in a vulgar fraction.
*/
@Override
@XmlElement(name = "denominator", required = true)
public synchronized long getDenominator() {
return denominator;
}
/**
* Sets the denominator value.
*
* @param denominator The new denominator value.
*/
public synchronized void setDenominator(final long denominator) {
this.denominator = denominator;
}
/**
* Compares this object with the specified value for equality.
*
* @param object The object to compare with.
* @return {@code true} if both objects are equal.
*/
@Override
public synchronized boolean equals(final Object object) {
/*
* Note: 'equals(Object)' and 'hashCode()' implementations are defined in the interface,
* in order to ensure that the following requirements hold:
*
* - a.equals(b) == b.equals(a) (reflexivity)
* - a.equals(b) implies (a.hashCode() == b.hashCode())
*/
if (object instanceof RepresentativeFraction) {
final RepresentativeFraction that = (RepresentativeFraction) object;
return denominator == that.getDenominator();
}
return false;
}
/**
* Returns a hash value for this representative fraction.
*/
@Override
public synchronized int hashCode() {
return (int) denominator;
}
}