| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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 org.apache.sis.metadata.iso.acquisition; |
| |
| import java.util.Collection; |
| import jakarta.xml.bind.annotation.XmlType; |
| import jakarta.xml.bind.annotation.XmlElement; |
| import jakarta.xml.bind.annotation.XmlRootElement; |
| import org.opengis.metadata.Identifier; |
| import org.opengis.metadata.acquisition.Instrument; |
| import org.opengis.metadata.acquisition.Platform; |
| import org.opengis.metadata.citation.Citation; |
| import org.opengis.util.InternationalString; |
| import org.apache.sis.metadata.iso.ISOMetadata; |
| |
| // Specific to the main and geoapi-3.1 branches: |
| import org.opengis.metadata.citation.ResponsibleParty; |
| |
| |
| /** |
| * Designation of the platform used to acquire the dataset. |
| * The following properties are mandatory in a well-formed metadata according ISO 19115: |
| * |
| * <div class="preformat">{@code MI_Platform} |
| * {@code ├─identifier………………} Unique identification of the platform. |
| * {@code │ └─code……………………} Alphanumeric value identifying an instance in the namespace. |
| * {@code ├─description……………} Narrative description of the platform supporting the instrument. |
| * {@code └─instrument………………} Instrument(s) mounted on a platform. |
| * {@code ├─identifier……} Unique identification of the instrument. |
| * {@code └─type……………………} Name of the type of instrument.</div> |
| * |
| * <h2>Limitations</h2> |
| * <ul> |
| * <li>Instances of this class are not synchronized for multi-threading. |
| * Synchronization, if needed, is caller's responsibility.</li> |
| * <li>Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. |
| * Serialization support is appropriate for short term storage or RMI between applications running the |
| * same version of Apache SIS. For long term storage, use {@link org.apache.sis.xml.XML} instead.</li> |
| * </ul> |
| * |
| * @author Cédric Briançon (Geomatys) |
| * @author Martin Desruisseaux (Geomatys) |
| * @version 1.4 |
| * @since 0.3 |
| */ |
| @XmlType(name = "MI_Platform_Type", propOrder = { |
| "citation", |
| "identifier", |
| "description", |
| "sponsors", |
| "instruments" |
| }) |
| @XmlRootElement(name = "MI_Platform") |
| public class DefaultPlatform extends ISOMetadata implements Platform { |
| /** |
| * Serial number for inter-operability with different versions. |
| */ |
| private static final long serialVersionUID = -1607271701134014369L; |
| |
| /** |
| * Source where information about the platform is described. |
| */ |
| @SuppressWarnings("serial") |
| private Citation citation; |
| |
| /** |
| * Narrative description of the platform supporting the instrument. |
| */ |
| @SuppressWarnings("serial") |
| private InternationalString description; |
| |
| /** |
| * Organization responsible for building, launch, or operation of the platform. |
| */ |
| @SuppressWarnings("serial") |
| private Collection<ResponsibleParty> sponsors; |
| |
| /** |
| * Instrument(s) mounted on a platform. |
| */ |
| @SuppressWarnings("serial") |
| private Collection<Instrument> instruments; |
| |
| /** |
| * Constructs an initially empty platform. |
| */ |
| public DefaultPlatform() { |
| } |
| |
| /** |
| * Constructs a new instance initialized with the values from the specified metadata object. |
| * This is a <em>shallow</em> copy constructor, because the other metadata contained in the |
| * given object are not recursively copied. |
| * |
| * @param object the metadata to copy values from, or {@code null} if none. |
| * |
| * @see #castOrCopy(Platform) |
| */ |
| public DefaultPlatform(final Platform object) { |
| super(object); |
| if (object != null) { |
| citation = object.getCitation(); |
| identifiers = singleton(object.getIdentifier(), Identifier.class); |
| description = object.getDescription(); |
| sponsors = copyCollection(object.getSponsors(), ResponsibleParty.class); |
| instruments = copyCollection(object.getInstruments(), Instrument.class); |
| } |
| } |
| |
| /** |
| * Returns a SIS metadata implementation with the values of the given arbitrary implementation. |
| * This method performs the first applicable action in the following choices: |
| * |
| * <ul> |
| * <li>If the given object is {@code null}, then this method returns {@code null}.</li> |
| * <li>Otherwise if the given object is already an instance of |
| * {@code DefaultPlatform}, then it is returned unchanged.</li> |
| * <li>Otherwise a new {@code DefaultPlatform} instance is created using the |
| * {@linkplain #DefaultPlatform(Platform) copy constructor} and returned. |
| * Note that this is a <em>shallow</em> copy operation, because the other |
| * metadata contained in the given object are not recursively copied.</li> |
| * </ul> |
| * |
| * @param object the object to get as a SIS implementation, or {@code null} if none. |
| * @return a SIS implementation containing the values of the given object (may be the |
| * given object itself), or {@code null} if the argument was null. |
| */ |
| public static DefaultPlatform castOrCopy(final Platform object) { |
| if (object == null || object instanceof DefaultPlatform) { |
| return (DefaultPlatform) object; |
| } |
| return new DefaultPlatform(object); |
| } |
| |
| /** |
| * Returns the source where information about the platform is described. {@code null} if unspecified. |
| * |
| * @return source where information about the platform is described, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "citation") |
| public Citation getCitation() { |
| return citation; |
| } |
| |
| /** |
| * Sets the source where information about the platform is described. |
| * |
| * @param newValue the new citation value. |
| */ |
| public void setCitation(final Citation newValue) { |
| checkWritePermission(citation); |
| citation = newValue; |
| } |
| |
| /** |
| * Returns the unique identification of the platform. |
| * |
| * @return unique identification of the platform, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "identifier", required = true) |
| public Identifier getIdentifier() { |
| return super.getIdentifier(); |
| } |
| |
| /** |
| * Sets the unique identification of the platform. |
| * |
| * @param newValue the new identifier value. |
| */ |
| @Override |
| public void setIdentifier(final Identifier newValue) { |
| super.setIdentifier(newValue); |
| } |
| |
| /** |
| * Gets the narrative description of the platform supporting the instrument. |
| * |
| * @return narrative description of the platform, or {@code null}. |
| */ |
| @Override |
| @XmlElement(name = "description", required = true) |
| public InternationalString getDescription() { |
| return description; |
| } |
| |
| /** |
| * Sets the narrative description of the platform supporting the instrument. |
| * |
| * @param newValue the new description value. |
| */ |
| public void setDescription(final InternationalString newValue) { |
| checkWritePermission(description); |
| description = newValue; |
| } |
| |
| /** |
| * Returns the organization responsible for building, launch, or operation of the platform. |
| * |
| * <div class="warning"><b>Upcoming API change — generalization</b><br> |
| * As of ISO 19115:2014, {@code ResponsibleParty} is replaced by the {@code Responsibility} parent interface. |
| * This change will be tentatively applied in GeoAPI 4.0. |
| * </div> |
| * |
| * @return organization responsible for building, launch, or operation of the platform. |
| */ |
| @Override |
| @XmlElement(name = "sponsor") |
| public Collection<ResponsibleParty> getSponsors() { |
| return sponsors = nonNullCollection(sponsors, ResponsibleParty.class); |
| } |
| |
| /** |
| * Sets the organization responsible for building, launch, or operation of the platform. |
| * |
| * <div class="warning"><b>Upcoming API change — generalization</b><br> |
| * As of ISO 19115:2014, {@code ResponsibleParty} is replaced by the {@code Responsibility} parent interface. |
| * This change will be tentatively applied in GeoAPI 4.0. |
| * </div> |
| * |
| * @param newValues the new sponsors values; |
| */ |
| public void setSponsors(final Collection<? extends ResponsibleParty> newValues) { |
| sponsors = writeCollection(newValues, sponsors, ResponsibleParty.class); |
| } |
| |
| /** |
| * Gets the instrument(s) mounted on a platform. |
| * |
| * @return instrument(s) mounted on a platform. |
| */ |
| @Override |
| @XmlElement(name = "instrument", required = true) |
| public Collection<Instrument> getInstruments() { |
| return instruments = nonNullCollection(instruments, Instrument.class); |
| } |
| |
| /** |
| * Sets the instrument(s) mounted on a platform. |
| * |
| * @param newValues the new instruments values. |
| */ |
| public void setInstruments(final Collection<? extends Instrument> newValues) { |
| instruments = writeCollection(newValues, instruments, Instrument.class); |
| } |
| } |