org.n52.svalbard.encode.TsmlTVPEncoderv10 Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2015-2022 52°North Spatial Information Research GmbH
*
* 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 org.n52.svalbard.encode;
import java.io.OutputStream;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Supplier;
import javax.xml.stream.XMLStreamException;
import org.apache.xmlbeans.GDurationBuilder;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;
import org.n52.shetland.ogc.SupportedType;
import org.n52.shetland.ogc.gml.ReferenceType;
import org.n52.shetland.ogc.om.AbstractObservationValue;
import org.n52.shetland.ogc.om.MultiObservationValues;
import org.n52.shetland.ogc.om.ObservationType;
import org.n52.shetland.ogc.om.ObservationValue;
import org.n52.shetland.ogc.om.OmConstants;
import org.n52.shetland.ogc.om.OmObservableProperty;
import org.n52.shetland.ogc.om.OmObservation;
import org.n52.shetland.ogc.om.SingleObservationValue;
import org.n52.shetland.ogc.om.TimeValuePair;
import org.n52.shetland.ogc.om.series.MeasurementTimeseriesMetadata;
import org.n52.shetland.ogc.om.series.TimeseriesMetadata;
import org.n52.shetland.ogc.om.series.tsml.ConformanceClassesTSML;
import org.n52.shetland.ogc.om.series.tsml.TimeseriesMLConstants;
import org.n52.shetland.ogc.om.series.tsml.TimeseriesMLConstants.InterpolationType;
import org.n52.shetland.ogc.om.values.CountValue;
import org.n52.shetland.ogc.om.values.ProfileValue;
import org.n52.shetland.ogc.om.values.QuantityValue;
import org.n52.shetland.ogc.om.values.SweDataArrayValue;
import org.n52.shetland.ogc.om.values.TVPValue;
import org.n52.shetland.ogc.ows.exception.CodedException;
import org.n52.shetland.ogc.ows.exception.NoApplicableCodeException;
import org.n52.shetland.ogc.ows.exception.OwsExceptionReport;
import org.n52.shetland.ogc.sos.Sos2Constants;
import org.n52.shetland.ogc.sos.SosConstants;
import org.n52.shetland.ogc.sos.response.GetObservationResponse;
import org.n52.shetland.ogc.swe.simpleType.SweQuality;
import org.n52.shetland.ogc.swe.simpleType.SweQualityHolder;
import org.n52.shetland.ogc.swe.simpleType.SweQuantity;
import org.n52.shetland.util.CollectionHelper;
import org.n52.shetland.w3c.SchemaLocation;
import org.n52.svalbard.encode.exception.EncodingException;
import org.n52.svalbard.encode.exception.UnsupportedEncoderInputException;
import org.n52.svalbard.util.CodingHelper;
import org.n52.svalbard.write.TsmlTVPEncoderv10XmlStreamWriter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import net.opengis.gml.x32.AbstractGMLType;
import net.opengis.om.x20.OMObservationType;
import net.opengis.tsml.x10.MeasurementTVPPropertyType;
import net.opengis.tsml.x10.MeasurementTVPType;
import net.opengis.tsml.x10.PointMetadataDocument;
import net.opengis.tsml.x10.PointMetadataType;
import net.opengis.tsml.x10.TimeseriesMetadataType;
import net.opengis.tsml.x10.TimeseriesTVPDocument;
import net.opengis.tsml.x10.TimeseriesTVPType;
/**
* Encoder class for TimeseriesML 1.0 TimeseriesValuePair (TVP)
*
*/
public class TsmlTVPEncoderv10 extends AbstractTsmlEncoderv10 implements WmlTmlHelper {
private static final Logger LOGGER = LoggerFactory.getLogger(TsmlTVPEncoderv10.class);
// TODO: change to correct conformance class
private static final Set CONFORMANCE_CLASSES = Sets.newHashSet(
ConformanceClassesTSML.UML_MEASUREMENT_TIMESERIES_TVP_OBSERVATION,
ConformanceClassesTSML.UML_TIMESERIES_TVP_OBSERVATION,
ConformanceClassesTSML.UML_MEASUREMENT_TIMESERIES_TVP_OBSERVATION, ConformanceClassesTSML.XSD_XML_RULES,
ConformanceClassesTSML.XSD_TIMESERIES_OBSERVATION, ConformanceClassesTSML.XSD_TIMESERIES_TVP_OBSERVATION,
ConformanceClassesTSML.XSD_MEASUREMENT_TIMESERIES_TVP);
private static final ImmutableSet SUPPORTED_TYPES = ImmutableSet.<
SupportedType> builder().add(new ObservationType(TimeseriesMLConstants.OBSERVATION_TYPE_MEASURMENT_TVP))
.build();
private static final Set ENCODER_KEYS = CollectionHelper.union(getDefaultEncoderKeys(),
CodingHelper.encoderKeysForElements(TimeseriesMLConstants.NS_TSML_10, GetObservationResponse.class,
OmObservation.class, SingleObservationValue.class, MultiObservationValues.class));
private static final Map>> SUPPORTED_RESPONSE_FORMATS =
Collections.singletonMap(SosConstants.SOS, Collections.singletonMap(Sos2Constants.SERVICEVERSION,
Collections.singleton(TimeseriesMLConstants.NS_TSML_10)));
private static final String TIMESERIES_ID_PREFIX = "timeseries.";
public TsmlTVPEncoderv10() {
LOGGER.debug("Encoder for the following keys initialized successfully: {}!",
Joiner.on(", ").join(ENCODER_KEYS));
}
@Override
public Set getKeys() {
return Collections.unmodifiableSet(ENCODER_KEYS);
}
@Override
public Set getSupportedTypes() {
return Collections.unmodifiableSet(SUPPORTED_TYPES);
}
@Override
public Map> getSupportedResponseFormatObservationTypes() {
return Collections.singletonMap(TimeseriesMLConstants.NS_TSML_10, getSupportedTypes());
}
@Override
public Set getConformanceClasses(String service, String version) {
if (SosConstants.SOS.equals(service) && Sos2Constants.SERVICEVERSION.equals(version)) {
return Collections.unmodifiableSet(CONFORMANCE_CLASSES);
}
return Collections.emptySet();
}
@Override
public Set getSupportedResponseFormats(String service, String version) {
return SUPPORTED_RESPONSE_FORMATS.getOrDefault(service, Collections.emptyMap()).getOrDefault(version,
Collections.emptySet());
}
@Override
public Set getSchemaLocations() {
return Sets.newHashSet(TimeseriesMLConstants.TSML_10_SCHEMA_LOCATION,
TimeseriesMLConstants.TSML_10_TS_SCHEMA_LOCATION);
}
@Override
public boolean supportsResultStreamingForMergedValues() {
return true;
}
@Override
public XmlObject encode(Object element, EncodingContext additionalValues)
throws EncodingException, UnsupportedEncoderInputException {
if (element instanceof ObservationValue) {
return encodeResult((ObservationValue) element);
} else {
return super.encode(element, additionalValues);
}
}
@Override
public void encode(Object objectToEncode, OutputStream outputStream, EncodingContext ctx)
throws EncodingException {
if (objectToEncode instanceof OmObservation) {
try {
new TsmlTVPEncoderv10XmlStreamWriter(
ctx.with(EncoderFlags.ENCODER_REPOSITORY, getEncoderRepository())
.with(XmlEncoderFlags.XML_OPTIONS, (Supplier) this::getXmlOptions),
outputStream, (OmObservation) objectToEncode).write();
} catch (XMLStreamException xmlse) {
throw new EncodingException("Error while writing element to stream!", xmlse);
}
} else {
super.encode(objectToEncode, ctx);
}
}
@Override
protected XmlObject createResult(OmObservation sosObservation) throws EncodingException {
try {
return createMeasurementTimeseries(sosObservation);
} catch (OwsExceptionReport ce) {
throw new EncodingException(ce);
}
}
@Override
protected XmlObject encodeResult(ObservationValue observationValue) throws EncodingException {
try {
return createMeasurementTimeseries((AbstractObservationValue) observationValue);
} catch (OwsExceptionReport ce) {
throw new EncodingException(ce);
}
}
@Override
protected void addObservationType(OMObservationType xbObservation, String observationType) {
if (!Strings.isNullOrEmpty(observationType)) {
if (observationType.equals(OmConstants.OBS_TYPE_MEASUREMENT)
|| observationType.equals(TimeseriesMLConstants.OBSERVATION_TYPE_MEASURMENT_TVP)) {
xbObservation.addNewType().setHref(TimeseriesMLConstants.OBSERVATION_TYPE_MEASURMENT_TVP);
} else if (observationType.equals(OmConstants.OBS_TYPE_CATEGORY_OBSERVATION)
|| observationType.equals(TimeseriesMLConstants.OBSERVATION_TYPE_CATEGORICAL_TVP)) {
xbObservation.addNewType().setHref(TimeseriesMLConstants.OBSERVATION_TYPE_CATEGORICAL_TVP);
}
}
}
@Override
protected OMObservationType createOmObservationType() {
return OMObservationType.Factory.newInstance(getXmlOptions());
}
/**
* Create a XML MeasurementTimeseries object from SOS observation for om:result
*
* @param sosObservation
* SOS observation
*
* @return XML MeasurementTimeseries object
* @throws EncodingException
*
* @throws CodedException
* if the encoding fails
*/
private XmlObject createMeasurementTimeseries(OmObservation sosObservation)
throws OwsExceptionReport, EncodingException {
TimeseriesTVPDocument measurementTimeseriesDoc = TimeseriesTVPDocument.Factory.newInstance();
TimeseriesTVPType measurementTimeseries = measurementTimeseriesDoc.addNewTimeseriesTVP();
((AbstractGMLType) measurementTimeseries).setId(TIMESERIES_ID_PREFIX + sosObservation.getObservationID());
// Default value
TimeseriesMetadata timeseriesMetadata = new MeasurementTimeseriesMetadata().setCumulative(false);
if (sosObservation.isSetValue() && sosObservation.getValue().isSetValue()
&& sosObservation.getValue().getValue().getClass().isAssignableFrom(TVPValue.class)
&& sosObservation.getObservationConstellation().isSetMetadata()
&& sosObservation.getObservationConstellation().getMetadata().isSetTimeseriesMetadata()) {
timeseriesMetadata = sosObservation.getObservationConstellation().getMetadata().getTimeseriesmetadata();
}
addTimeseriesMetadata(measurementTimeseries, sosObservation.getPhenomenonTime().getGmlId(),
timeseriesMetadata);
TimeseriesTVPType.DefaultPointMetadata xbMetaComponent = measurementTimeseries.addNewDefaultPointMetadata();
PointMetadataDocument xbDefMeasureMetaComponent = PointMetadataDocument.Factory.newInstance();
PointMetadataType defaultTVPMeasurementMetadata = xbDefMeasureMetaComponent.addNewPointMetadata();
// Default value
InterpolationType interpolationType = InterpolationType.Continuous;
if (sosObservation.isSetValue() && sosObservation.getValue().isSetValue()
&& sosObservation.getValue().getValue().getClass().isAssignableFrom(TVPValue.class)
&& sosObservation.getObservationConstellation().isSetDefaultPointMetadata()
&& sosObservation.getObservationConstellation().getDefaultPointMetadata()
.isSetDefaultTVPMeasurementMetadata()
&& sosObservation.getObservationConstellation().getDefaultPointMetadata()
.getDefaultTVPMeasurementMetadata().isSetInterpolationType()) {
interpolationType = (InterpolationType) sosObservation.getObservationConstellation()
.getDefaultPointMetadata().getDefaultTVPMeasurementMetadata().getInterpolationtype();
}
defaultTVPMeasurementMetadata.addNewInterpolationType().setHref(interpolationType.getIdentifier());
xbDefMeasureMetaComponent.getPointMetadata().getInterpolationType().setTitle(interpolationType.getTitle());
// set aggregationDuration
if (sosObservation.getObservationConstellation().getDefaultPointMetadata().getDefaultTVPMeasurementMetadata()
.isSetAggregationDuration()) {
GDurationBuilder gDurationBuilder = new GDurationBuilder(sosObservation.getObservationConstellation()
.getDefaultPointMetadata().getDefaultTVPMeasurementMetadata().getAggregationDuration());
xbDefMeasureMetaComponent.getPointMetadata().setAggregationDuration(gDurationBuilder.toGDuration());
}
String unit = addValues(measurementTimeseries, sosObservation.getValue());
// set uom
if (unit != null && !unit.isEmpty()) {
defaultTVPMeasurementMetadata.addNewUom().setCode(unit);
} else {
OmObservableProperty observableProperty =
(OmObservableProperty) sosObservation.getObservationConstellation().getObservableProperty();
if (observableProperty.isSetUnit()) {
defaultTVPMeasurementMetadata.addNewUom().setCode(observableProperty.getUnit());
}
}
xbMetaComponent.set(xbDefMeasureMetaComponent);
return measurementTimeseriesDoc;
}
private XmlObject createMeasurementTimeseries(AbstractObservationValue observationValue)
throws CodedException, EncodingException {
TimeseriesTVPDocument measurementTimeseriesDoc = TimeseriesTVPDocument.Factory.newInstance();
TimeseriesTVPType measurementTimeseries = measurementTimeseriesDoc.addNewTimeseriesTVP();
((AbstractGMLType) measurementTimeseries).setId(TIMESERIES_ID_PREFIX + observationValue.getObservationID());
// Default value
TimeseriesMetadata timeseriesMetadata = new MeasurementTimeseriesMetadata().setCumulative(false);
if (observationValue.isSetValue() && observationValue.isSetMetadata()
&& observationValue.getMetadata().isSetTimeseriesMetadata()) {
timeseriesMetadata = observationValue.getMetadata().getTimeseriesmetadata();
}
addTimeseriesMetadata(measurementTimeseries, observationValue.getPhenomenonTime().getGmlId(),
timeseriesMetadata);
TimeseriesTVPType.DefaultPointMetadata xbMetaComponent = measurementTimeseries.addNewDefaultPointMetadata();
PointMetadataDocument xbDefMeasureMetaComponent = PointMetadataDocument.Factory.newInstance();
PointMetadataType defaultTVPMeasurementMetadata = xbDefMeasureMetaComponent.addNewPointMetadata();
// Default value
InterpolationType interpolationType = InterpolationType.Continuous;
if (observationValue.isSetValue() && observationValue.isSetDefaultPointMetadata()
&& observationValue.getDefaultPointMetadata().isSetDefaultTVPMeasurementMetadata() && observationValue
.getDefaultPointMetadata().getDefaultTVPMeasurementMetadata().isSetInterpolationType()) {
interpolationType = (InterpolationType) observationValue.getDefaultPointMetadata()
.getDefaultTVPMeasurementMetadata().getInterpolationtype();
}
defaultTVPMeasurementMetadata.addNewInterpolationType().setHref(interpolationType.getIdentifier());
xbDefMeasureMetaComponent.getPointMetadata().getInterpolationType().setTitle(interpolationType.getTitle());
String unit = addValues(measurementTimeseries, observationValue);
// set uom
if (unit != null && !unit.isEmpty()) {
defaultTVPMeasurementMetadata.addNewUom().setCode(unit);
// } else {
// OmObservableProperty observableProperty =
// (OmObservableProperty)
// sosObservation.getObservationConstellation().getObservableProperty();
// if (observableProperty.isSetUnit()) {
// defaultTVPMeasurementMetadata.addNewUom().setCode(observableProperty.getUnit());
// }
}
xbMetaComponent.set(xbDefMeasureMetaComponent);
return measurementTimeseriesDoc;
}
private String addValues(TimeseriesTVPType measurementTimeseries, ObservationValue observationValue)
throws CodedException, EncodingException {
String unit = null;
if (observationValue instanceof SingleObservationValue) {
SingleObservationValue singleObservationValue = (SingleObservationValue) observationValue;
String time = getTimeString(singleObservationValue.getPhenomenonTime());
unit = singleObservationValue.getValue().getUnit();
if (singleObservationValue.getValue() instanceof QuantityValue) {
QuantityValue quantityValue = (QuantityValue) singleObservationValue.getValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, quantityValue));
} else if (singleObservationValue.getValue() instanceof CountValue) {
CountValue countValue = (CountValue) singleObservationValue.getValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, countValue));
} else if (singleObservationValue.getValue() instanceof ProfileValue) {
ProfileValue profileValue = (ProfileValue) singleObservationValue.getValue();
if (profileValue.isSetValue()) {
if (profileValue.getValue().iterator().next().getSimpleValue() instanceof QuantityValue) {
QuantityValue quantityValue =
(QuantityValue) profileValue.getValue().iterator().next().getSimpleValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, quantityValue));
}
}
} else if (checkSweDataArray(observationValue.getValue())) {
SweDataArrayValue sweDataArrayValue = (SweDataArrayValue) observationValue.getValue();
for (List list : sweDataArrayValue.getValue().getValues()) {
for (int i = 0; i < list.size(); i = i + 2) {
measurementTimeseries.addNewPoint()
.set(addValuesToMeasurementTVP(list.get(i), list.get(i + 1)));
}
}
}
} else if (observationValue instanceof MultiObservationValues) {
MultiObservationValues mov = (MultiObservationValues) observationValue;
TVPValue tvpValue = (TVPValue) mov.getValue();
List timeValuePairs = tvpValue.getValue();
unit = tvpValue.getUnit();
for (TimeValuePair timeValuePair : timeValuePairs) {
String time = getTimeString(timeValuePair.getTime());
if (timeValuePair.getValue() instanceof QuantityValue) {
QuantityValue quantityValue = (QuantityValue) timeValuePair.getValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, quantityValue));
} else if (timeValuePair.getValue() instanceof ProfileValue) {
ProfileValue profileValue = (ProfileValue) timeValuePair.getValue();
if (profileValue.isSetValue()) {
if (profileValue.getValue().iterator().next().getSimpleValue() instanceof QuantityValue) {
QuantityValue quantityValue =
(QuantityValue) profileValue.getValue().iterator().next().getSimpleValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, quantityValue));
}
}
} else if (timeValuePair.getValue() instanceof CountValue) {
CountValue countValue = (CountValue) timeValuePair.getValue();
measurementTimeseries.addNewPoint().set(addValuesToMeasurementTVP(time, countValue));
} else {
throw new NoApplicableCodeException().withMessage("The types of values '%s' is not yet supported",
mov.getValue().getClass().getSimpleName());
}
}
}
return unit;
}
private MeasurementTVPPropertyType addValuesToMeasurementTVP(String time, String value) {
MeasurementTVPType measurementTVP = MeasurementTVPType.Factory.newInstance();
addValuesToMeasurementTVP(measurementTVP, time, value);
MeasurementTVPPropertyType measurementTVPProperty = MeasurementTVPPropertyType.Factory.newInstance();
measurementTVPProperty.setMeasurementTVP(measurementTVP);
return measurementTVPProperty;
}
private MeasurementTVPPropertyType addValuesToMeasurementTVP(String time, QuantityValue value)
throws EncodingException {
MeasurementTVPType measurementTVP = MeasurementTVPType.Factory.newInstance();
addValuesToMeasurementTVP(measurementTVP, time, value);
MeasurementTVPPropertyType measurementTVPProperty = MeasurementTVPPropertyType.Factory.newInstance();
measurementTVPProperty.setMeasurementTVP(measurementTVP);
return measurementTVPProperty;
}
private MeasurementTVPPropertyType addValuesToMeasurementTVP(String time, CountValue value) {
MeasurementTVPType measurementTVP = MeasurementTVPType.Factory.newInstance();
addValuesToMeasurementTVP(measurementTVP, time, value);
MeasurementTVPPropertyType measurementTVPProperty = MeasurementTVPPropertyType.Factory.newInstance();
measurementTVPProperty.setMeasurementTVP(measurementTVP);
return measurementTVPProperty;
}
/**
* Add a time an value to MeasureTVPType
*
* @param measurementTVP
* MeasureTVPType XML object
* @param time
* Time a string
* @param value
* value as string
*/
private void addValuesToMeasurementTVP(MeasurementTVPType measurementTVP, String time, String value) {
measurementTVP.addNewTime().setStringValue(time);
if (value == null || value.isEmpty()) {
measurementTVP.addNewValue().setNil();
addMeasurmentMetadataMissing(measurementTVP.addNewMetadata().addNewPointMetadata());
} else {
measurementTVP.addNewValue().setStringValue(value);
}
}
private void addValuesToMeasurementTVP(MeasurementTVPType measurementTVP, String time, QuantityValue value)
throws EncodingException {
measurementTVP.addNewTime().setStringValue(time);
if (value.isSetValue()) {
measurementTVP.addNewValue().setStringValue(value.getValue().toPlainString());
if (value.isSetQuality() && checkQuality(value.getQuality())) {
addMeasurmentMetadata(measurementTVP.addNewMetadata().addNewPointMetadata(),
value.getQuality());
}
} else {
measurementTVP.addNewValue().setNil();
if (value.isSetQuality()) {
addMeasurmentMetadata(measurementTVP.addNewMetadata().addNewPointMetadata(), value.getQuality());
} else {
addMeasurmentMetadataMissing(measurementTVP.addNewMetadata().addNewPointMetadata());
}
}
}
private void addValuesToMeasurementTVP(MeasurementTVPType measurementTVPType, String time, CountValue value) {
addValuesToMeasurementTVP(measurementTVPType, time,
value.isSetValue() ? Integer.toString(value.getValue()) : null);
}
private boolean checkQuality(SweQualityHolder quality) {
if (quality.isSetQuality()) {
return quality.getQuality().stream().filter(q -> q instanceof SweQuantity).findFirst().isPresent();
}
return false;
}
private void addMeasurmentMetadataMissing(PointMetadataType metadata) {
metadata.addNewNilReason().setNilReason("missing");
}
private void addMeasurmentMetadata(PointMetadataType metadata, SweQualityHolder quality) throws EncodingException {
if (quality.isSetReferences()
&& quality.getReferences().containsKey(TimeseriesMLConstants.EN_CENSORED_REASON)) {
ReferenceType reference = quality.getReferences().get(TimeseriesMLConstants.EN_CENSORED_REASON);
XmlObject xmlReferenceType = encodeGML(reference);
metadata.addNewCensoredReason().set(xmlReferenceType);
}
if (quality.isSetQuality()) {
for (SweQuality qualifier : quality.getQuality()) {
if (qualifier instanceof SweQuantity) {
XmlObject xmlQuality = encodeSweCommon(qualifier);
metadata.addNewQualifier()
.addNewQuantity()
.set(xmlQuality);
}
}
}
}
private void addTimeseriesMetadata(TimeseriesTVPType mtt, String gmlId, TimeseriesMetadata timeseriesMetadata) {
TimeseriesMetadataType mtmt = (TimeseriesMetadataType) mtt.addNewMetadata().addNewTimeseriesMetadata()
.substitute(TimeseriesMLConstants.QN_MEASUREMENT_TIMESERIES_METADATA, TimeseriesMetadataType.type);
createMeasurementTimeseriesMetadataType(mtmt, gmlId);
if (timeseriesMetadata != null
&& timeseriesMetadata.getClass().isAssignableFrom(MeasurementTimeseriesMetadata.class)) {
mtmt.setCumulative(((MeasurementTimeseriesMetadata) timeseriesMetadata).isCumulative());
}
}
private TimeseriesMetadataType createMeasurementTimeseriesMetadataType(TimeseriesMetadataType mtmt, String gmlId) {
mtmt.addNewTemporalExtent().setHref("#" + gmlId);
return mtmt;
}
}