org.geotoolkit.metadata.iso.spatial.AbstractSpatialRepresentation Maven / Gradle / Ivy
Show all versions of geotk-metadata Show documentation
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2004-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.spatial;
import javax.xml.bind.annotation.XmlType;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlRootElement;
import net.jcip.annotations.ThreadSafe;
import org.opengis.metadata.spatial.SpatialRepresentation;
import org.opengis.metadata.spatial.GridSpatialRepresentation;
import org.opengis.metadata.spatial.VectorSpatialRepresentation;
import org.geotoolkit.metadata.iso.MetadataEntity;
/**
* Method used to represent geographic information in the dataset.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @author Touraïvane (IRD)
* @author Cédric Briançon (Geomatys)
* @version 3.19
*
* @since 2.1
* @module
*/
@ThreadSafe
@XmlType(name = "AbstractMD_SpatialRepresentation_Type")
@XmlRootElement(name = "MD_SpatialRepresentation")
@XmlSeeAlso({
DefaultGridSpatialRepresentation.class,
DefaultVectorSpatialRepresentation.class
})
public class AbstractSpatialRepresentation extends MetadataEntity implements SpatialRepresentation {
/**
* Serial number for inter-operability with different versions.
*/
private static final long serialVersionUID = 1443170876207840116L;
/**
* Constructs an initially empty spatial representation.
*/
public AbstractSpatialRepresentation() {
}
/**
* Constructs a metadata entity initialized with the values from the specified metadata.
*
* @param source The metadata to copy, or {@code null} if none.
*
* @since 2.4
*/
public AbstractSpatialRepresentation(final SpatialRepresentation source) {
super(source);
}
/**
* 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, using a shallow copy operation
* (i.e. attributes are not cloned).
*
* This method checks for the {@link GridSpatialRepresentation} and {@link VectorSpatialRepresentation}
* sub-interfaces. If one of those interfaces is found, then this method delegates to
* the corresponding {@code castOrCopy} static method. If the given object implements more
* than one of the above-cited interfaces, then the {@code castOrCopy} method to be used is
* unspecified.
*
* @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 AbstractSpatialRepresentation castOrCopy(final SpatialRepresentation object) {
if (object instanceof GridSpatialRepresentation) {
return DefaultGridSpatialRepresentation.castOrCopy((GridSpatialRepresentation) object);
}
if (object instanceof VectorSpatialRepresentation) {
return DefaultVectorSpatialRepresentation.castOrCopy((VectorSpatialRepresentation) object);
}
return (object == null) || (object instanceof AbstractSpatialRepresentation)
? (AbstractSpatialRepresentation) object : new AbstractSpatialRepresentation(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 AbstractSpatialRepresentation wrap(final SpatialRepresentation object) {
return castOrCopy(object);
}
}